List emergency contact rows
Identity module
GET/emergency-contactsemergencyContacts.list
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 a cursor page of emergency contact rows the caller may see. The default order is `sort_order`, then `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability me.work_details.write.
- OAuth scopes: me.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| 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_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of EmergencyContact
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the emergency contact. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| person_id | string (uuid) | Yes | Identifier of the person the contact belongs to; always the caller. |
| full_name | string | Yes | Contact's name.Constraints: length 1 to 200 |
| relationship | string | null | Yes | How the contact relates to the person.Constraints: length 1 to 60 |
| phone_e164 | string | Yes | Contact's phone. E.164 format.Constraints: pattern ^\+[1-9][0-9]{6,14}$ |
| alternate_phone_e164 | string | null | Yes | A second phone. E.164 format.Constraints: pattern ^\+[1-9][0-9]{6,14}$ |
| string (email) | null | Yes | Contact's email address. | |
| sort_order | integer | Yes | Order to call in, lowest first.Constraints: range 0 to any |
{
"data": [
{
"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
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/emergency-contacts" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.emergencyContacts.listAll()) {
console.log(row);
}for row in xos.emergency_contacts.list_all():
print(row)xos emergency-contacts list --all