v1
latestOpenAPI 3.1.02026-07-2466150275.0 KBUsers
Search Users
Search for users that match the provided search terms.
Keywords are searched for in the firstname, lastname, email, address, and phone numbers (home, work and mobile) fields.
get/v1/user/
Query parameters
querystring nullable
skipinteger nullable
limitinteger nullable
sort_direction'asc' | 'desc'
Direction to sort the sort_column - ascending or descending.
date_startstring date-time nullable
date_cut_offstring date-time nullable
sort_column'updated_at' | 'created_at' | 'id'
Which column to sort on
is_activeboolean nullable
role_idinteger nullable
Response
Successful Response
Example response
{
"data": [
{
"id": 1,
"firstName": "John",
"lastName": "Doe",
"email": "j.doe@example.com",
"companyUser": {
"id": 1275,
"role": {
"id": 4,
"name": "Foreman",
"slug": "foreman"
},
"isActive": true,
"employeeId": "EM00123",
"position": "Office Manager"
}
}
]
}