---
title: "Read the help desk status"
method: GET
path: "/products/help-desk/settings/status"
tags: ["help-desk"]
---

# Read the help desk status

`GET /products/help-desk/settings/status`

## Request

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

Whether the desk is active and takes customers now, how its customers sign in, the hosts its portal and email use, and the selected custom domain's readiness. Any member, from their own session.

## Response `200`

The desk's status.

- object
  - `data` HelpDeskStatus, required: Where the desk stands: its activation, whether it takes customers now, and the addresses it uses.
    - `activation` 'active' | 'inactive', required
    - `serving` boolean, required: Whether the desk takes customers now: active, its organization in good standing, and the help desk held.
    - `effective_auth_mode` 'identity' | 'email_pin' | 'identity_unavailable' | 'null', nullable, required: How customers sign in now. identity_unavailable: the desk asks for Secure Identity and the organization's Identity does not serve sign-ins, so customers cannot sign in until it does or the desk changes to emailed codes. Null until the desk's first activation completes, so customers sign in no way at all yet (`identity_available` says what activation would choose).
    - `hosts` object, nullable, required: Each is the selected custom domain while it serves that use (its ownership verified and that capability ready), otherwise {handle}.help.sv. Null until the organization holds a handle.
      - `canonicalHost` string, required: The portal's address in links and email.
      - `sendingHost` string, required: The domain the desk's email is sent from.
      - `receivingHost` string, required: The domain replies to the desk's email go to.
    - `domain_readiness` DomainReadiness, required: A domain's readiness: each capability ready, and whether each mail product may select it.
      - `email_sending_ready` boolean, required
      - `email_receiving_ready` boolean, required
      - `web_ready` boolean, required
      - `help_desk_selectable` boolean, required: Whether the mail product `help_desk` may select the domain: its ownership verified, its email sending ready and its web host live, on a domain that is not a zone apex.
      - `notify_selectable` boolean, required: Whether the mail product `notify` may select the domain: its ownership verified and its email sending ready, a zone apex included.
    - `identity_available` boolean, required: Whether the organization's Secure Identity serves sign-ins now.
  - `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`: 3 breaking, 1 info
  - the response property `error/details` became nullable for the status `401`
  - the response property `error/details` became nullable for the status `403`
  - added `#/components/schemas/DomainReadiness` to the `data/domain_readiness` response property `oneOf` list for the response status `200`
  - removed `subschema #1` from the `data/domain_readiness` response property `oneOf` list for the response status `200`
- **2026-10-22** `f5ac9c809ef7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sparkvault/apis/sparkvault-api/changes/products/help-desk/settings/status/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)