GET /api/conversations

get a list of conversations that this user has access to

Success Response Code: 200

Params

Param name Description
unread
optional

only return unread conversations


Value: Must be one of: <code>true</code>, <code>false</code>.
hidden
optional

only return hidden conversationsk


Value: Must be one of: <code>true</code>, <code>false</code>.

Response Fields

conversations conversations array of Conversation results. See #show for response format Array<Conversation>

Example Curl Commands

curl -X GET -v --basic -u "emily@socialcast.com:demo" https://demo.socialcast.com/api/conversations.json

Examples

GET /conversations.json
200
{
  "conversations": [
    {
      "id": 5,
      "name": null,
      "private": true,
      "members": [
        {
          "id": 140,
          "name": "J'øhn127 D'øe125",
          "email": "active'124@socialcast.com",
          "cell_phone": null,
          "office_phone": null,
          "first_name": "J'øhn127",
          "last_name": "D'øe125",
          "profile_photo": {
            "height": 140,
            "width": 140,
            "url": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square140-7da7e1d98b33ef152280b1f653cfd80e2db24b01b625a72abc320673eea5af53.png",
            "is_system_default": true
          },
          "inactive": false,
          "terminated": false
        },
        {
          "id": 141,
          "name": "J'øhn128 D'øe126",
          "email": "active'125@socialcast.com",
          "cell_phone": null,
          "office_phone": null,
          "first_name": "J'øhn128",
          "last_name": "D'øe126",
          "profile_photo": {
            "height": 140,
            "width": 140,
            "url": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square140-7da7e1d98b33ef152280b1f653cfd80e2db24b01b625a72abc320673eea5af53.png",
            "is_system_default": true
          },
          "inactive": false,
          "terminated": false
        }
      ],
      "avatar": {
        "url": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square140-7da7e1d98b33ef152280b1f653cfd80e2db24b01b625a72abc320673eea5af53.png",
        "width": 140,
        "height": 140,
        "is_system_default": true
      },
      "title": "J'øhn128 D'øe126",
      "unread": false,
      "unread_count": 0
    }
  ]
}