Skip to main content
GET
List conversations

Authorizations

X-API-Key
string
header
required

Query Parameters

phone_number_id
string

Filter by WhatsApp phone number ID

phone_number
string

Filter by contact phone number (partial match)

status
enum<string>

Filter by conversation status

Available options:
active,
ended
assigned_user_id
string<uuid>

Filter by active assignee user ID (must be a project member)

unassigned
boolean

Filter conversations with no active assignment. Cannot be combined with assigned_user_id.

created_after
string<date-time>

Filter conversations created after this timestamp

created_before
string<date-time>

Filter conversations created before this timestamp

last_active_after
string<date-time>

Filter conversations active after this timestamp

last_active_before
string<date-time>

Filter conversations active before this timestamp

limit
integer
default:20

Maximum number of results per cursor-paginated page (default 20, max 100).

Required range: 1 <= x <= 100
before
string

Cursor for the previous page (Base64 encoded).

after
string

Cursor for the next page (Base64 encoded).

Response

List of conversations

data
object[]
required
paging
object
required