Skip to content
API Docs/
API Reference
/
/
List Patients

List Patients

Request

Retrieve a list of patients for the practice group. Filter by EMIS ID, NHS number, or date of birth using the field and search query parameters.

Security
apiKeyAuth and practiceGroupId
Query
fieldstring
Enum:"emis_id""nhs_number""dob"
searchstring
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/patients?field=emis_id&search=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
}