List users

get

https://test.wonolo.com/api_v2/users

Returns a list of Users, optionally paginated. Note: the maximum number returned per page in any case is 50.

Query Params

token

string

required

Token obtained from /authorize

page

number

The page number to start from

per

number

The size of the page

type

string

Filter Users by type - either 'Worker' or 'Employer'

string

Filter Users by email

first_name

string

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

last_name

string

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

external_id

string

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

customer_id

number

Filter Employers by Customer ID

onboarding_last_state

string

enum

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

w2_onboarding_status

string

enum

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

Allowed:

w2_employee_id

string

Filter Users by their W2 employee ID

address_state

string

Filter Users by address state - separate multiple states with
commas

drug_tested

string

enum

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

Allowed:

updated_before

string

Filter Users by those that were last updated before provided
DateTime

updated_after

string

Filter Users by those that were last updated after provided DateTime

Response

401

Unauthorized - you did not pass a valid token