---
title: "Read your desk preferences"
method: GET
path: "/products/help-desk/operators/me"
tags: ["help-desk"]
---

# Read your desk preferences

`GET /products/help-desk/operators/me`

## Request

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

The signed-in operator's availability for balanced assignment, single-key shortcuts, the first name and last initial customers see, and their avatar handle. Before the desk first needed them, the preferences they would start with: available, shortcuts on, the name prefilled from their own, and no avatar handle yet. Reads only. Any member, from their own session.

## Response `200`

Your preferences.

- object
  - `data` HelpDeskOperatorSelf, required: The signed-in operator's own desk preferences.
    - `user_id` string, required
    - `name` string, nullable, required: The operator's identity profile name.
    - `available` boolean, required
    - `single_key_shortcuts` boolean, required
    - `in_training` boolean, required: Admin-managed; cannot be changed through self preferences.
    - `training_manager_id` string, nullable, required
    - `version` integer, required
    - `display_first` string, nullable, required
    - `display_last_initial` string, nullable, required
    - `avatar_handle` string, nullable, required: The opaque address of their avatar on the desk's portal; null before the desk first needed one.
  - `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.
- `404`: NOT_FOUND — the signed-in member is no longer a member of the organization.

## Changes

- **2026-10-28** `a9a10e328ba5`: 12 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 `error/details` became required for the status `404`
  - the response property `meta` became required for the status `401`
  - …8 more
- **2026-10-28** `56d7c265a77a`: 3 breaking
  - the response property `error/details` became nullable for the status `401`
  - the response property `error/details` became nullable for the status `403`
  - the response property `error/details` became nullable for the status `404`
- **2026-10-28** `fecd5111028e`: 3 info
  - added the required property `data/name` to the response with the `200` status
  - the response required property `data/display_first` became read-only for the status `200`
  - the response required property `data/display_last_initial` became read-only for the status `200`
- **2026-10-27** `ac44ec1f8cfa`: 3 info
  - added the required property `data/in_training` to the response with the `200` status
  - added the required property `data/training_manager_id` to the response with the `200` status
  - added the required property `data/version` to the response with the `200` status
- **2026-10-22** `f5ac9c809ef7`: 1 info
  - endpoint added

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