List applicants
/v1/applicantsReturns a page of applicants. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return applicants in this hiring stage.
Only return applicants to this office.
Only return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The applicants on this page.
Show item attributesHide item attributes(30)
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.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
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 |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 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). |
| 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.