---
title: "Read Employee Identities"
method: GET
path: "/admin/employee-identities/"
tags: ["admin", "employee-identities"]
---

# Read Employee Identities

`GET /admin/employee-identities/`

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

Every UpSmith employee and who they are in each system, unresolved first.

Lists employees with no identity row at all, because those are precisely the people
the ingest could not resolve and the ones this page exists for.

Departed employees are excluded unless asked for: leaving UpSmith does not soft-delete
``auth.user``, so they would otherwise sit in the queue permanently unresolvable.

## Query parameters

- `status` string, nullable
- `search` string, nullable
- `include_departed` boolean
- `limit` integer
- `page` integer

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

- EmployeeIdentityPage
  - `items` EmployeeIdentityState[]
    - `user_id` string, required
    - `email` string, nullable
    - `name` string, nullable
    - `status` 'unresolved' | 'partial' | 'resolved', required: Ordered by how much attention it wants.
    - `identity_locked_sources` string[]
    - `identities` object
    - `departed` boolean
  - `total` integer
  - `counts` 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)