Fetch Patient By Email

Fetches details of a specific patient by their email address, if exists. To search, pass a JSON object in the Request Body with a single "email" attribute and the email to search for.

Headers

Impilo-API-KeystringRequired

Request

This endpoint expects an object.
emailstringOptional

Response

OK
firstNamestring
The patient's first name.
lastNamestring
The patient's last name.
addressobjectOptional
The patient's shipping address. Required on all endpoints except PATCH patient.
archivedbooleanOptional
True if the patient is archived, false otherwise.
dateOfBirthstringOptionalformat: "date"

The patient’s date of birth in the format YYYY-MM-DD.

emailstringOptionalformat: "email"
The patient's email.
enrolledbooleanOptional
The enrollment status. False if disenrolled.
externalIdentifierstringOptional
Unique external identifier for the patient, managed by the customer.
idlongOptional
Unique identifier for the patient, managed by Impilo.
phoneNumberstringOptional
The patient's phone number.
sexenumOptional
Allowed values:
siteobjectOptional
The site responsible for this patient.