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

List Patients (v2)

Request

Retrieves a list of all patients, from either the EHR or HERO. The verified_email and verified_phone fields search against verified portal credentials (Hero DB only).

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