Skip to main content
POST
List threads
Required scopes: or

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
chat_id
string
required

The chat ID.

sort_order
enum<string>
default:desc

asc for oldest threads first, desc for newest threads first.

Available options:
asc,
desc
limit
integer
default:3

Maximum number of records per page. Cannot be used together with min_events_count.

Required range: x <= 100
page_id
string

Pagination token. Cannot be used together with min_events_count.

min_events_count
integer

Minimum number of events to return across threads. Returns as many latest threads as needed to meet this condition. Cannot be used together with limit, page_id, or filters.

Required range: 1 <= x <= 100
filters
object

Thread filters. Cannot be used together with min_events_count.

Response

200 - application/json

Threads in the chat.

threads
object[]

Array of thread objects.

found_threads
integer

Total number of found threads.

next_page_id
string

Pagination token for the next page.

previous_page_id
string

Pagination token for the previous page.