Applicants

People who applied to work for your agency, tracked through your hiring stages until they are hired as caregivers.

Endpoints

The Applicant object

object
stringread-only

String representing the object's type. Always applicant.

id
stringread-only

Unique identifier of the applicant.

firstName
string | nullmax length 100

Given name.

middleName
string | nullmax length 100

Middle name.

lastName
string | nullmax length 100

Family name.

email
string · email | nullmax length 320

Email address.

phone
string | nullmax length 30

Phone number.

stage
string | nullmax length 100

Hiring stage, as named in your pipeline.

stageChangedAt
string · date-time | nullread-only

When the applicant last moved stage.

applicationDate
string · date-time | null

When the application was received.

applicationSource
string | nullmax length 100

Where the applicant found you.

referredBy
string | nullmax length 200

Who referred the applicant.

city
string | nullmax length 100

City.

state
string | nullmax length 50

State, as a two-letter code.

zipCode
string | nullmax length 20

ZIP code.

desiredStartDate
string · date | null

Earliest date the applicant can start.

desiredPayRate
number | nullmin 0

Hourly pay the applicant is asking for, in dollars.

availableHoursPerWeek
integer | nullmin 0

Hours per week the applicant can work.

yearsExperience
integer | nullmin 0

Years of caregiving experience.

primaryLanguage
string | nullmax length 50

Primary language.

hasDriversLicense
boolean | null

Whether the applicant has a driver's license.

hasReliableTransportation
boolean | null

Whether the applicant has reliable transportation.

hasCPRCertification
boolean | null

Whether the applicant holds a current CPR certification.

interviewDate
string · date-time | null

Scheduled or completed interview time.

offerStatus
string | nullmax length 50

Status of any job offer.

officeId
string | nullmax length 64

The office the applicant applied to.

notes
string | nullmax length 20000

Recruiter notes.

convertedToCaregiverId
string | nullread-onlymax length 64

The caregiver record created when the applicant was hired.

createdAt
string · date-time | nullread-only

When the applicant was created.

updatedAt
string · date-time | nullread-only

When the applicant was last changed.