Get threads.
GET {{baseUrl}}/conversations/v3/conversations/threads?after=<string>&limit=<integer>&sort=<string>&sort=<string>&inboxId=<integer>&inboxId=<integer>&associatedContactId=<long>&threadStatus=<string>&latestMessageTimestampAfter=<dateTime>&archived=<boolean>&property=<string>&association=TICKET
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
after | string | The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results. | |
limit | string | The maximum number of results to display per page. | |
sort | string | Set the sort order of the response. Valid options are id (default) and latestMessageTimestamp (which requires the latestMessageTimestampAfter field to also be set). If you’re filtering threads by associatedContactId , you can sort in descending order by prepending - to the sort option (e.g., -id or -latestMessageTimestampAfter ). Otherwise, results are always returned in ascending order. | |
sort | string | Set the sort order of the response. Valid options are id (default) and latestMessageTimestamp (which requires the latestMessageTimestampAfter field to also be set). If you’re filtering threads by associatedContactId , you can sort in descending order by prepending - to the sort option (e.g., -id or -latestMessageTimestampAfter ). Otherwise, results are always returned in ascending order. | |
inboxId | string | The ID of the conversations inbox you can optionally include to retrieve the associated messages for. This parameter cannot be used in conjunction with the associatedContactId property. | |
inboxId | string | The ID of the conversations inbox you can optionally include to retrieve the associated messages for. This parameter cannot be used in conjunction with the associatedContactId property. | |
associatedContactId | string | The ID of a contact you can optionally include to retrieve a filtered list of conversations for. This parameter cannot be used in conjunction with the inboxId property. | |
threadStatus | string | The status of the associated conversations to filter by (either OPEN or CLOSED). This property must be provided if you’re including the associatedContactId query parameter. | |
latestMessageTimestampAfter | string | The minimum latestMessageTimestamp. This is required only when sorting by latestMessageTimestamp. | |
archived | string | Whether to return only results that have been archived. | |
property | string | ||
association | string | You can specify an association type here of TICKET. If this is set the response will included a thread associations object and associated ticket id if present. If there are no associations to a ticket with this conversation, then the thread associations object will not be present on the response. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"results":[{"associatedContactId":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","inboxId":"\u003cstring\u003e","spam":"\u003cboolean\u003e","status":"OPEN","closedAt":"\u003cdateTime\u003e","latestMessageTimestamp":"\u003cdateTime\u003e","latestMessageSentTimestamp":"\u003cdateTime\u003e","latestMessageReceivedTimestamp":"\u003cdateTime\u003e","assignedTo":"\u003cstring\u003e","archived":"\u003cboolean\u003e","originalChannelAccountId":"\u003cstring\u003e","originalChannelId":"\u003cstring\u003e"},{"associatedContactId":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","id":"\u003cstring\u003e","inboxId":"\u003cstring\u003e","spam":"\u003cboolean\u003e","status":"CLOSED","closedAt":"\u003cdateTime\u003e","latestMessageTimestamp":"\u003cdateTime\u003e","latestMessageSentTimestamp":"\u003cdateTime\u003e","latestMessageReceivedTimestamp":"\u003cdateTime\u003e","assignedTo":"\u003cstring\u003e","archived":"\u003cboolean\u003e","originalChannelAccountId":"\u003cstring\u003e","originalChannelId":"\u003cstring\u003e"}],"paging":{"next":{"after":"\u003cstring\u003e","link":"\u003cstring\u003e"}}}