GET
/
v1
/
users

Introduction

Please note archived users are NOT returned.

Authorizations

Authorization
string
header
required

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

Query Parameters

status_in[]
enum<string>[]

Filter by User's status.

Available options:
hired,
employee,
alumni,
external
role_in[]
enum<string>[]

Filter by User's role.

Available options:
owner,
admin,
it,
hr,
ops,
finance,
custom,
user
created_after
string

Filter Users created after a DateTime (ISO 8601).

created_before
string

Filter Users created before a DateTime (ISO 8601).

updated_after
string

Filter Users updated after a DateTime (ISO 8601).

updated_before
string

Filter Users updated before a DateTime (ISO 8601).

page
integer

The current page

per_page
integer

Number of results retrieved per page.

Response

200 - application/json
meta
object
results
object[]