Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Service Search (Directory of Healthcare Services) API

Search the national Directory of Healthcare Services for NHS organisations, services and their attributes. OpenAPI harvested verbatim.

Service Search (Directory of Healthcare Services) API is one of 10 APIs that NHS England publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Directory, Service Search, and Reference Data. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 1 path, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version Computed and injected at build time by `scripts/set_version.py`.

Requests are made against 3 base URLs: https://sandbox.api.service.nhs.uk/service-search-api, https://int.api.service.nhs.uk/service-search-api, https://api.service.nhs.uk/service-search-api.

2 operations 1 paths 4 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
Computed and injected at build time by `scripts/set_version.py`
Base URL
https://api.service.nhs.uk/service-search-api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Service Search (Directory of Healthcare Services) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuth_Token). By default, every request must be authenticated.

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Organisation 2
GET
/
Search for organisations
search-GET 11 params → 2004XX
POST
/
Search for organisations
search-POST 1 param body → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Organisation (32 properties), SearchResults (4 properties), SearchResult (1 property). Each schema is shown below with its type and property counts.

SearchResult
object
1 property
SearchResults
object
4 properties
OrganisationPostRequest
object
Organisation post request
Organisation
object
Organisation v3
32 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-service-search-openapi.yaml Raw ↑

Other APIs NHS England publishes across the network.

Personal Demographics Service (PDS) - FHIR API
GP Connect Access Record - Structured - FHIR API
Electronic Prescription Service (EPS) - FHIR API
e-Referral Service (e-RS) - FHIR API
Booking and Referral Standard (BaRS) - FHIR API
Immunisation History - FHIR API
Organisation Data Service (ODS) - FHIR API
NHS App API
NHS Notify (Communications Manager) API