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

json

Errors

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:

  • Must be a String
page
optional

The page number to start from

Validations:

  • Must be a Integer
per
optional

The size of the page

Validations:

  • Must be a Integer
type
optional

Filter Users by type - either ‘Worker’ or ‘Employer’

Validations:

  • Must be a String
email
optional

Filter Users by email

Validations:

  • Must be a String
first_name
optional

Filter Users by first name - should contain only letters, numbers, dash (-) and period (.) character

Validations:

  • Must be a String
last_name
optional

Filter Users by last name - should contain only letters, numbers, dash (-) and period (.) character

Validations:

  • Must be a String
external_id
optional

Filter Users by external id(s) - separate multiple external ids with commas

Validations:

  • Must be a String
onboarding_last_state
optional

Filter Users by onboarding state(s) - separate multiple states with commas

Validations:

  • Must be one of: not_started, started, take_quiz, take_background_check, schedule_call, call, pending_background_check, complete, rejected, error, invited.
w2_onboarding_status
optional

Filter users by W2 onboarding states(s) - separate multiple states with commas

Validations:

  • Must be one of: not_started, started, pending, completed, queued.
w2_employee_id
optional

Filter Users by their W2 employee ID

Validations:

  • Must be a String
address_state
optional

Filter Users by address state - separate multiple states with commas

Validations:

  • Must be a String
drug_tested
optional

Filter Users by drug test results - separate multiple states with commas

Validations:

  • Must be one of: passed, failed.
updated_before
optional

Filter Users by those that were last updated before provided DateTime

Validations:

  • Must be a DateTime
updated_after
optional

Filter Users by those that were last updated after provided DateTime

Validations:

  • Must be a DateTime
customer_id
optional

Filter Employers by Customer ID

Validations:

  • Must be a Integer