Get a canon team
Canon module
GET/canon/teams/{team_id}canonTeams.get
A canon team: a tag that rolls up to a department, never a tree level. Returns one canon team with its `ETag`. A canon team the caller may not see returns 404.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| team_id | TeamId | Yes | Canon team identifier from `xpms.dim_team`.Constraints: pattern ^[0-9]000-T[0-9]{2}$ |
| 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_]*)*$ |
Response 200: 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 |
{
"team_id": "4000-T01",
"team": "Executive Leadership",
"dept_code": "4000",
"workgroup_tag": "FOH",
"lead_role": "Production Manager",
"responsibilities": "Front of house operations."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/teams/4000-T01" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonTeams.get("4000-T01");response = xos.canon_teams.get("4000-T01")xos canon-teams get 4000-T01