Get Patient Invitation By Phone Number

POST

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

Get a patient invitation by the patient's 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.

PENDINGobject

ENROLLEDobject

1	curl -X POST https://api.ferry.health/api/v1/patient-invitations/get-by-phone-number \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"phoneNumber": "+12234567890"
6	}'

1	{
2	"type": "PENDING",
3	"invitationId": "ferry.patient-invitation.84396f99-a7d1-44f9-ae8b-01741931269e",
4	"pendingTasks": [],
5	"phoneNumber": "+12234567890",
6	"seedData": {
7	"firstName": "Jane",
8	"lastName": "Smith"
9	}
10	}