The job application API can be used to retrieve all applicants who have applied for any of your jobs. This can be particularly helpful where a candidate drops out of the URL Application process and is missed in your own data collection.
The following endpoints are available:
| Name | Endpoint | Notes |
|---|---|---|
| Applications per job | /jobs/{job_id}/applications/ | none |
| Applications for all jobs | /jobs/applications | Filterable by query strings: start_date, end_date |
| Applicant CV | /jobs/applications/{application_id}/cv | Will return the CV in its uploaded format |
Example Response for Applications per job & Applications for all jobs
{
"data" : [
{
"applicant_right_to_work": 1,
"applicant_comment": "A covering letter statement",
"job_id": 96000000000,
"applicant_name": "Appicant Name",
"application_id": 999999,
"job_title": "Applicant current job title",
"applicant_country": "UK",
"applicant_email_address": "applicant@gmail.com",
"applicant_telephone": "07840888888",
"applicant_cv_link": "https://api.carehome.co.uk/jobs/applications/999999/cv",
"job_ref": "Clients internal job reference",
"application_date_submitted": "2024-04-07T11:37:10+01:00",
"applicant_postcode": "RG7XXX"
}
],
"filters" : {
start_date : "",
end_date : ""
},
"error" : []
}