Retrieve a list of threads, with optional filters and sorting.
Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
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.
Whether to return only results that have been archived.
Retrieve a filtered list of conversations for a specific contact by its ID. This parameter cannot be used in conjunction with the inboxId property.
The ID of a ticket associated with the thread. When provided, returns only threads that are linked to the specified ticket.
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.
TICKET 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.
The minimum(earliest) latestMessageTimestamp. This is required only when sorting by latestMessageTimestamp.
The maximum number of results to display per page.
A specific property to include in the thread response.
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.
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.