List canon staleness policy rows

Canon module

GET/canon/staleness-policiescanonStalenessPolicies.list

A staleness step: how a price band degrades with age. Returns a cursor page of canon staleness policy rows the caller may see. Coded list: the default order is numeric code order by `age_months_gte`. 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

canonStalenessPolicies.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 CanonStalenessPolicy

canonStalenessPolicies.list: CanonStalenessPolicy
Field	Type	Required	Description
age_months_gte	integer	Yes	Age in months at which the action applies.Constraints: range 0 to any
action	string	Yes	Action taken at that age.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
detail	string \| null	Yes	Detail of the action.Constraints: length 1 to 20000

{
  "data": [
    {
      "age_months_gte": 12,
      "action": "degrade",
      "detail": "Degrade one step."
    },
    {
      "age_months_gte": 24,
      "action": "degrade",
      "detail": "Degrade one step."
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/staleness-policies" \
  -H "Authorization: Bearer $XOS_API_KEY"

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

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

xos canon-staleness-policies list --all