---
title: "Retrieves all users."
method: GET
path: "/users"
tags: ["Users"]
---

# Retrieves all users.

`GET /users`

## Query parameters

- `external_user_id` string
- `email` string
- `page` integer
- `page_size` integer

## Response `200`

All users for this account in a list.

- UserResponseContainer
  - `meta` PaginationInfo
    - `page` integer — The current page of this get request
    - `page_size` integer — The current page-size of this get request
    - `total_items` integer — The total number of queryable items
  - `items` User[]
    - `id` integer — The user identifier. Required to update or delete users.
    - `first_name` string — First name of the user.
    - `last_name` string — Last name of the user.
    - `is_administrator` boolean — If this user is an administrator. Administrators always have access to all dashboards, as well as the ability to change all settings for an account.
    - `email` string — Email address of the user. The email address functions as the user's username.
    - `external_user_id` string — The external id of the user. The external id is only used as part of the api to label users for filtering and searching. Multiple users can have the same external id.
    - `permissions` UserPermission[]
      - `dashboard_id` integer — The dashboard identifier. This will be used with all API calls at dashboard level.
      - `role` string — Specific permission level of this user. Can be either "Manager" or "CSR" (Customer Service Rep). For giving a user admin permissions, see the is_administrator user flag.

## Other responses

- `401` — Unauthorized. Sent if the API key is omitted or invalid.

---

[API](https://skmtc.net/textrequest/apis/text-request-api-v3.md) · [All operations](https://skmtc.net/textrequest/apis/text-request-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textrequest/text-request-api-v3/revisions/e4e42efcd650/schema)
