Retrieve applicant details

GET/app/v1/applicant/{id}/

Authorization

X-API-KEYstring · headerrequired

Your company's API key.

Path parameters

idintegerrequired

A unique integer value identifying this candidate.

Query parameters

end_datestring

Only records on or before this date (YYYY-MM-DD).

owner_idinteger

Filter by the assigned recruiter.

searchstring

Match on name, email or phone.

start_datestring

Only records on or after this date (YYYY-MM-DD).

statusstring

Pipeline stage, e.g. New Lead, Hired, Rejected. Comma-separate for several.

Response

200The record
idinteger
ownerobject
Show fields
idinteger
namestring
driverobject
Show fields
idinteger
namestring
first_namestring
last_namestring
emailstring (email)
phonestring
dobstring (date)
statusenum

Where the applicant is in the hiring pipeline, e.g. New Lead, Hired, Rejected.

One of: New Lead Contacted Follow Up Onboarding Lead Closed Applied Under Review Screening Rejected Hired Terminated

application_statusenum

One of: Open Pending Complete

license_statusenum

One of: Open Pending Complete

medical_card_statusenum

One of: Open Pending Complete

mvr_statusenum

One of: Open Pending Complete

psp_statusenum

One of: Open Pending Complete

clearinghouse_statusenum

One of: Open Pending Complete

drug_test_statusenum

One of: Open Pending Complete

past_emp_statusenum

One of: Open Pending Complete

onboarding_statusenum

One of: Open Pending Complete

datestring (date)
applied_atstring (date-time)
hired_atstring (date-time)
rejected_atstring (date-time)
terminated_atstring (date-time)
created_atstring (date-time)
updated_atstring (date-time)
last_activitystring (date-time)