---
title: "Read the signed-in customer"
method: GET
path: "/hd/desks/{desk_id}/me"
tags: ["hd"]
---

# Read the signed-in customer

`GET /hd/desks/{desk_id}/me`

## Request

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

The customer the bearer token names at this desk. A Secure Identity customer's record is made when they first sign in.

## Path parameters

- `desk_id` string, required

## Headers

- `X-SV-Client` 'help-desk-portal', required

## Response `200`

The customer.

- object
  - `data` HelpDeskCustomer, required: The signed-in customer, as the portal shows them.
    - `requester_id` string, required
    - `email` string, required: The address the customer proved.
    - `display_name` string, nullable, required: The name the desk shows the customer by; null until they give one.
    - `assurance` 'identity' | 'email_pin', required: How the customer last proved their address: Secure Identity, or an emailed code.
    - `email_updates` boolean: Whether the desk emails the customer updates on their requests. Present only where that choice is the desk's own switch, for a customer who last proved their address with an emailed code (`assurance` `email_pin`); a Secure Identity customer sets it in their notification preferences on auth.sv instead.
    - `needs_display_name` boolean, required: True until the customer gives a name: the portal asks for one first.
  - `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

- `400`: CLIENT_HEADER_REQUIRED — see above.
- `401`: CUSTOMER_AUTH_REQUIRED — no bearer token, or one that is not a customer's of this desk now: unknown, expired, revoked, another desk's, or of the sign-in mode the desk no longer uses.
- `409`: CONFLICT — the customer's record kept changing meanwhile; try again.
- `429`: RATE_LIMIT_EXCEEDED — this client address, or this customer, has spent its reads at the desk for the minute, or the request would make a Secure Identity customer's record past the new customers the desk takes in an hour. `Retry-After` carries the seconds until the budget reopens, and `details` carries `limit` and `resets_at`.
- `503`: HELP_DESK_UNAVAILABLE — the desk does not take customers right now, or this customer is refused. INTERNAL_ERROR — the identity service's keys could not be read to verify a Secure Identity bearer. BUDGET_UNAVAILABLE — a budget the request spends could not be counted, so the request was refused rather than let through uncounted; `Retry-After` carries the seconds to wait before trying again.

## Changes

- **2026-10-28** `a9a10e328ba5`: 20 info
  - the response property `error/details` became required for the status `400`
  - the response property `error/details` became required for the status `401`
  - the response property `error/details` became required for the status `409`
  - the response property `error/details` became required for the status `429`
  - …16 more
- **2026-10-28** `56d7c265a77a`: 5 breaking
  - the response property `error/details` became nullable for the status `400`
  - the response property `error/details` became nullable for the status `401`
  - the response property `error/details` became nullable for the status `409`
  - the response property `error/details` became nullable for the status `429`
  - …1 more
- **2026-10-23** `ad4c62db5e08`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sparkvault/apis/sparkvault-api/changes/hd/desks/:desk_id/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)