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

# List users

`GET /api/v1/users`

Retrieve all user objects.

## Query parameters

- `page_size` integer
- `cursor` string
- `id` integer[]
- `organization` integer[]
- `username` string
- `first_name` string
- `last_name` string
- `email` string
- `is_active` boolean
- `last_login` string, date-time
- `groups` string
- `queue` integer[]
- `deleted` boolean
- `ordering` 'id' | '-id' | 'username' | '-username' | 'first_name' | '-first_name' | 'last_name' | '-last_name' | 'email' | '-email' | 'last_login' | '-last_login' | 'date_joined' | '-date_joined' | 'deleted' | '-deleted' | 'not_deleted' | '-not_deleted'

## Response `200`

OK

- object
  - `pagination` Pagination, required
    - `next` string, uri, nullable — URL for the next page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.
    - `previous` string, uri, nullable — URL for the previous page of results. Contains an opaque signed `cursor` query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.
  - `results` User[], required
    - `id` integer, required — ID of the user
    - `url` string, uri, required — URL of the user
    - `first_name` string, required — First name of the user
    - `last_name` string, required — Last name of the user
    - `email` string, email, required — Email of the user
    - `phone_number` string, nullable, required — Phone number of the user
    - `password` string, required — Password (not shown on API)
    - `date_joined` string, date-time, required — Date of user join
    - `username` string, required — Username of a user
    - `groups` string[], required — List of [user role](/api/user-role) (permission groups)
    - `organization` string, uri, required — Organization URL.
    - `queues` string[], required — List of queues user is assigned to
    - `is_active` boolean, required — Whether user is enabled or disabled
    - `last_login` string, date-time, nullable, required — Date of last login
    - `ui_settings` object, required — User-related frontend UI settings (e.g. locales). Rossum internal.
    - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
    - `oidc_id` string, nullable, required — OIDC provider id used to match Rossum user (displayed only to admin user)
    - `auth_type` 'sso' | 'password', required — Authorization method, can be `sso` or `password`. This field can be edited only by admin.
    - `deleted` boolean, required — Whether a user is deleted

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)