API Reference

Get Employees

get
https://api.zeal.com/employees

Return information for all employees under a company

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

Returns

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

attributetypedescription
successbooleanResponse status
dataobjectResponds with a list of Employee Object(s) for requested company
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Query Params
string
required

Company ID of employer

boolean

Filter by Employee onboarded status

string

Filter by Employee employment status

string

Filter by Employee title

date

Filter by Employee date of birth

date

Filter by Employee start date

string

Filter by Employee email

string

Filter by Employee phone number

string

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

boolean

Filter by whether Employee is 943 status

boolean

Filter by whether Employee is scheduleH status

string

Filter by Employee external ID

string

Filter by Employee work location ID

Responses

Updated 6 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago