The carehome.co.uk Reviews APIs let you bring your reviews and Review Score into your own systems, and download your Review Score certificate, 'Review Us' poster and reviews PDF.
Who can use it: the Reviews APIs are available to Enhanced and Platinum subscribers. You need some technical knowledge to use them.
Permitted use: use the Reviews API to import reviews into your own CMS or a third-party platform, not to display them on public-facing websites or apps; use our Review Widgets for that. You can show your Review Score on your website, but only if you also install the Review Score Widget. See our API terms of use.
Endpoints
| Method | Endpoint | Returns | Documentation |
|---|---|---|---|
| GET | /index.cfm/reviews | Your published reviews (JSON) | Reviews API |
| GET | /index.cfm/reviews/ratings/index.cfm/reviews/stars/index.cfm/reviews/connections | Lookups for reading reviews (JSON) | Reviews API |
| GET | /index.cfm/reviews/scores | Your Review Score (JSON) | Review Score API |
| GET | /index.cfm/reviews/certificate | Your Review Score certificate (PDF) | Review Score Certificate API |
| GET | /index.cfm/reviews/qrcode | Your 'Review Us' QR code poster (PDF) | 'Review Us' QR Code Poster API |
| GET | /index.cfm/reviews/reviewpdf | Your published reviews (PDF) | Reviews PDF API |
Base URL
https://api.carehome.co.ukAll requests must use HTTPS. Every endpoint accepts GET only; other methods return 405.
Authentication
Pass your API key as the api_key query parameter on every request. You can find your key in the Portal; see Viewing your API Keys.
GET https://api.carehome.co.uk/index.cfm/reviews?api_key=YOUR_API_KEYEvery setting has its own API key, and so does every group. A group's key returns reviews and Review Scores for each active setting in the group.
Errors
Errors return a JSON body with an error message, for example:
{ "error": "Invalid API key" }| Status | When | error |
|---|---|---|
| 401 | No API key was sent. | API key required |
| 401 | The API key is not recognised. | Invalid API key |
| 401 | Your subscription does not include the Reviews APIs. | A message asking you to contact us to upgrade. |
| 404 | The URL is wrong. Check the path spelling. | Not Found |
| 405 | A method other than GET was used. | Method Not Allowed |
| 500 | Something went wrong on our side. Try again later; contact us if it continues. | Internal server error |
Changes
See the Reviews API Changelog.
Support
Email integrations@carehome.co.uk or call 01488 684321.