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

# List Users

`GET /api/v1/users`

Returns a list of all users.

Args:
    user_filter_model: Model that takes care of filtering, sorting and
        pagination.
    hydrate: Flag deciding whether to hydrate the output model(s)
        by including metadata fields in the response.
    auth_context: Authentication context.

Returns:
    A list of all users.

## Query parameters

- `hydrate` boolean
- `sort_by` string
- `logical_operator` 'or' | 'and' — Logical Ops to use to combine filters on list methods.
- `page` integer
- `size` integer
- `id` union
  - string, uuid
  - string
- `created` union
  - string, date-time
  - string
- `updated` union
  - string, date-time
  - string
- `name` string, nullable
- `full_name` string, nullable
- `email` string, nullable
- `active` union
  - boolean
  - string
- `email_opted_in` union
  - boolean
  - string
- `external_user_id` union
  - string, uuid
  - string

## Response `200`

Successful Response

- PageUserResponse
  - `index` integer, required
  - `max_size` integer, required
  - `total_pages` integer, required
  - `total` integer, required
  - `items` UserResponse[], required
    - `body` UserResponseBody — Response body for users.
      - `created` string, date-time, required
      - `updated` string, date-time, required
      - `active` boolean
      - `activation_token` string, nullable
      - `full_name` string
      - `email_opted_in` boolean, nullable — `null` if not answered, `true` if agreed, `false` if skipped.
      - `is_service_account` boolean, required
      - `is_admin` boolean, required
    - `metadata` UserResponseMetadata — Response metadata for users.
      - `email` string, nullable
      - `external_user_id` string, uuid, nullable
      - `user_metadata` object
    - `resources` UserResponseResources — Class for all resource models associated with the user entity.
    - `id` string, uuid, required
    - `permission_denied` boolean
    - `name` string, required

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)