Ratings and Reviews API
Get details of ratings and reviews for NHS organisations.
Overview
Use this API to get details of ratings and reviews for NHS organisations as they appear in the service search on the NHS website.
You can also post comments through the API.
Who can use this API
This API can only be used where there is a legal basis to do so. Make sure you have a valid use case before you go too far with your development.
You must do this before you can go live (see 'Onboarding' below).
To use this API, you must:
- register with NHS website developer portal for an account
- agree to the summary of terms
API status
This API is in production, but is under review for deprecation.
We are working on a new API to replace it. Once the new API is live we will deprecate this API and contact existing users with details on how to migrate, as per our deprecation and retirement policy.
For more details see our API migration frequently asked questions.
Service level
This API is a bronze service, meaning they are operational and supported only during business hours (8am to 6pm), Monday to Friday excluding bank holidays.
For more details, see service levels.
Technology
This API is RESTful. For more details, see Basic REST.
Network access
This API is available on the internet and, indirectly, on the Health and Social Care Network (HSCN).
For more details see Network access for APIs.
Environments and testing
Environment | Subscription type |
---|---|
Test | All products - trial subscription |
Production | Individual product - full subscription |
For further details, see Getting started.
Onboarding
For more details, see getting started.
Endpoints
For endpoint details, see Ratings and Reviews API.
Last edited: 20 November 2023 1:42 pm