List emergency code rows

Safety module

GET/emergency-codesemergencyCodes.list

An org emergency code, seeded from the Standard Library and listed in numeric order. Returns a cursor page of emergency code rows the caller may see. Coded list: the default order is numeric code order by `sort_order`. Supports sparse fieldsets and the filter grammar.

Requires the capability safety.incident.read.
OAuth scopes: safety.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

emergencyCodes.list: 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 EmergencyCode

emergencyCodes.list: EmergencyCode
Field	Type	Required	Description
code	string	Yes	Code token.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
label	string	Yes	Code word.Constraints: length 1 to 300
emergency	string	Yes	The emergency the code announces.Constraints: length 1 to 300
swatch	string	Yes	Design token of the swatch.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
sort_order	integer	Yes	Canon order.Constraints: range 1 to any

{
  "data": [
    {
      "code": "CODE_RED",
      "label": "Code Red",
      "emergency": "Fire Emergency",
      "swatch": "ecode-red",
      "sort_order": 1
    },
    {
      "code": "CODE_RED",
      "label": "Code Red",
      "emergency": "Fire Emergency",
      "swatch": "ecode-red",
      "sort_order": 2
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/emergency-codes" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.emergencyCodes.listAll()) {
  console.log(row);
}

for row in xos.emergency_codes.list_all():
    print(row)

xos emergency-codes list --all