---
title: "Read Identity Options"
method: GET
path: "/admin/employee-identities/options"
tags: ["admin", "employee-identities"]
---

# Read Identity Options

`GET /admin/employee-identities/options`

## 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/admin/employee-identities/options`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

Directory accounts an employee could be, for one system.

Read live from each provider rather than a mirror: unlike organizations, there is no
table of Linear/Plain/Slack *users* — the ingest only ever stores the ones it already
resolved, which is precisely not what a picker needs to offer.

Each source is isolated. Linear needs no new permission, Plain's ``users`` query needs
``user:read`` and Slack's needs the ``users:read`` bot scope, so one of the three may
fail while the others work; that surfaces as a 502 for that source alone.

Disabled accounts are excluded unless asked for. They are still linkable — a departed
person owns records and their account is the honest answer for that history — but they
are noise in a picker whose usual job is naming a current employee.

## Query parameters

- `source` string, required
- `search` string, nullable
- `include_disabled` boolean

## Headers

- `organization-id` string, nullable
- `timezone` string
- `x-user-id` string, nullable
- `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

- IdentityOptions
  - `source` string, required
  - `options` IdentityOption[]
    - `source` string, required
    - `id` string, required
    - `label` string, nullable
    - `detail` string, nullable
    - `active` boolean, nullable

## 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)