Get a chat message
Workforce module
GET/chat-messages/{id}chatMessages.get
A chat message. Photos, files and voice notes are attachments on the message. Returns one chat message with its `ETag`. A chat message 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 chat message. |
| 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: ChatMessage
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the chat message. |
| 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_id | string (uuid) | Yes | Identifier of the conversation. |
| author_membership_id | string (uuid) | Yes | Identifier of the member who sent it. |
| message_kind | "Text" | "Photo" | "File" | "Voice" | Yes | What the message carries. |
| body | string | null | Yes | Message text; optional for a photo, file or voice note.Constraints: length 1 to 4000 |
| language | string | null | Yes | Language the author wrote in.Constraints: pattern ^[a-z]{2,3}(-[A-Z]{2})?$ |
| edited_at | string (date-time) | null | Yes | When the author last edited the text. |
{
"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_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"author_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"message_kind": "Text",
"body": "Points are up on stage left.",
"language": "en-US",
"edited_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/chat-messages/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.chatMessages.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.chat_messages.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos chat-messages get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f