Skip to main content
GET
Get paginated list of conversations

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

page
integer
default:1
per_page
integer
default:15
Required range: x <= 100
phone
string

Filter by contact phone number (partial match)

contact_uuid
string<uuid>

Filter by contact UUID

agent_uuid
string<uuid>

Filter by agent UUID

campaign_uuid
string<uuid>

Filter by campaign UUID (via conversation's call)

task_uuid
string<uuid>

Filter by task UUID (matched via task.third_party_id = call.uuid)

channel
string

Filter by channel name (e.g. whatsapp, sms, call)

Example:

"whatsapp"

status
enum<string>
Available options:
Active,
Closed
sort_by
enum<string>
default:created_at
Available options:
created_at,
updated_at
sort_dir
enum<string>
default:desc
Available options:
asc,
desc

Response

Success

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Conversations retrieved successfully"

data
object