List Chats

List your organisation's chats (most recently active first). Returns the full org inbox — contact, channel, status, assignees, teams, labels and last message for each chat.

Optional filters: status (open/resolved), channelIds, assignedToUserIds, assignedToTeamIds, unassigned, unanswered, priority, archived, labelIds, search (chat name + contact name/phone), updatedAfter/updatedBefore, plus sortBy/sortOrder/limit/offset. Paginate with offset; hasMore indicates another page exists.

Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Query Params
string
enum

Conversation status. open = not yet resolved (default), resolved = closed/resolved.

Allowed:
channelIds
array of strings

Filter to one or more channels (channel UUIDs from GET /channels). Comma-separated or repeated.

channelIds
assignedToUserIds
array of strings

Filter to chats assigned to any of these user UUIDs (from GET /directory/{org}/users). Comma-separated or repeated. Mutually exclusive with unassigned=true.

assignedToUserIds
assignedToTeamIds
array of strings

Filter to chats assigned to any of these team UUIDs (from GET /directory/{org}/teams). Comma-separated or repeated.

assignedToTeamIds
boolean

Filter to chats with NO assignees at all. Cannot be combined with assignedToUserIds.

boolean

Filter to chats whose last message is from the customer (i.e. awaiting your reply).

boolean

Filter to high-priority chats only.

boolean

Include archived chats. Omitted/false = exclude archived (default); true = ONLY archived.

labelIds
array of strings

Filter to chats carrying any of these label UUIDs. Comma-separated or repeated.

labelIds
string

Case-insensitive search across the chat name and the attached contact name / phone number.

string

Only chats updated at/after this time (ISO 8601).

string

Only chats updated at/before this time (ISO 8601).

string
enum

Sort field. updatedAt = last activity (default), name = chat name.

Allowed:
string
enum
Allowed:
number

Page size (1-100, default 50).

number

Offset (default 0).

Responses

401

Unauthorized — invalid/expired token or wrong organisation

403

Forbidden — role not permitted

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json