Appointment

Get Appointment Task

Load an appointment task by its ID.

Authentication

AuthorizationBearer

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

Path parameters

appointmentTaskIdstringRequired
The ID of the task to load.

Response

This endpoint returns an object.
AWAITING_PATIENT_ENROLLMENTobject
We have sent a text message to the patient with a link to log into the Ferry website and confirm their personal information.
OR
FINDING_APPOINTMENT_OPTIONSobject
We are searching for providers for the appointment.
OR
WAITING_ON_PATIENT_SELECTIONobject
We have chosen the best providers for the appointment and are waiting for the patient to select one.
OR
CONFIRMING_APPOINTMENTobject
The patient has chosen a provider and we are confirming the appointment with the provider.
OR
APPOINTMENT_CONFIRMEDobject
We have confirmed the appointment with the provider.
OR
UNABLE_TO_CONTACT_PATIENTobject
The patient never enrolled on the Ferry website.
OR
CANCELATION_REQUESTEDobject
The patient has requested to cancel the appointment.
OR
RESCHEDULE_REQUESTEDobject
The patient has requested to reschedule the appointment.
OR
APPOINTMENT_CANCELEDobject
The appointment has been canceled.