---
title: "Get details of NHS App users"
method: GET
path: "/communication/report/patients"
tags: ["communication"]
---

# Get details of NHS App users

`GET /communication/report/patients`

## Overview
Use this endpoint to get details of patients registered with the NHS App for a given GP surgery, and an indication of whether they have enabled push notifications on one or more devices. The response will only include patients who have had their identity verified to 'high' (P9) level.

Client applications must only invoke this endpoint as agreed with the NHS App team, typically to retrieve details of patients at GP practices where their service is available.

This information can be used by client applications to determine whether it is appropriate to attempt to use the NHS App API to send in-app messages and push notifications to patients, or if alternative communication channels should be used instead.

The information provided by this endpoint is generated by a daily batch process. Client applications should cache and refresh local copies of this data accordingly.

## Pagination
To avoid returning excessively large response bodies, the results may be split across multiple pages. On retrieving the response for the first page of results, the `Link` header should be inspected to determine whether any additional pages of results exist. If so, these can be retrieved by making additional request(s) with the optional `page` parameter specified.

In order to test the pagination feature in the development and integration environments, use the ODS code `T00001` to return a report with multiple pages.

## Query parameters

- `ods-organisation-code` string, required
- `page` integer

## Response `200`

Information successfully returned.

- object[] — An array of details of patients registered with the NHS App.
  - `nhsNumber` string, ^\d{10}$ — The patient's NHS number.
  - `notificationsEnabled` boolean — Indicates whether the patient has enabled native Android or Apple push notifications on at least one device.

## Other responses

- `400` — There is an error in your request.
- `401` — Authorisation issue, for example a missing or expired bearer token.
- `403` — You are not authorised to perform this operation. Some client applications may not be permitted to access the patient report endpoint. To discuss granting your application access to this endpoint, [contact the NHS App team](mailto:app.onboarding@nhs.net).
- `404` — Report (or page of report) was not found. Ensure the ODS code for which you are requesting a report is valid and exists. Also make sure you are not requesting a page that is out of bounds of the report.
- `429` — You have exceeded your application’s [rate limit](https://digital.nhs.uk/developer/guides-and-documentation/reference-guide#rate-limits) or the API is currently receiving a high volume of requests.

---

[API](https://skmtc.dev/nhs/apis/nhs-app-api.md) · [All operations](https://skmtc.dev/nhs/apis/nhs-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nhs/nhs-app-api/revisions/0afa2c6452b1/schema)