Jobs API overview

The carehome.co.uk Jobs API lets you post, edit and close jobs on carehome.co.uk, read the applications they receive, and look up the values a job needs.

Who can use it: the Jobs API is available to Enhanced and Platinum subscribers, using their API key. Posting a job uses one job credit. Recruitment software partners can post on a subscriber's behalf with the subscriber's API key; see Partners. You need some technical knowledge to use the API. See our API terms of use.

Endpoints

Base URL

https://api.carehome.co.uk

All requests must use HTTPS. Send POST and PUT bodies as JSON with the header Content-Type: application/json.

Authentication

Send your API key as api_key on every request: in the query string for GET requests, and in the JSON body (or the query string) for POST and PUT requests. You can find your key in the Portal; see Viewing your API Keys.

GET https://api.carehome.co.uk/index.cfm/jobs?api_key=YOUR_API_KEY

Every setting has its own API key, and so does every group. A group's key can read the jobs and applications of every setting in the group.

Partners

A partner is a recruitment software provider that posts jobs on behalf of Enhanced and Platinum subscribers. Partners use the subscriber's API key, plus their own partner_key when posting a job, so we can see which partner posted it. We issue partner keys on request.

To get a subscriber's API key, ask the subscriber for it, or email us with the subscriber copied in. We send the key once the subscriber confirms they agree.

Responses

Responses are JSON. Most have the same envelope:

{
  "data": {},
  "error": [],
  "warn": []
}

• data holds the result: an object for a single item, an array for a list.
• error lists everything wrong with the request. An empty array means no errors.
• warn is returned by the job list and job posting endpoints. It is only used for a duplicate job reference; see Job Post.

Example validation error:

{
  "data": {},
  "error": [
    "job_title is required",
    "Invalid job_category_id: 0"
  ],
  "warn": []
}

Status codes

Read the status code and the error array.

Changes

See the Jobs API Changelog.

Support

Email integrations@carehome.co.uk or call 01488 684321.