Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required

Organization identifier.

Required string length: 24
Pattern: ^[0-9a-f]{24}$

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
per_page
integer
default:100

Number of items per page.

Required range: 1 <= x <= 100
fields
string

Comma-separated names of response item fields to include.

Maximum string length: 2048
filters
string

JSON filter expression on filterable response field paths. All contract fields are filterable.

Maximum string length: 5120
sort
string

Order expression in the format :asc|desc. All contract fields are orderable.

Pattern: ^(id|name|surname|email|language|department|role_id|organization_id|created_at|created_by|email_login_enabled):(asc|desc)$

Response

Users retrieved successfully.

has_next
boolean
required

If another page is available.

data
object[]
required