Retrieve an applicant
/v1/applicants/{id}Returns one applicant by ID. Available to keys belonging to office staff.
Path parameters
ID of the applicant.
Response
200The applicant.
String representing the object's type. Always applicant.
Unique identifier of the applicant.
Given name.
Middle name.
Family name.
Email address.
Phone number.
Hiring stage, as named in your pipeline.
When the applicant last moved stage.
When the application was received.
Where the applicant found you.
Who referred the applicant.
City.
State, as a two-letter code.
ZIP code.
Earliest date the applicant can start.
Hourly pay the applicant is asking for, in dollars.
Hours per week the applicant can work.
Years of caregiving experience.
Primary language.
Whether the applicant has a driver's license.
Whether the applicant has reliable transportation.
Whether the applicant holds a current CPR certification.
Scheduled or completed interview time.
Status of any job offer.
The office the applicant applied to.
Recruiter notes.
The caregiver record created when the applicant was hired.
When the applicant was created.
When the applicant was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.