Skip to content
OTA-Pulse Docs

List Users

GET
/api/users
 
curl --request GET \
  --url 'https://example.com/api/users?page=1&per_page=20' \
  --header 'Authorization: Bearer <token>'

List all users (superuser only)

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
page
Page
integer
default: 1
per_page
Per Page
integer
default: 20
search
Search
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
UserListResponse

Paginated user list response

object
items
required
Items
Array<object>
UserResponse

User response schema

object
created_at
required
Created At
string format: date-time
current_terms_version
Current Terms Version
string
""
email
required
Email
string format: email
full_name
required
Any of:
string
id
required
Id
string format: uuid
is_active
required
Is Active
boolean
is_superuser
Is Superuser
boolean
is_verified
required
Is Verified
boolean
last_login
required
Any of:
string format: date-time
organization_id
Any of:
string format: uuid
terms_acceptance_required
Terms Acceptance Required
boolean
terms_accepted_at
Any of:
string format: date-time
terms_version
Any of:
string
timezone
Any of:
string
username
required
Username
string
page
required
Page
integer
per_page
required
Per Page
integer
total
required
Total
integer
Example 
{
  "items": [
    {
      "current_terms_version": "",
      "is_superuser": false,
      "terms_acceptance_required": false,
      "timezone": "UTC"
    }
  ]
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}