Press CTRL+K to open search

Job Application API

  • Updated on Oct 21, 2026
  • Published on Oct 7, 2024
  • 2 minute(s) read
Prev Next

Retrieve the applications made to your jobs on carehome.co.uk, and download applicants' CVs.

Who can use it: Enhanced and Platinum subscribers, for jobs posted with their API key. A group's key also returns applications to jobs posted by its settings.

This is useful when a job uses an application URL: if an applicant starts applying on carehome.co.uk but doesn't finish on your site, you can still find them here. Applications to closed jobs are included.

Applications for one job

GET /index.cfm/jobs/{job_id}/applications

Base URL https://api.carehome.co.uk. Authentication, errors and support are covered in the Jobs API overview.

Parameters

ParameterTypeRequiredDescription
job_idintegerYesIn the path. ID of the job.
api_keystringYesYour API key.

Example request

curl "https://api.carehome.co.uk/index.cfm/jobs/96000000001/applications?api_key=YOUR_API_KEY"

Returns 200 OK with every application to the job, oldest first, in data. If the job has no applications, or is not yours, data is an empty array.

Applications for all your jobs

GET /index.cfm/jobs/applications

Query parameters

ParameterTypeRequiredDescription
api_keystringYesYour API key.
start_datestringNoFirst day to include, as YYYYMMDD. Default: six months ago.
end_datestringNoLast day to include, as YYYYMMDD. Default: today.

Days are in UK time and both days are included in full.

Example request

curl "https://api.carehome.co.uk/index.cfm/jobs/applications?api_key=YOUR_API_KEY&start_date=20261001&end_date=20261007"

Example response

200 OK. Applications are listed oldest first. The values below are illustrative.

{
  "data": [
    {
      "applicant_name": "Example Name",
      "applicant_email_address": "example@example.com",
      "applicant_telephone": "01234 567890",
      "applicant_country": "UK",
      "applicant_postcode": "AB1 2CD",
      "applicant_right_to_work": 1,
      "applicant_cv_link": "https://api.carehome.co.uk/index.cfm/jobs/applications/1000001/cv",
      "applicant_comment": "Example covering note.",
      "application_date_submitted": "2026-10-02T14:05:00+01:00",
      "application_id": 1000001,
      "job_id": 96000000001,
      "job_ref": "EXAMPLE-001",
      "job_title": "Care Assistant (example)"
    }
  ],
  "error": [],
  "filters": {
    "start_date": "2026-10-01T00:00:00+01:00",
    "end_date": "2026-10-07T23:59:59+01:00"
  }
}

filters shows the dates used. The one-job endpoint does not return filters.

Application object

FieldTypeDescription
applicant_namestringApplicant's first and last name.
applicant_email_addressstringApplicant's email address.
applicant_telephonestringApplicant's phone number. Empty string if not given.
applicant_countrystringCountry from the applicant's CV profile.
applicant_postcodestringPostcode from the applicant's CV profile. Empty string if not given.
applicant_right_to_workinteger1 if the applicant says they are eligible to work in the UK, 0 if not. Empty string if they have no CV profile.
applicant_cv_linkstringLink to download the applicant's CV; see Download a CV.
applicant_commentstringThe applicant's covering note. Empty string if none.
application_date_submittedstringWhen the application was made, in UK time with the offset, for example 2026-10-02T14:05:00+01:00, or Z in winter.
application_idintegerID of the application.
job_idintegerID of the job applied for.
job_refstringYour job_reference for the job. Empty string if none.
job_titlestringTitle of the job applied for.

Errors

StatusWhenerror
400A date is not eight digits.start_date is not YYYYMMDD format or end_date is not YYYYMMDD format
400A date does not exist, such as 31 February.start_date is not a valid date or end_date is not a valid date
400job_id is not a number (one-job endpoint).A numeric value is required for job_id.

Download a CV

GET /index.cfm/jobs/applications/{application_id}/cv

Returns the applicant's CV file in the format they uploaded it, such as PDF or Word. Use the applicant_cv_link from the application, adding your API key.

Parameters

ParameterTypeRequiredDescription
application_idintegerYesIn the path. ID of the application.
api_keystringYesYour API key.

Example request

curl -OJ "https://api.carehome.co.uk/index.cfm/jobs/applications/1000001/cv?api_key=YOUR_API_KEY"

Response

StatusWhen
200The CV file. Content-Type gives the file type and Content-Disposition the file name.
400application_id is not a number.
404The application has no CV, is not for one of your jobs, or the applicant has removed their CV or deleted their account.

Check the status code before saving the body. An error response is not a CV.