Saltar al contenido

Get an emergency contact

Módulo Identity

GET/emergency-contacts/{id}emergencyContacts.get

One of the caller's emergency contacts (Section 4.5.6 item 10), in calling order, at most five (422 emergency_contact_limit). Phones are E.164 (Section 15). Shared with an engagement under the Emergency Contacts category. Returns one emergency contact with its `ETag`. A emergency contact the caller may not see returns 404.

  • Requiere la capacidad me.work_details.write.
  • Alcances de OAuth: me.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

emergencyContacts.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the emergency contact.
fieldsFieldsNoSparse 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: EmergencyContact

emergencyContacts.get: EmergencyContact
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the emergency contact.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
person_idstring (uuid)SíIdentifier of the person the contact belongs to; always the caller.
full_namestringSíContact's name.Restricciones: length 1 to 200
relationshipstring | nullSíHow the contact relates to the person.Restricciones: length 1 to 60
phone_e164stringSíContact's phone. E.164 format.Restricciones: pattern ^\+[1-9][0-9]{6,14}$
alternate_phone_e164string | nullSíA second phone. E.164 format.Restricciones: pattern ^\+[1-9][0-9]{6,14}$
emailstring (email) | nullSíContact's email address.
sort_orderintegerSíOrder to call in, lowest first.Restricciones: range 0 to any
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "full_name": "Marco Marchetti",
  "relationship": "Brother",
  "phone_e164": "+13055550142",
  "alternate_phone_e164": "+13055550142",
  "email": "alex.rivera@northwindlive.example",
  "sort_order": 0
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/emergency-contacts/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.emergencyContacts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.emergency_contacts.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos emergency-contacts get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f