GET/v1/messages

List message threads

Lists message threads, optionally filtered by status. Use limit and offset to control the result page; limit defaults to 20 and offset defaults to 0. The response includes pagination metadata indicating whether more results are available.

3 parameters
limitintegeroptional
Maximum number of threads to return, from 1 to 100. Defaults to 20 when omitted.
Default:20
offsetintegeroptional
Number of threads to skip. Must be 0 or greater. Defaults to 0 when omitted.
Default:0
statusstringoptional
Filter threads by status: `open` or `closed`.
Allowed:openclosed

2 status codes
200Returns a page of thread objects in `data` and pagination metadata, including the limit, offset, and whether more results are available.
dataarray<object>optional
paginationobjectoptional
401Returned when the request has missing or invalid authentication credentials.
errorobjectoptional

Error handling

A 401 is returned when the request has missing or invalid authentication credentials. limit must be between 1 and 100, offset must be 0 or greater, and status must be open or closed.