List Conversations
Retrieve conversations for an organization with filters, search, and pagination. This is the same find query the Conversations list and pipeline views use.
Endpoint
GET/conversations
Request
Response
json
Query parameters
| Parameter | Type | Description |
|---|---|---|
organization_id | Number | Required. Organization to scope results. |
$limit | Number | Page size (use at most 50). |
$skip | Number | Offset for pagination. |
$sort | Object | Sort fields, e.g. { "last_interaction_at": -1 } or { "created_at": 1 }. |
$select | Array | Optional field projection (e.g. ["id"] when resolving IDs only). |
status | String | "open" or "closed" when not using "all" in the UI. |
channel | String or operator | Exact channel (e.g. "whatsapp") or { "$ne": "playground" } to hide playground threads like the default inbox. |
assigned_user_id | Number or null | Filter by human assignee; null means unassigned. |
assigned_ai_assistant_id | Number or null | Filter by AI assistant; null means no AI assigned. |
pipeline_id | Number | Filter by conversation pipeline. |
pipeline_stage_id | Number | Filter by stage within a pipeline. |
tag_id | Number | Filter by contact tag (single tag id, as used in the app filters). |
unread_count | Object | e.g. { "$gt": 0 } for unread-only. |
waitingResponseOnly | Boolean | When true, matches the “waiting for response” filter in the UI. |
searchTerm | String | Server-side search (contact name / phone as implemented by the API). |
messageSearchTerm | String | Search message content; the app sends this when the term length is at least 3 characters. |
view_id | Number | Saved view id (used in pipeline view when a view is selected and there is no text search). |
created_at | Object | Range filter with $gte / $lte ISO date strings (start/end of day in the app). |
Notes
- Omit filters you do not need; combine only the ones that match your integration.
- For “message search”, paginate with
$limit/$skipthe same way as a normal list.
Report an issue with this documentation
Please log in to report issues with our documentation.