List emergency protocol rows

Canon module

GET/canon/std/emergency-protocolscanonStdEmergencyProtocols.list

An emergency protocol of the Standard Library (Emergency Codes sheet): what one operational domain does when a radio code is called, in numbered steps. Returns a cursor page of emergency protocol rows the caller may see. The default order is `record_key` ascending. Supports sparse fieldsets and the filter grammar.

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

Path and query parameters

canonStdEmergencyProtocols.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 CanonStdEmergencyProtocol

canonStdEmergencyProtocols.list: CanonStdEmergencyProtocol
Field	Type	Required	Description
record_key	string	Yes	Record identifier of the protocol.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
code	string	Yes	Radio code the protocol answers (xpms.emergency_code).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
domain	string	Yes	Operational domain the protocol applies to.Constraints: length 1 to 200
department	string \| null	Yes	Department as the sheet names it.Constraints: length 1 to 200
category	string \| null	Yes	Category as the sheet names it.Constraints: length 1 to 200
sub_category	string \| null	Yes	Sub-category as the sheet names it.Constraints: length 1 to 200
steps	array of CanonEmergencyProtocolStep	Yes	The protocol's steps (xpms.emergency_protocol_step), in order.

{
  "data": [
    {
      "record_key": "EMG-001",
      "code": "CODE_RED",
      "domain": "Site Operations",
      "department": "Security & Safety",
      "category": "Emergency Protocols",
      "sub_category": "Incident Response",
      "steps": [
        {
          "step_no": 1,
          "body": "Contact {fire}."
        }
      ]
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/std/emergency-protocols" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos canon-std-emergency-protocols list --all