Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Workspace API token created in Settings → API. Tokens start with adraa_.

Query Parameters

status
enum<string>
default:all

open — not closed; closed; unassigned — open and without an assigned agent; all — everything.

Available options:
open,
closed,
unassigned,
all
channel
enum<string>

Only conversations on this channel.

Available options:
web,
whatsapp,
facebook,
telegram,
sms,
email
agentId
string

Only conversations assigned to this agent (list agents with GET /api/v1/agents).

Example:

"cmbxgwq1e0000ph01i0j1k2l3"

contactId
string

Only this contact's conversations (list contacts with GET /api/v1/contacts).

Example:

"cmbxgy7kq0002ph01u2v3w4x5"

q
string

Search term. Matches the subject, the contact's name and email, and message bodies.

Maximum string length: 160
Example:

"refund"

cursor
string

The nextCursor from the previous page. Omit for the first page.

limit
integer
default:50

Conversations per page.

Required range: 1 <= x <= 100
sort
enum<string>
default:updated

updated (default) orders by last activity — the inbox order. created orders newest-first by creation, for polling new conversations (e.g. Zapier dedupes by the stable id).

Available options:
updated,
created

Response

One page of conversations

conversations
object[]
nextCursor
string | null

Pass as cursor to fetch the next page. null when this is the last page.

Example:

"cmbxgz9pq0003ph01m4n5o6p7"