List std enumeration rows

Canon module

GET/canon/std/enumerationscanonStdEnumerations.list

A controlled enumeration value. Standard Library row, copied into each new org as editable org data. Returns a cursor page of std enumeration rows the caller may see. The default order is `record_id` 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

canonStdEnumerations.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 StdEnumeration

canonStdEnumerations.list: StdEnumeration
Field	Type	Required	Description
record_id	StdCode	Yes	Natural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
enum_domain	string \| null	Yes	Enumeration the value belongs to.Constraints: length 1 to 200
enum_code	string \| null	Yes	Code of the value.Constraints: length 1 to 200
enum_label	string \| null	Yes	Label of the value.Constraints: length 1 to 500
description	string \| null	Yes	What the value means.Constraints: length 1 to 20000
sort_order	number \| null	Yes	Order within the enumeration.
color_code	string \| null	Yes	Display color as the sheet stores it.Constraints: length 1 to 50
target_entity	string \| null	Yes	Record the enumeration applies to.Constraints: length 1 to 200
is_default	boolean \| null	Yes	Whether the value is the default.
department	string \| null	Yes	Department as the sheet names it.Constraints: length 1 to 200
category	string \| null	Yes	Category code or name as the sheet gives it.Constraints: length 1 to 200
sub_category	string \| null	Yes	Sub-category as the sheet names it.Constraints: length 1 to 200
status	string \| null	Yes	Row status in the sheet.Constraints: length 1 to 200
notes	string \| null	Yes	Notes in the sheet.Constraints: length 1 to 20000

{
  "data": [
    {
      "record_id": "SOP-001",
      "enum_domain": "Incident Severity",
      "enum_code": "SEV_L3_MODERATE",
      "enum_label": "Level 3 - Moderate",
      "description": "Non-life-threatening medical case.",
      "sort_order": 3,
      "color_code": "Amber",
      "target_entity": "Incident CAD Log",
      "is_default": false,
      "department": "5000 Production",
      "category": "5000.05.02",
      "sub_category": "Overhead Rigging",
      "status": "Active",
      "notes": "Primary life safety and incident response"
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-std-enumerations list --all