Skip to main content
GET
List conversations

Authorizations

x-api-key
string
header
required

Your workspace API key. Create one in Settings → API Keys; the plaintext value is shown once and never again.

Keys are scoped. A key needs conversations:send to send, conversations:read to read threads and messages, templates:read to list templates, and channels:read to list channels. A key missing the scope for an endpoint gets 403.

The CRM endpoints use the same resource:action form: leads:read, leads:create, leads:update, leads:delete, customers:read, customers:create, customers:update, customers:delete, customers:manage.

Several resources have no scope of their own and borrow one:

Grant only what the integration needs — a key that only sends notifications should hold conversations:send and nothing else.

X-Tenant-Id
string
header
required

Your workspace UUID. Required on every request in addition to x-api-key.

It does not select the workspace — data access is always scoped to the workspace that owns the API key, and a mismatched value cannot read anyone else's data.

Query Parameters

status
enum<string>
Available options:
open,
closed,
snoozed,
pending
channelId
string<uuid>
channelType
enum<string>
Available options:
whatsapp,
instagram,
facebook,
telegram,
email
lastMessageDirection
enum<string>
Available options:
inbound,
outbound
sortBy
enum<string>
default:last_message_at
Available options:
last_message_at,
created_at
sortOrder
enum<string>
default:desc
Available options:
asc,
desc
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

One page of conversations.

items
object[]
required
total
integer
required

Total matching the filters, ignoring paging.

limit
integer
required
offset
integer
required
hasMore
boolean
required