Users
Returns a list of users. The list can be filtered by first name, last name or email.
get/users
Query parameters
pageSizeinteger
pageCursorstring
sortField'firstName' | 'lastName' | 'createdAt'
filterUserType'contractor' | 'time_sheet_only' | 'field_worker' | 'apprentice' | 'tradesman' | 'advisor' | 'full_user'
filterStatus'active' | 'disabled' | 'invited'
filterSearchTextstring
Searchable fields:
- firstName
- lastName
- employee's username
- address.address1
- address.address2
Response
Successful Response