Skip to main content
GET
List messages

Path Parameters

threadId
string
required
Pattern: ^[0-9a-z]+$

Query Parameters

order
enum<string>

Sort direction by createdAt. Defaults to desc, newest first.

Available options:
desc,
asc
expand
enum<string>[]

Related resources to embed next to their ID field, one path per key, at most 4.

Maximum array length: 4
Available options:
sentBy,
reactions.author,
thread,
accountLink,
replyTo.message
limit
integer

Page size, from 1 to 100. Defaults to 50.

Required range: 1 <= x <= 100
cursor
string

The previous page's nextCursor. Opaque, and valid only with the filters it was issued for.

Response

Ordered by createdAt, newest first unless order is asc.

Ordered by createdAt, newest first unless order is asc.

data
object[]
required
nextCursor
string | null
required

Pass it back as cursor, with the same filters, to read the next page. Null on the last page.