API Reference
  1. Viv Public API
  2. Applicants

List applicants

get
https://{apiHost}/api/v2/public/applicants

Retrieve a paginated list of caregiver applicants. Applicants are separate
from caregivers until they are hired via the /hire endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 100
Defaults to 20

Maximum number of results to return (1-100)

integer
≥ 0
Defaults to 0

Number of results to skip for pagination

date-time

Return only records updated after this timestamp (ISO 8601)

string
enum

Filter by application status. Case-insensitive. Note that 'hired' is not a valid applicant status - use the /hire endpoint to transition an applicant to a hired caregiver.

string

Filter by geographic location ID

string

Search applicants by name, phone number, or email (case-insensitive partial match)

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?