---
title: "Read User Preferences"
method: GET
path: "/user-preferences"
tags: ["authenticated", "user-preferences"]
---

# Read User Preferences

`GET /user-preferences`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/user-preferences`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Every preference resolved for the caller, definition defaults included.

Returns defaults for keys the person has never set, so the client renders
from one payload instead of duplicating the default table.

## Query parameters

- `category` 'availability' | 'dispatch' | 'agent' | 'voice' | 'notification' | 'general'

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

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