GET /api/conversations/:id

retrieve a single conversation

Success Response Code: 200

Params

Param name Description
id
required

the id of the referenced conversation.


Value: Must be a Integer

Response Fields

id unique id for the conversation Integer
name the user entered custom name for the conversation String
title the user entered custom name for the conversation (see #name) *or* the server generated default conversation name String
private flag if the conversation is private (one-to-one) or a shareable conversation Boolean
unread flag if the current user has read the latest remark in the conversation Boolean
unread_count number of unread messages the user has in the conversation Integer
latest_activity latest_activity the latest remark/image posting activity in the conversation. See {ActivitiesController#show} for response definition Activity
members list of conversation members. See users#show for response definition Array<User>

Example Curl Commands

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

Examples

GET /conversations/5.json
200
{
  "conversation": {
    "id": 5,
    "name": null,
    "private": true,
    "members": [
      {
        "id": 139,
        "name": "J'øhn126 D'øe124",
        "email": "active'123@socialcast.com",
        "cell_phone": null,
        "office_phone": null,
        "first_name": "J'øhn126",
        "last_name": "D'øe124",
        "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": 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
      }
    ],
    "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'øhn127 D'øe125",
    "unread": false,
    "unread_count": 0
  }
}