users

Read Users

Changed on Mar 17, 2026

List all users (superuser only).

get/api/v1/users

Request

The document declares no server URL.
Auth: OAuth 2 (password, token URL /api/v1/login/access-token)

Query parameters

limitinteger

Page size limit

offsetinteger

Page offset

is_activeboolean nullable

is_superuserboolean nullable

searchstring nullable

start_created_atstring date-time nullable

end_created_atstring date-time nullable

order_bystring

orderstring

Response

Successful Response

totalinteger required

limitinteger required

offsetinteger required

Changes

Mar 17, 202674c707dc107e Revision changes
- breaking
  for the query request parameter limit, default value was changed from 100 to 50
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  for the query request parameter limit, the max was set to 100.00
- warning
  for the query request parameter limit, the min was set to 1.00
- warning
  deleted the query request parameter skip
- info
  added the new optional query request parameter end_created_at
- info
  added the new optional query request parameter is_active
- info
  added the new optional query request parameter is_superuser
- info
  added the new optional query request parameter offset
- info
  added the new optional query request parameter order
- info
  added the new optional query request parameter order_by
- info
  added the new optional query request parameter search
- info
  added the new optional query request parameter start_created_at
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history