Get Appointment Task

curl https://api.ferry.health/api/v1/appointment-tasks-embedded/ferry.task-appointment.a3327c6c-1cc2-4f56-a137-6c457550a04e \
     -H "Authorization: Bearer <token>"

{
  "status": "FINDING_APPOINTMENT_OPTIONS",
  "createdAt": "2025-08-06T16:54:21.000Z",
  "id": "ferry.task-appointment.a3327c6c-1cc2-4f56-a137-6c457550a04e",
  "isTaskCanceled": false,
  "patient": {
    "id": "ferry.patient.84396f99-a7d1-44f9-ae8b-01741931269e",
    "phoneNumber": "+12234567890",
    "firstName": "John",
    "lastName": "Doe",
    "dateOfBirth": "1980-01-01",
    "gender": "MALE",
    "address": "123 Main St, Anytown, CA",
    "hasOnboarded": true,
    "insurancePlanName": "Aetna - Managed Choice Open Access",
    "insurancePlanMemberId": "123456789",
    "email": "john.doe@example.com"
  },
  "task": {
    "providerSpecialty": "Gastroenterologist",
    "reasonForVisit": "Ulcerative Colitis",
    "timeFrame": "Within the next month",
    "distanceInMiles": 5
  }
}

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.

VALIDATING_TASK_INFORMATIONobject

We are confirming that we have the information we need to execute the task.

FINDING_APPOINTMENT_OPTIONSobject

We are searching for providers for the appointment.

WAITING_ON_PATIENT_SELECTIONobject

We have chosen the best providers for the appointment and are waiting for the patient to select one.

CONFIRMING_APPOINTMENTobject

The patient has chosen a provider and we are confirming the appointment with the provider.

APPOINTMENT_CONFIRMEDobject

We have confirmed the appointment with the provider.

CANCELING_APPOINTMENTobject

We are in the process of canceling the appointment with the provider.

RESCHEDULING_APPOINTMENTobject

We are in the process of rescheduling the appointment with the provider.

APPOINTMENT_CANCELEDobject

The appointment has been canceled.