Get Contractors

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

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

attribute type description
success boolean Response status
data array List of Contractor Object
errors array Contains 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 Contractor onboarded status

truefalse

employment_status

string

Filter by Contractor employment status

type

string

Filter by Contractor type (business, individual)

email

string

Filter by Contractor email

external_id

string

Filter by Contractor external ID

``200 200

``400 400

Updated 7 months ago

ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request GET \

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

--header 'accept: application/json'

application/json

200 - Result400 - Result