Fetch Patient By Email

1 curl -X POST https://app.impiloplatform.com/api/v3/patient/find-by-email \ 2 -H "Impilo-API-Key: <Impilo-API-Key>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "firstName": "John", 3 "lastName": "Doe", 4 "address": { 5 "city": "foo", 6 "country": "foo", 7 "lineOne": "foo", 8 "state": "foo", 9 "zipCode": "foo", 10 "lineThree": "foo", 11 "lineTwo": "foo", 12 "note": "foo" 13 }, 14 "archived": true, 15 "dateOfBirth": "1980-01-01", 16 "email": "john.doe@example.com", 17 "enrolled": true, 18 "externalIdentifier": "1234abcd", 19 "id": 1, 20 "phoneNumber": "+1234567890", 21 "sex": "unknown", 22 "site": { 23 "active": true, 24 "address": { 25 "city": "foo", 26 "country": "foo", 27 "lineOne": "foo", 28 "state": "foo", 29 "zipCode": "foo", 30 "lineThree": "foo", 31 "lineTwo": "foo", 32 "note": "foo" 33 }, 34 "id": 1, 35 "name": "foo", 36 "phoneNumber": "foo" 37 } 38 }

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.

Request

This endpoint expects an object.

emailstringOptional

Response

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.

Headers

Request

Response