API Reference

Get Contractors

get
https://api.zeal.com/contractors
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Zeal returns information on contractors corresponding to companyID and optional parameters used to filter contractors. If no optional parameters are passed Zeal will return all contractors pertaining to a companyID.

Returns

Returns response status and a list of Contractor Objects

attributetypedescription
successbooleanResponse status
dataarrayList of Contractor Object
errorsarrayContains 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 Contractor onboarded status

string

Filter by Contractor employment status

string

Filter by Contractor type (business, individual)

string

Filter by Contractor email

string

Filter by Contractor external 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