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

NHS App API

Integrate with the NHS App to deliver messages and content to citizens and to link into NHS App journeys. OpenAPI harvested verbatim (4 paths).

NHS App 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 NHS App, Citizen, and Messaging. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 4 paths. It is described by OpenAPI 3.0.0, at version 0.1.0.

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

4 operations 4 paths 0 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://api.service.nhs.uk/nhs-app
Resource Areas
1

Paths & Operations 4

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

communication 4
POST
/communication/in-app/FHIR/R4/CommunicationRequest
Send an in-app message
create-in-app 2 params body → 201400401403429
POST
/communication/notification/FHIR/R4/CommunicationRequest
Send a push notification
create-notification 2 params body → 201400401403429
GET
/communication/report/receipts/FHIR/R4/Task
Get a daily receipt report
get-receipt-report 4 params → 200400401403429
GET
/communication/report/patients
Get details of NHS App users
get-patient-report 4 params → 200400401403404429

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nhs-app-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 Notify (Communications Manager) API
Service Search (Directory of Healthcare Services) API