---
title: "List Users"
method: GET
path: "/users/"
tags: ["authenticated", "users"]
---

# List Users

`GET /users/`

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

## Query parameters

- `limit` integer, nullable
- `page` integer, nullable
- `search` string, nullable

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

- UserPage
  - `items` UserListItem[], required
    - `id` string, required
    - `first_name` string, required
    - `last_name` string, required
    - `email` string, required
    - `phone_number` string, nullable
    - `is_staff` boolean
    - `image` string, nullable
    - `organization_role` OrganizationRoleRead
      - `id` string, required
      - `title` string, required
      - `is_inherited` boolean, required
      - `has_access` boolean, required
      - `can_mutate_users` boolean, required
      - `can_toggle_feature_roles` boolean, required
      - `can_toggle_organization_roles` boolean, required
    - `features` FeatureRead[]
      - `id` string, required
      - `title` string, required
      - `description` string, nullable
      - `href` string, required
      - `role` FeatureRoleRead
        - `id` string, required
        - `title` string, required
        - `is_inherited` boolean, required
        - `has_access` boolean, required
        - `can_mutate_documents` boolean, required
        - `can_mutate_sessions` boolean, required
        - `can_toggle_agents` boolean, required
        - `can_toggle_engagements` boolean, required
      - `roles` FeatureRoleRead[]
        - `id` string, required
        - `title` string, required
        - `is_inherited` boolean, required
        - `has_access` boolean, required
        - `can_mutate_documents` boolean, required
        - `can_mutate_sessions` boolean, required
        - `can_toggle_agents` boolean, required
        - `can_toggle_engagements` boolean, required
    - `sms_consented` boolean
    - `sms_consent_opted_out` boolean
  - `total` integer, required
  - `cursor` string, 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/cce8b07a5787?raw)