Skip to content
API Docs/
API Reference
/
/
List Patients (v3)

List Patients (v3)

Request

Retrieve a list of patients for the practice group using explicit patient filters.

This endpoint is intended for structured patient search flows where partners can provide named filters such as first_name, last_name, dob, nhs_number, or ehr_partner_id.

Compared with the v2 patients endpoint, v3 supports multi-field search in a single request instead of the older field + search format.

At least one filter must be supplied.

Security
apiKeyAuth and practiceGroupId
Query
page_indexstring

Zero-based page index for paginated results.

page_sizestring

Number of results to return per page.

first_namestring

Filter by patient first name.

last_namestring

Filter by patient last name.

dobstring

Filter by exact date of birth in YYYY-MM-DD format.

Example:dob=1990-12-31
nhs_numberstring

Filter by NHS number.

ehr_partner_idstring

Filter by the patient identifier used by the connected EHR.

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v3/patients?page_index=string&page_size=string&first_name=string&last_name=string&dob=1990-12-31&nhs_number=string&ehr_partner_id=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
countnumberrequired
Response
{
  "data": [
    { … }
  ],
  "count": 0
}