Skip to main content

NHS APIs Ratings and Reviews API

Ratings and reviews for NHS organisations listed in the service search on the NHS website.

Host

https://api.nhs.uk/comments

Authentication and Headers

To make a REST API call, you must include request headers including the subscription-key header with a subscription key. All subscriptions under NHS website APIs are available in JSON and XML and you can select your preference under the Accept header. If you do not choose an Accept header then the default output will be JSON.

Header key Header value
subscription‑key

Login or register to get an API key to use this API

Accept application/json
application/xml

Endpoints

Endpoint

GET /Comments

Description

Comments

Parameters

Name Type Required Allowed Default Description
orgType
query
string DEN, OPT, HOS, PHA, GPB, TRU, IND, SCL, CLI The organisation type for which you want records to be returned. - DEN (dental) - OPT (optician) - HOS (hospital) - PHA (pharmacy) - GPB (general practice) - TRU (trust) - IND (independent sector hospital) - SCL (social care location) - CLI (clinic) A list of organisation types are also available within the service search api.
odsCode
query
string An ODS code/NACS code which is used by the organisation identifier. Example: RRV03. You can use the service search api to find an ODS code of an organisation.
status
query
string published, removed published The comment status.
offset
query
integer Offset is the position in the dataset of a particular record. By specifying offset, you will retrieve a subset of records starting with the offset value. Offset normally works with limit (see below), which determines how many records to retrieve starting from the offset value. Example: 0.
limit
query
string Limit the number of records returned. Example: 100.
fromDate
query
string The start date (YYYY-MM-DD) for records you want to return.
toDate
query
string The end date (YYYY-MM-DD) for records you want to return.

Endpoint

POST /Comments

Description

Comments

Parameters

Name Type Required Allowed Default Description
body
body

Endpoint

GET /CommentById

Description

CommentById

Parameters

Name Type Required Allowed Default Description

Endpoint

GET /Ratings

Description

Ratings

Parameters

Name Type Required Allowed Default Description
odsCode
query
string true RRV03 An ODS code/NACS code which is used by the organisation identifier. You can use the service search api to find an ODS code of an organisation.

Endpoint

GET /publishers

Description

Publishers

Parameters

Name Type Required Allowed Default Description

Endpoint

GET /Count

Description

Count

Parameters

Name Type Required Allowed Default Description

Endpoint

POST /Count

Description

Count

Parameters

Name Type Required Allowed Default Description