Patients

Fetch Patient By Email

POST

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.

Response

This endpoint returns an object
id
integerOptional
Unique identifier for the patient, managed by Impilo.
externalIdentifier
stringOptional
Unique external identifier for the patient, managed by the customer.
firstName
stringOptional
The patient's first name.
lastName
stringOptional
The patient's last name.
dateOfBirth
stringOptional
The patient's date of birth in the format YYYY-MM-DD.
email
stringOptional
The patient's email.
phoneNumber
stringOptional
The patient's phone number.
archived
booleanOptional
True if the patient is archived, false otherwise.
address
objectOptional
The patient's shipping address.
site
objectOptional
The site responsible for this patient.
enrolled
booleanOptional
The enrollment status. False if disenrolled.
sex
stringOptional
Sex
POST
1curl -X POST https://app.impiloplatform.com/api/v3/patient/find-by-email \
2 -H "Impilo-API-Key: <apiKey>"
200Successful
1{
2 "id": 1,
3 "externalIdentifier": "1234abcd",
4 "firstName": "John",
5 "lastName": "Doe",
6 "dateOfBirth": "1980-01-01",
7 "email": "john.doe@example.com",
8 "phoneNumber": "+1234567890",
9 "archived": true,
10 "address": {
11 "lineOne": "lineOne",
12 "lineTwo": "lineTwo",
13 "lineThree": "lineThree",
14 "city": "city",
15 "state": "state",
16 "zipCode": "zipCode",
17 "country": "country",
18 "note": "note"
19 },
20 "site": {
21 "id": 1,
22 "name": "name",
23 "active": true,
24 "address": {
25 "lineOne": "lineOne",
26 "lineTwo": "lineTwo",
27 "lineThree": "lineThree",
28 "city": "city",
29 "state": "state",
30 "zipCode": "zipCode",
31 "country": "country",
32 "note": "note"
33 }
34 },
35 "enrolled": true,
36 "sex": "female"
37}