Reviews API

The Reviews API can be used to import reviews into your own CMS or third party platform. It cannot be used to display Reviews on public facing websites or other apps, please use our selection of Review Widgets for this purpose.

The Review Score API can be used to import reviews into your own CMS or third party platform.  It can also be used to display review scores on your website, however to do this, you must also install the Review Score Widget to display the reviews.

It is also possible to use the API to Generate your latest Review Score Certificate, your latest Reviews PDF and also Generate 'Review Us' QR Code Posters.

The Review APIs are only available to Platinum Service subscribers.

Click here to view our API terms of use.

You will need some technical knowledge in order to implement and make use of the API.

Guidelines on the API can be found below:

To view a list of current reviews, perform a GET request to https://api.carehome.co.uk/index.cfm/reviews?api_key=<api_key>, where api_key match the relevant record below. If your request is successful, will return a status code of 200, with results encoded as a JSON string. For example:

	[
	  {
	    "r_id":"review_id",
	    "date":"review_date",
	    "first_name":"N/A",
	    "last_name":"N/A",
	    "display_name":"review_display_name",
	    "description":"review_description",
	    "rc_id":"rc_id",
	    "id":"source_id",
	    "api_key":"XXX",
	    "ratings":"10:10,11:10,12:11,13:11,14:11,15:10,16:10,17:10,18:10,19:12,37:12,38:10",
	    "average_rating":"12",
	    "title":"review_title",
	    "date_related_to":"2014-12-26",
	    "has_reply": true
	  }
	]

Note that ratings will return a list of key:value pairs, in the format (rating_id:star_id). For more information on how to perform a GET request to view the relevant rating and star info, please see below.

To view a list of all possible rc_id (connection_ids), rr_id (rating_ids) and rrs_id (star_id) values, see below:

• To fetch a list of current valid reviewer connections, perform a GET request to https://api.carehome.co.uk/index.cfm/reviews/connections?api_key=<api_key> This will return a JSON string containing all the current connection values and their IDs ("rc_id") applicable to the record associated with that API key.

• To fetch a list of current rating categories, perform a GET request to https://api.carehome.co.uk/index.cfm/reviews/ratings?api_key=<api_key> This will return a JSON string containing all the current ratings and their IDs ("rr_id") applicable to the record associated with that API key.

• To fetch a list of current valid star ratings, perform a GET request to https://api.carehome.co.uk/index.cfm/reviews/stars?api_key=<api_key> This will return a JSON string containing all the current possible star ratings and their IDs ("rrs_id")

• To fetch a reply associated with a review, perform a GET request to https://api.carehome.co.uk/index.cfm/reviews/{r_id}/reply?api_key=<api_key>  This will return a JSON string containing the reply details if a reply for the review exists.

Some of the error codes you may encounter:

400 ("Validation Failed") The body of the response will contain a JSON string detailing any specific errors.
401 ("Unauthorised") Your API keys are incorrect or you do not have permission to access the specified resource.
404 ("Not Found") The resource you specified was not found. Check the spelling of the API url is correct.Click here