v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Get Employees

Return information for all employees under a company

get/employees

Query parameters

companyIDstring required

Company ID of employer

onboardedboolean

Filter by Employee onboarded status

employment_statusstring

Filter by Employee employment status

titlestring

Filter by Employee title

dobstring date

Filter by Employee date of birth

start_datestring date

Filter by Employee start date

emailstring

Filter by Employee email

phone_numberstring

Filter by Employee phone number

default_pay_schedulestring

Filter by Employee default pay schedule (daily, weekly, biweekly, semimonthly, monthly, quarterly)

is_943boolean

Filter by whether Employee is 943 status

is_scheduleHboolean

Filter by whether Employee is scheduleH status

external_idstring

Filter by Employee external ID

workLocationIDstring

Filter by Employee work location ID

Response

200