Get a help desk team
Workforce module
GET/help-desk-teams/{id}helpDeskTeams.get
An internal team that answers help desk requests, with its first response target. Returns one help desk team with its `ETag`. A help desk team the caller may not see returns 404.
- Requires the capability inbox.notifications.read.
- OAuth scopes: inbox.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the help desk team. |
| 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: HelpDeskTeam
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the help desk team. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Person who last updated the row; null for seed, platform or system writes. |
| name | string | Yes | Team name.Constraints: length 1 to 120 |
| team_kind | "Operations" | "IT" | "HR" | "Facilities" | "Other" | Yes | Team kind. |
| description | string | null | Yes | What the team helps with.Constraints: length 1 to 1000 |
| first_response_hours | integer | Yes | Business hours to first response.Constraints: range 1 to any |
| archived_at | string (date-time) | null | Yes | When the team stopped taking requests. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "IT Desk",
"team_kind": "Operations",
"description": "Devices and accounts.",
"first_response_hours": 8,
"archived_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X GET "$XOS_BASE_URL/help-desk-teams/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.helpDeskTeams.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.help_desk_teams.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos help-desk-teams get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f