Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

inboxId
string
required

Inbox id

Query Parameters

folder
enum<string>
Available options:
inbox,
sent,
archive,
trash,
spam
query
string
Maximum string length: 200
unread_only
boolean

Only conversations the agent has not marked read

label
string

Only conversations carrying this label

Maximum string length: 40
cursor
string
limit
integer
Required range: 1 <= x <= 100

Response

Conversations

threads
object[]
required
next_cursor
string | null
required

Pass as cursor for the next page; null on the last page