Get Contractors
get/contractors
Request
- Base URLhttps://api.zeal.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
companyIDstring required
Company ID of employer
onboardedboolean
Filter by Contractor onboarded status
employment_statusstring
Filter by Contractor employment status
typestring
Filter by Contractor type (business, individual)
emailstring
Filter by Contractor email
external_idstring
Filter by Contractor external ID
Response
200
Example response
{
"success": true,
"data": [
{
"contractorID": "123456789",
"type": "individual",
"first_name": "richard",
"last_name": "hendricks",
"email": "richard@zeal.com",
"working_state": "MA",
"ssn": "223854986"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.