Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

Your v3 API key, e.g. ask_live_…

Headers

X-Subaccount-Id
string

Target subaccount for the request. Required unless the API key is authorized for exactly one subaccount (then it defaults to that one). Omitting it on a multi-subaccount key returns 400 subaccount_required.

Query Parameters

limit
integer
Required range: 1 <= x <= 100
cursor
integer

Offset for pagination (the next_cursor from a prior page).

Required range: 0 <= x <= 9007199254740991

Match on contact name/email/phone or conversation preview.

channel
enum<string>

Conversation channel (e.g. SMS, EMAIL, VOICE, WHATSAPP, WEBCHAT).

Available options:
SMS,
EMAIL,
VOICE,
WHATSAPP,
WEBCHAT,
FACEBOOK,
INSTAGRAM,
GMB,
LIVE_CHAT,
CUSTOM
is_archived
boolean
is_favorite
boolean
sort
enum<string>

Sort order (default newest).

Available options:
newest,
oldest,
most_active

Response

Success

data
object
required
request_id
string
required
error
null