List canon touchpoint rows

Canon module

GET/canon/touchpointscanonTouchpoints.list

A five-sense touchpoint with Base, Elevated and Premium grades. Returns a cursor page of canon touchpoint rows the caller may see. Coded list: the default order is numeric code order by `touchpoint_id`. 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

canonTouchpoints.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 CanonTouchpoint

canonTouchpoints.list: CanonTouchpoint
Field	Type	Required	Description
touchpoint_id	TouchpointId	Yes	Five-sense touchpoint identifier from `xpms.dim_touchpoint`.Constraints: pattern ^[A-Z]{3}-[0-9]{2}$
sense	string	Yes	Sense the touchpoint addresses.Constraints: length 1 to 200
brief_element	string	Yes	Brief element.Constraints: length 1 to 200
category	string	Yes	Touchpoint category.Constraints: length 1 to 200
item	string	Yes	Touchpoint item.Constraints: length 1 to 200
base	string	Yes	Base grade description.Constraints: length 1 to 20000
elevated	string	Yes	Elevated grade description.Constraints: length 1 to 20000
premium	string	Yes	Premium grade description.Constraints: length 1 to 20000
optional_upgrades	string \| null	Yes	Optional upgrades.Constraints: length 1 to 20000

{
  "data": [
    {
      "touchpoint_id": "SGT-01",
      "sense": "Architecture (Sight)",
      "brief_element": "Floor Plan",
      "category": "Stage Configuration",
      "item": "Ground-Level Stage",
      "base": "Low-rise deck stage.",
      "elevated": "Deck stage with skirted fascia.",
      "premium": "Custom-fabricated floor stage.",
      "optional_upgrades": "Stage-front lighting ribbon."
    },
    {
      "touchpoint_id": "SGT-02",
      "sense": "Architecture (Sight)",
      "brief_element": "Floor Plan",
      "category": "Stage Configuration",
      "item": "Ground-Level Stage",
      "base": "Low-rise deck stage.",
      "elevated": "Deck stage with skirted fascia.",
      "premium": "Custom-fabricated floor stage.",
      "optional_upgrades": "Stage-front lighting ribbon."
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-touchpoints list --all