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

# List users

`GET /v1/users`

Retrieve a paginated list of users in the environment. Defaults to 50 users per page.

## Query parameters

- `include[]` string[]
- `after` string
- `before` string
- `page_size` integer

## Response `200`

OK

- ListUsersResponse — A paginated list of users.
  - `entries` User[] — A list of users.
    - `__typename` string, required — The typename of the schema.
    - `avatar` string, nullable — A URL for the avatar of the user.
    - `created_at` string, date-time, nullable — The creation date of the user from your system.
    - `email` string, nullable — The primary email address for the user.
    - `id` string, required — The unique identifier of the user.
    - `name` string, nullable — Display name of the user.
    - `phone_number` string, nullable — The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels).
    - `timezone` string, nullable — The timezone of the user. Must be a valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
    - `updated_at` string, date-time, required — The timestamp when the resource was last updated.
  - `page_info` PageInfo — Pagination information for a list of resources.
    - `__typename` string, required — The typename of the schema.
    - `after` string, nullable — The cursor to fetch entries after.
    - `before` string, nullable — The cursor to fetch entries before.
    - `page_size` integer, required — The number of items per page (defaults to 50).

---

[API](https://skmtc.net/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.net/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knocklabs/knock-api/versions/4b8499dddbc5/schema)