Get a conversation
Workforce module
GET/conversations/{id}conversations.get
A chat conversation: one-to-one between two members, or the conversation of a group. Returns one conversation with its `ETag`. A conversation the caller may not see returns 404.
- Requires the capability inbox.notifications.read.
- OAuth scopes: inbox.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the conversation. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: Conversation
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the conversation. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| conversation_kind | "Direct" | "Group" | Yes | Direct or Group. |
| group_id | string (uuid) | null | Yes | Identifier of the group whose conversation this is. |
| direct_key | string | null | Yes | The two membership ids of a Direct conversation, sorted and joined by a colon.Constraints: length 1 to 80 |
| last_message_at | string (date-time) | null | Yes | When the latest message was sent. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"conversation_kind": "Direct",
"group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"direct_key": "a:b",
"last_message_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/conversations/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.conversations.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.conversations.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos conversations get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f