Get a Conversation
Retrieve one conversation by id. The app uses this when opening a thread and passes organization_id in the query for scoping.
Endpoint
GET/conversations/:id
Request
Response
json
Query parameters
| Parameter | Type | Description |
|---|---|---|
organization_id | Number | Recommended in the app when fetching by id to ensure the record belongs to the active organization. |
Response fields (commonly used in the UI)
| Field | Type | Description |
|---|---|---|
id | Number | Conversation id. |
organization_id | Number | Owning organization. |
contact_id | Number | Linked contact. |
channel | String | whatsapp, instagram, messenger, webchat, sms, playground, etc. |
status | String | open or closed. |
unread_count | Number | Unread indicator; can be patched (see Patch conversation). |
assigned_user_id | Number or null | Human inbox owner. |
assigned_ai_assistant_id | Number / string or null | AI assistant handling the thread (API may return string or number). |
pipeline_id | Number or null | Conversation pipeline. |
pipeline_stage_id | Number or null | Current stage. |
ai_context_cut | String (ISO date) or null | Messages after this timestamp are included in AI context; patching sets a new cut. |
ai_auto_assignment_disabled | Boolean | When true with an AI still assigned, the app treats it as a conflict until resolved. |
ai_auto_assignment_disabled_reason | String or null | Reason text when auto-assignment is disabled. |
blocked | Boolean | Conversation-level block flag. |
Report an issue with this documentation
Please log in to report issues with our documentation.