Skip to main content
GET
List chats

Authorizations

Authorization
string
header
required

API key from Developer Tools. Use Authorization: Bearer <api_key>. Do not send a user JWT; it will be rejected with 401.

Query Parameters

status
enum<string>

open | pending | resolved | closed

Available options:
open,
pending,
resolved,
closed
assigned_to
string

User id string or 'unassigned'

group_uuid
string

Comma-separated UUIDs for groups

tag_uuid
string

Comma-separated label UUIDs

favorite
boolean
unread
boolean
date_from
string
date_to
string
sort_by
enum<string>
Available options:
created_at,
updated_at,
last_message_at
sort_order
enum<string>
Available options:
asc,
desc
pagination
boolean
default:false

Enable page/per_page mode

page
integer
Required range: x >= 1
per_page
integer
Required range: 1 <= x <= 100
cursor
string
limit
integer
Required range: 1 <= x <= 100

Response

Chat list result

status
integer
required
success
any
required
message
string
required
data
object
required

Response payload

errors
object[]
required