---
title: "List the teams with their help desk settings"
method: GET
path: "/products/help-desk/teams"
tags: ["help-desk"]
---

# List the teams with their help desk settings

`GET /products/help-desk/teams`

## Request

- Base URL: `https://api.sparkvault.com/v1`
- URL: `https://api.sparkvault.com/v1/products/help-desk/teams`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sparkvault/apis/sparkvault-api/docs/products/help-desk/teams/get.ts> (a function with typed inputs; its response is checked against the schema)

Every team of the organization, with the alias its email goes out under and how its new requests find an operator. Any member, from their own session.

## Response `200`

The teams.

- object
  - `data` object, required
    - `teams` HelpDeskTeamSettings[], required
      - `team_id` string, required
      - `name` string, required
      - `alias` string, required: The mailbox the team's email goes out under, before the @.
      - `assignment_mode` 'claim' | 'balanced', required: claim: operators take new requests themselves; balanced: each goes to an available operator.
      - `configured` boolean, required: False while the team keeps the defaults.
  - `meta` ResponseMeta: Envelope metadata present on every successful response.
    - `api_version` string
    - `request_id` string
    - `response_ms` integer
    - `timestamp` integer: Unix seconds.
    - `pools` object: Storage and bandwidth capacity snapshot for the account.
    - `billing` object
      - `past_due` boolean
    - `quota` object: This minute of the account request budget. Present on authenticated success responses that passed the throttle; absent otherwise.
      - `limit` integer
      - `used` integer
      - `remaining` integer
      - `resets_at` integer: Unix seconds.

## Other responses

- `401`: AUTHENTICATION_ERROR — missing or invalid credentials.
- `403`: FORBIDDEN — the credential is an API key or an impersonated session: the help desk is worked from a member's own session. HELP_DESK_SUBSCRIPTION_REQUIRED — a change that needs the help desk, on an organization that does not hold it.

## Changes

- **2026-10-28** `a9a10e328ba5`: 8 info
  - the response property `error/details` became required for the status `401`
  - the response property `error/details` became required for the status `403`
  - the response property `meta` became required for the status `401`
  - the response property `meta` became required for the status `403`
  - …4 more
- **2026-10-28** `56d7c265a77a`: 2 breaking
  - the response property `error/details` became nullable for the status `401`
  - the response property `error/details` became nullable for the status `403`
- **2026-10-22** `f5ac9c809ef7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sparkvault/apis/sparkvault-api/changes/products/help-desk/teams/get.md)

---

[API](https://skmtc.dev/sparkvault/apis/sparkvault-api.md) - [All operations](https://skmtc.dev/sparkvault/apis/sparkvault-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sparkvault/apis/sparkvault-api/revisions/97cfadccd0c0?raw)