Retrieve Replies to a Message — API Reference V1

Uses the given messsage ID to retrieve a all replies to a message specified in the url. By default 20 records are returned at a time. You can pass "page" and "pageSize" to change this.

Notes:

The following headers are returned:

X-Records - The total number of replies
X-Pages - The total number of pages
X-Page - The page you requested

Path Params

Name
id
Type
string
required
Description

Query Params

Name
page
Type
integer
Description
Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize.

See How does paging work for more detailed documentation on pagination. For example: ?page=2&pageSize=10 will retrieve results 10-20.
Name
pageSize
Type
integer
Description
The amount of message replies returned can be limited using this parameter. Normally used in conjunction with the page parameter.

Minimum: 1 Maximum: 200
Default
20

Responses

Code
200
Type
object
Schema
Description
200 Response

Examples

200 Response

application/json

{
  "messageReplies": [
    {
      "attachments_count": "0",
      "author-lastname": "User",
      "attachments-count": "0",
      "emailed-from": "",
      "author-avatar-url": "https://s3.amazonaws.com/TWFiles/2/users/999.avatar",
      "author_id": "999",
      "posted-on": "2014-04-01T10:04:26Z",
      "body": "Reply Body",
      "attachments": [],
      "author-firstname": "Demo",
      "id": "999",
      "last-changed-on": "2014-04-01T10:04:26Z",
      "author-id": "999",
      "messageId": "999"
    }
  ],
  "STATUS": "OK"
}

Download Swagger