GET /api/messages/:message_id/comments

get a list of comments associated with a message

Success Response Code: 200

Params

Param name Description
message_id
required

message to retrieve comments for


Value: Must be a Integer
page
optional

page number of comments to be returned (default=1)


Value: Must be a Integer
per_page
optional

number of comments to be returned per page (default=20, max=500)


Value: Must be a Integer

Response Fields

comments array of comment entries Array<Comment>
comment[id] unique id for the comment Integer
comment[text] comment body String
comment[url] url to access the comment String
comment[permalink_url] url to access the web form of this comment String
comment[user] information about the comment's author Hash<User>
comment[created_at] datetime stamp for when the comment was originally created DateTime
comment[editable] flag to notify clients if the comment is editable by the current user Boolean
comment[detetable] flag to notify clients if the comment is deletable by the current user Boolean
comment[likable] flag to notify clients if the comment is likable by the current user Boolean
comment[likes] likes for this comment Array<Like>
comment[likes_count] total number of likes for this comment Integer
comment[attachments] files attached to this comment Array<Attachment>
comment[external_resources] url links associated with this comment, which can include oembed data. Array<ExternalResource>

Example Curl Commands

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

Examples

GET 
200
{
  "comments": [
    {
      "id": 3,
      "url": "https://socialcast.socialcast.test/api/messages/41/comments/3",
      "user": {
        "id": 73,
        "first_name": "J'øhn68",
        "last_name": "D'øe68",
        "name": "J'øhn68 D'øe68",
        "html_name": "J&#39;øhn68 D&#39;øe68",
        "url": "https://socialcast.socialcast.test/users/73-j%C3%B8hn68d%C3%B8e68",
        "avatars": {
          "is_system_default": true,
          "id": null,
          "square16": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square16-3b951350d61d203ece2fa5dd274fa7bd35275e132c17310d9006514f8839c857.png",
          "square30": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square30-6db66ac25c338d1e548a68465e2723ff63367c2aafbcc01db24c83964056b892.png",
          "square45": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square45-16865426333e244c59076d4f2475b711ed1ff9d12c97f4cf354f373a0170a1fd.png",
          "square70": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square70-1708999e8f1fea583408d7fc64b2177f853e4123bea2ffcf35f4839c8697e0ba.png",
          "square140": "https://socialcast.socialcast.test/assets-test/v6/avatars/default_user_square140-7da7e1d98b33ef152280b1f653cfd80e2db24b01b625a72abc320673eea5af53.png"
        },
        "username": "Jøhn68Døe68",
        "active": true,
        "terminated": false,
        "inactive": false,
        "role": "member",
        "type": "User",
        "title": null,
        "out_of_office": false,
        "out_of_office_on": null,
        "back_in_office_on": null,
        "company_login": null
      },
      "text": "'WHørgg?' said 3 frögs.",
      "html_body": "<div class=\"markdown-body\"><p>'WHørgg?' said 3 frögs.</p></div>",
      "created_at": "2017-05-28T02:17:51-07:00",
      "updated_at": "2017-05-28T02:17:51-07:00",
      "attachments": [],
      "media_files": [],
      "permalink_url": "https://socialcast.socialcast.test/messages/41/comments/3",
      "editable": true,
      "deletable": true,
      "likable": false,
      "external_resources": [],
      "likes_count": 0,
      "likes": [],
      "thumbnail_url": null
    }
  ]
}