Get a conversation
Módulo Workforce
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.
- Requiere la capacidad inbox.notifications.read.
- Alcances de OAuth: inbox.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the conversation. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: Conversation
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the conversation. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Person who last updated the row; null for seed, platform or system writes. |
| conversation_kind | "Direct" | "Group" | Sí | Direct or Group. |
| group_id | string (uuid) | null | Sí | Identifier of the group whose conversation this is. |
| direct_key | string | null | Sí | The two membership ids of a Direct conversation, sorted and joined by a colon.Restricciones: length 1 to 80 |
| last_message_at | string (date-time) | null | Sí | 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"
}Ejemplos de código
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