Review Score API

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

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.

For how the score is worked out, see 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.

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.