GET /api_v2/users
List users
Returns a list of Users, optionally paginated. Note: the maximum number returned per page in any case is 50.
Supported Formats
jsonErrors
Code | Description |
---|---|
401 | Unauthorized - you did not pass a valid token |
Examples
curl -v -d "token=HdgXqxYWd5tTdyabzfzo" https://api.wonolo.com/api_v2/users
curl -v -d "token=HdgXqxYWd5tTdyabzfzo" https://api.wonolo.com/api_v2/users?page=10&per=25
Params
Param name | Description |
---|---|
token
required |
Token obtained from /authorize Validations:
|
page
optional |
The page number to start from Validations:
|
per
optional |
The size of the page Validations:
|
type
optional |
Filter Users by type - either ‘Worker’ or ‘Employer’ Validations:
|
email
optional |
Filter Users by email Validations:
|
first_name
optional |
Filter Users by first name - should contain only letters, numbers, dash (-) and period (.) character Validations:
|
last_name
optional |
Filter Users by last name - should contain only letters, numbers, dash (-) and period (.) character Validations:
|
external_id
optional |
Filter Users by external id(s) - separate multiple external ids with commas Validations:
|
onboarding_last_state
optional |
Filter Users by onboarding state(s) - separate multiple states with commas Validations:
|
w2_onboarding_status
optional |
Filter users by W2 onboarding states(s) - separate multiple states with commas Validations:
|
w2_employee_id
optional |
Filter Users by their W2 employee ID Validations:
|
address_state
optional |
Filter Users by address state - separate multiple states with commas Validations:
|
drug_tested
optional |
Filter Users by drug test results - separate multiple states with commas Validations:
|
updated_before
optional |
Filter Users by those that were last updated before provided DateTime Validations:
|
updated_after
optional |
Filter Users by those that were last updated after provided DateTime Validations:
|
customer_id
optional |
Filter Employers by Customer ID Validations:
|