Get Employees

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Create a request using the companyID attribute to return key summarized information for all employees under the indicated employer.

Returns Skip link to Returns

Returns response status and a list of Employee Object(s)

attribute	type	description
success	boolean	Response status
data	object	Responds with a list of Employee Object(s) for requested company
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

companyID

string

required

Company ID of employer

onboarded

boolean

Filter by Employee onboarded status

truefalse

employment_status

string

Filter by Employee employment status

title

string

Filter by Employee title

dob

date

Filter by Employee date of birth

start_date

date

Filter by Employee start date

string

Filter by Employee email

phone_number

string

Filter by Employee phone number

default_pay_schedule

string

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

is_943

boolean

Filter by whether Employee is 943 status

truefalse

is_scheduleH

boolean

Filter by whether Employee is scheduleH status

truefalse

external_id

string

Filter by Employee external ID

workLocationID

string

Filter by Employee work location ID

``200 200

``400 400

ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request GET \

--url https://api.zeal.com/employees \

--header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updated7 months ago