User
List all Users
Fetch Users associated to a company
GET
/
v1
/
users
Introduction
Please note archived users are NOT returned.
Authorizations
Authorization
string
headerrequiredBearer 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:
admin
, owner
, hr
, it
, finance
, ops
, custom
, user
created_after
string
Filter Users created after a date.
created_before
string
Filter Users created before a date.
updated_after
string
Filter Users updated after a date.
updated_before
string
Filter Users updated before a date.
page
integer
The current page
per_page
integer
Number of results retrieved per page.
Response
200 - application/json
meta
object
results
object[]