List std vendor entitlement rows

Canon module

GET/canon/std/vendor-entitlementscanonStdVendorEntitlements.list

A vendor or sponsor entitlement. Standard Library row, copied into each new org as editable org data. Returns a cursor page of std vendor entitlement 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

canonStdVendorEntitlements.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 StdVendorEntitlement

canonStdVendorEntitlements.list: StdVendorEntitlement
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}$
vendor_class	string \| null	Yes	Vendor class the entitlement is for.Constraints: length 1 to 100
module	string \| null	Yes	Module the class may use.Constraints: length 1 to 200
permitted	boolean \| null	Yes	Whether the class may use the module.
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",
      "vendor_class": "VCL-001",
      "module": "Advance",
      "permitted": true,
      "status": "Active",
      "notes": "Primary life safety and incident response"
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-std-vendor-entitlements list --all