List canon identifier class rows

Canon module

GET/canon/identifier-classescanonIdentifierClasses.list

Identifier grammar: identifier, code or token (Section 3.6). Returns a cursor page of canon identifier class rows the caller may see. The default order is `class` 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

canonIdentifierClasses.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 CanonIdentifierClass

canonIdentifierClasses.list: CanonIdentifierClass
Field	Type	Required	Description
class	string	Yes	Identifier class.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
issued_by	string	Yes	Who issues it.Constraints: length 1 to 300
scope	string	Yes	Where it is unique.Constraints: length 1 to 300
is_mutable	boolean	Yes	Whether it may change.
rule	string	Yes	Rule.Constraints: length 1 to 20000
examples	string	Yes	Examples.Constraints: length 1 to 300

{
  "data": [
    {
      "class": "identifier",
      "issued_by": "An external authority",
      "scope": "Global",
      "is_mutable": false,
      "rule": "Recorded and validated, never minted.",
      "examples": "GTIN, MPN, UNSPSC"
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/identifier-classes" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos canon-identifier-classes list --all