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

# List all users

`GET /users`

## Request

- Base URL: `https://enterprise.knak.io/api/published/v1`
- URL: `https://enterprise.knak.io/api/published/v1/users`
- Auth: none declared
- TypeScript: <https://skmtc.dev/knak/apis/knak-enterprise-api/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a page of [users](#tag/user_model) in the organization.

## Query parameters

- `filter[email]` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

OK

- UserList
  - `data` UserItem[]
    - `type` string
    - `id` string
    - `attributes` User
      - `id` string
      - `name` string
      - `email` string
      - `roles` string[]: The roles for the user. Can be any of the roles defined for the company including custom roles.
  - `links` object
    - `first` string
    - `last` string
    - `prev` string, nullable
    - `next` string, nullable
  - `meta` object
    - `current_page` integer
    - `from` integer
    - `last_page` integer
    - `links` object[]
      - `url` string, nullable
      - `label` string
      - `active` boolean
    - `path` string
    - `per_page` integer
    - `to` integer
    - `total` integer

## Other responses

- `401`: Unauthenticated
- `403`: Unauthorized

---

[API](https://skmtc.dev/knak/apis/knak-enterprise-api.md) - [All operations](https://skmtc.dev/knak/apis/knak-enterprise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/knak/apis/knak-enterprise-api/revisions/31d2c94edfcc?raw)