---
title: "Review Score API"
slug: "review-score-api"
updated: 2026-10-21T08:16:22Z
published: 2026-10-21T08:16:22Z
canonical: "support.carehome.co.uk/review-score-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.

# Review Score API

Retrieve your current Review Score out of 10, with the review counts behind it, as JSON.

> [!NOTE]
> **Who can use it:** Enhanced and Platinum subscribers.
> 
> 
> **Permitted use:** import your Review Score into your own CMS or a third-party platform. You can show the score on your website, but only if you also install the Review Score Widget. See our [API terms of use](https://www.carehome.co.uk/terms/#api).

For how the score is worked out, see [How is the review score calculated?](https://support.carehome.co.uk/docs/how-is-the-review-score-calculated)

## Get Review Score

```
GET /index.cfm/reviews/scores
```

Base URL `https://api.carehome.co.uk`. Authentication, errors and support are covered in the [Reviews API overview](https://support.carehome.co.uk/docs/reviews-api-overview).

### Query parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `api_key` | string | Yes | Your API key. |

### Example request

```
curl "https://api.carehome.co.uk/index.cfm/reviews/scores?api_key=YOUR_API_KEY"
```

### Example response

`200 OK`, `Content-Type: application/json`. The values below are illustrative.

```
[
  {
    "api_key": "YOUR_API_KEY",
    "id": 65432100000,
    "name": "Example Care Home",
    "address_1": "1 Example Street",
    "address_2": "",
    "address_3": "",
    "town": "Exampletown",
    "county": "Exampleshire",
    "postcode": "AB1 2CD",
    "score": 9.9,
    "score_full": 9.863,
    "score_review_count": 21,
    "all_review_count": 77
  }
]
```

The response is always an array. A setting's key returns one row. A group's key returns one row for the group and one for each active setting in the group, ordered by name.

### Score object

| Field | Type | Description |
| --- | --- | --- |
| `api_key` | string | API key of the setting or group the row is for. |
| `id` | integer | ID of the setting or group. |
| `name` | string | Name of the setting or group. |
| `address_1` | string | First address line. Empty string if not set. |
| `address_2` | string | Second address line. Empty string if not set. |
| `address_3` | string | Third address line. Empty string if not set. |
| `town` | string | Town. Empty string if not set. |
| `county` | string | County. Empty string if not set. |
| `postcode` | string | Postcode. Empty string if not set. |
| `score` | number | The Review Score out of 10, rounded to one decimal place. This is the figure shown on carehome.co.uk. `0` if there is no Review Score yet. |
| `score_full` | number | The Review Score before rounding. |
| `score_review_count` | integer | Number of reviews that count towards the current Review Score. |
| `all_review_count` | integer | Number of reviews ever published. |

## Related

- [Reviews API overview](/reviews-api-overview.md)
- [Reviews API](/reviews-api.md)
- [Reviews API Changelog](/reviews-api-changelog.md)
- [Review Score Certificate API](/review-score-certificate-api.md)
- ['Review Us' QR Code Poster API](/review-us-qr-code-poster-api.md)