Organisation
Search for organisations
Overview
Use this endpoint to find information about services provided by NHS organisations.
For more information on how to use search identifiers with this endpoint, see DoHS API guide to search identifiers and service codes.
Sandbox test scenarios
You can test the following scenarios in our sandbox environment:
| Scenario | Request | Response |
|---|---|---|
| All organisations | No parameters | HTTP status 200 with all organisations |
| Single organisation | search=Y02494 | HTTP status 200 with single organisation |
| No organisations found | search=no-organisation | HTTP status 200 with no organisations |
| Invalid API version | No api-version parameter | HTTP status 404 with problem description |
You can try out the sandbox using the 'Try this API feature' on this page.
post/
Query parameters
api-versionnumber required
Specify the version of the API. MUST be 3.
Request body
OrganisationPostRequest required
Organisation post request
Example request
{
"$ref": "examples/search-organisation-request-body_v3.json"
}Response
Organisation post response