Get Patient Invitation

GET

https://api.ferry.health/api/v1/patient-invitations/:invitationId

Get a patient invitation by its ID.

AuthorizationBearer

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

invitationIdstringRequired

The ID of the invitation.

This endpoint returns an object.

PENDINGobject

ENROLLEDobject

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	}