---
title: "Jobs API overview"
slug: "jobs-api"
updated: 2026-10-21T12:40:08Z
published: 2026-10-21T12:40:08Z
canonical: "support.carehome.co.uk/jobs-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.carehome.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.

> [!NOTE]
> **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](/docs/jobs-api#partners). You need some technical knowledge to use the API. See our [API terms of use](https://www.carehome.co.uk/terms/#api).

## Endpoints

| Method | Endpoint | Does | Documentation |
| --- | --- | --- | --- |
| POST | `/index.cfm/jobs` | Post a job | [Job Post](https://support.carehome.co.uk/docs/job-post) |
| PUT | `/index.cfm/jobs/{job_id}` | Edit a job's contact and salary details | [Job Edit](https://support.carehome.co.uk/docs/job-edit) |
| POST | `/index.cfm/jobs/{job_id}/actions/close` | Close a job | [Job Close](https://support.carehome.co.uk/docs/job-close) |
| GET | `/index.cfm/jobs` `/index.cfm/jobs/{job_id}` | Your jobs, or one job | [Job API List](https://support.carehome.co.uk/docs/job-api-list) |
| GET | `/index.cfm/jobs/categories` `/index.cfm/jobs/settings` `/index.cfm/jobs/types` `/index.cfm/jobs/pay_types` `/index.cfm/jobs/towns` `/index.cfm/jobs/towns/{job_town_id}` | Allowed values for a job's fields | [Job API List](https://support.carehome.co.uk/docs/job-api-list) |
| GET | `/index.cfm/jobs/members` `/index.cfm/jobs/members/{member_id}` | Settings and groups you can brand a job as | [Job API List](https://support.carehome.co.uk/docs/job-api-list) |
| GET | `/index.cfm/jobs/credits` | Your job credit balance | [Job API List](https://support.carehome.co.uk/docs/job-api-list) |
| GET | `/index.cfm/jobs/{job_id}/applications` `/index.cfm/jobs/applications` `/index.cfm/jobs/applications/{application_id}/cv` | Applications and applicants' CVs | [Job Application API](https://support.carehome.co.uk/docs/job-application-api) |

## 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](https://support.carehome.co.uk/docs/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](https://support.carehome.co.uk/docs/job-post).

Example validation error:

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

## Status codes

| Status | When |
| --- | --- |
| 200 | Success. |
| 201 | A job was posted. |
| 400 | The request failed validation, or you have no job credits left. The reasons are in `error`. |
| 401 | No API key was sent (`API key required`), or the key is not recognised (`Invalid API key`). |
| 404 | The job, application, town or setting was not found, or it is not yours. The URL may also be wrong. |
| 405 | The endpoint does not accept that HTTP method. |
| 409 | You asked for a unique job reference and a job with that reference already exists. See [Job Post](https://support.carehome.co.uk/docs/job-post). |
| 500 | Something went wrong on our side. Try again later; contact us if it continues. |

Read the status code and the `error` array.

## Changes

See the [Jobs API Changelog](https://support.carehome.co.uk/docs/jobs-api-change-log).

## Support

Email [integrations@carehome.co.uk](mailto:integrations@carehome.co.uk) or call 01488 684321.

## Related

- [Job API List](/job-api-list.md)
- [Jobs API Changelog](/jobs-api-change-log.md)
- [Job Post](/job-post.md)
- [Job Edit](/job-edit.md)
- [Job Close](/job-close.md)