List canon team rows

Canon module

GET/canon/teamscanonTeams.list

A canon team: a tag that rolls up to a department, never a tree level. Returns a cursor page of canon team rows the caller may see. Coded list: the default order is numeric code order by `team_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

canonTeams.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 CanonTeam

canonTeams.list: CanonTeam
Field	Type	Required	Description
team_id	TeamId	Yes	Canon team identifier from `xpms.dim_team`.Constraints: pattern ^[0-9]000-T[0-9]{2}$
team	string	Yes	Team name.Constraints: length 1 to 200
dept_code	DeptCode	Yes	Department class code from `xpms.dim_department` (Section 3.2).Constraints: pattern ^[0-9]000$
workgroup_tag	string \| null	Yes	Workgroup tag.Constraints: length 1 to 300
lead_role	string \| null	Yes	Lead role of the team.Constraints: length 1 to 300
responsibilities	string \| null	Yes	What the team is responsible for.Constraints: length 1 to 4000

{
  "data": [
    {
      "team_id": "0000-T01",
      "team": "Executive Leadership",
      "dept_code": "0000",
      "workgroup_tag": "FOH",
      "lead_role": "Production Manager",
      "responsibilities": "Front of house operations."
    },
    {
      "team_id": "0000-T02",
      "team": "Finance & Accounting",
      "dept_code": "0000",
      "workgroup_tag": "FOH",
      "lead_role": "Production Manager",
      "responsibilities": "Front of house operations."
    }
  ],
  "next_cursor": null
}

Code samples

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

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

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

xos canon-teams list --all