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.

Headers

Authorization
string
required

Bearer token

Query Parameters

include
string

Comma-separated list of relationships to include. Allowed: profile, employments, current_employment, admin_assistant_roles, addresses, phone_numbers

sort
string

Sort order. Prefix with - for descending. Allowed: created_at, updated_at, display_name

filter[key]
string

Filter results. Available filters: created_at, created_at.neq, created_at.lt, created_at.lte, created_at.gt, created_at.gte, updated_at, updated_at.neq, updated_at.lt, updated_at.lte, updated_at.gt, updated_at.gte, email, employee_id, display_name, display_name.neq, display_name.cont (case-insensitive substring match), display_name.in (list of values, comma-separated), display_name.nin (list of values, comma-separated), profile, profile.exists (boolean), employments, current_employment, current_employment.exists (boolean), admin_assistant_roles, addresses, phone_numbers. Filter by a custom field with filter[custom_fields][<key>]=<value>. The neq, cont, in, nin, lt, lte, gt, and gte operators take the form filter[custom_fields.<operator>][<key>]=<value>, where the field's type decides which apply.

page[size]
integer

Number of items per page (max 100)

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

users found

data
object[]
required
meta
object