Text size

Theme

Language

Version 2 API: endpoints

Error

Error updating site page. We've logged the issue, please try again later.

Endpoints are the uris to which you issue requests. Each entity type available through the version 2 API has a separate endpoint.

Opinions

The set of opinions is available at

https://www.careopinion.org.uk/api/v2/opinions

By default, opinions are ordered by date of publication, oldest first. Ordering can be reversed if required.

A single opinion is available at

https://www.careopinion.org.uk/api/v2/opinions/id


The subcollections of entities related to a single opinion are available at

https://www.careopinion.org.uk/api/v2/opinions/id/tags
https://www.careopinion.org.uk/api/v2/opinions/id/responses
https://www.careopinion.org.uk/api/v2/opinions/id/healthservices

Note that the tag subcollection of an opinion will also include the polarity (positive/negative) with which the tag was applied to the opinion.

Responses

The set of responses is available at

https://www.careopinion.org.uk/api/v2/responses

By default, responses are ordered by date of publication, oldest first. Ordering can be reversed if required.

A single response is available at

https://www.careopinion.org.uk/api/v2/responses/id

Healthservices

The set of healthservices is available at

https://www.careopinion.org.uk/api/v2/healthservices

Healthservices are ordered by id (Nacs/ODS code or ONS code).

A single healthservice is available at

https://www.careopinion.org.uk/api/v2/healthservices/id


Healthservice ratings

Each healthservice linked to an opinion may be associated with a collection of ratings scores in response to some set of questions. For example, in England we may ask the "FFT" question and in Scotland we now (since the start of 2026) ask the Scottish PREMS questions. These are the same data which appear on each service page.

The endpoint for a ratings collection has the following form:

https://www.careopinion.org.uk/api/v2/opinions/id/healthservices/id


An opinion representation will have a "ratings" navigation property for each linked healthservice. This will provide access to a ratings collection which includes a question text, score and score text for each rating provided by an author.

Tags (enhanced level)

The set of tags is available at

https://www.careopinion.org.uk/api/v2/tags

Tags are ordered by tag name.

A single tag is available at

https://www.careopinion.org.uk/api/v2/tags/id

Treatment functions (enhanced level)

The set of treatment functions is available at

https://www.careopinion.org.uk/api/v2/treatmentfunctions

Treatment functions are ordered by treatment function code.

A single treatment function is available at

https://www.careopinion.org.uk/api/v2/treatmentfunctions/id