Get an engagement message
Módulo Gateway
GET/engagement-messages/{id}engagementMessages.get
A message in an engagement thread. Returns one engagement message with its `ETag`. A engagement message the caller may not see returns 404.
- Requiere la capacidad opportunities.engagement.read.
- Alcances de OAuth: opportunities.
- 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 engagement message. |
| 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: EngagementMessage
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the engagement message. |
| 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í | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| engagement_thread_id | string (uuid) | Sí | Identifier of the thread. |
| body | string | Sí | Message body.Restricciones: length 1 to 20000 |
| author_person_id | string (uuid) | null | Sí | Identifier of the sender. |
| sent_at | string (date-time) | Sí | When it 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",
"engagement_thread_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"body": "Use the north lot; passes are at the gate.",
"author_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"sent_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/engagement-messages/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.engagementMessages.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.engagement_messages.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos engagement-messages get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f