Get paginated list of conversations
Returns paginated conversations across voice and text channels. Use filters to find conversations by contact, phone, agent, campaign, task, channel, status, or sort order. Voice conversations may include call, campaign, listing, and task identifiers.
Authorizations
Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"
Query Parameters
x <= 100Filter by contact phone number (partial match)
Filter by the contact's exact number, compared digit-by-digit so formatting and the leading + do not matter (+905435506677 = 905435506677). Use this to check whether a thread with a number already exists before starting a new one; use phone for partial search.
"+905435506677"
Filter by contact UUID
Filter by agent UUID
Filter by campaign UUID (via conversation's call)
Filter by task UUID (matched via task.third_party_id = call.uuid)
Filter by channel name (e.g. whatsapp, sms, call)
"whatsapp"
Active, Closed Filter by conversation label uuid (from GET /session-labels). Filtering by the label named 'Open' also includes unlabeled conversations.
timestamp = last activity (inbox order)
timestamp, created_at, updated_at asc, desc Response
Success
Indicates whether the request completed successfully. True for successful responses; false for documented error responses.
true
Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.
"Conversations retrieved successfully"