Get Patient By Phone Number

POST

https://api.ferry.health/api/v1/patients/get-by-phone-number

Get a patient by their phone number.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

This endpoint expects an object.

phoneNumberstringRequired

The phone number of the patient. This can be in any reasonable format.

This endpoint returns an object.

patientobject or null

The patient, if one exists

1	curl -X POST https://api.ferry.health/api/v1/patients/get-by-phone-number \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"phoneNumber": "(123) 456-7890"
6	}'

1	{
2	"patient": {
3	"id": "ferry.patient.84396f99-a7d1-44f9-ae8b-01741931269e",
4	"phoneNumber": "+12234567890",
5	"firstName": "John",
6	"lastName": "Doe",
7	"dateOfBirth": "1980-01-01",
8	"gender": "MALE",
9	"address": "123 Main St, Anytown, CA",
10	"hasOnboarded": true,
11	"insurancePlanName": "Aetna - Managed Choice Open Access",
12	"insurancePlanMemberId": "123456789"
13	}
14	}