Skip to main content
GET
Get Contractor Information
This uses the same underlying endpoint as Get Contractor Information, which looks up a single contractor by contractorID instead of listing/filtering - the API does not distinguish these with separate routes, so the query parameters accepted differ by intended usage. This page’s usage: pass companyID and any of the optional filters below (omit contractorID) to get a filtered list of contractors.

Authorizations

Authorization
string
header
required

Query Parameters

companyID
string
required

Company ID of employer

contractorID
string

ID of Contractor

onboarded
boolean

Filter by Contractor onboarded status

employment_status
string

Filter by Contractor employment status

type
enum<string>

Filter by Contractor type

Available options:
business,
individual
email
string

Filter by Contractor email

external_id
string

Filter by Contractor external ID

Response

200

success
boolean
default:true
Example:

true

data
object