{
  "$result_object_key": [
    {
      "appointment_datetime": "2016-10-13T11:15:00Z",
      "appointment_duration_in_minutes": 15,
      "appointment_id": "67176890458",
      "appointment_location_details": "Zoom",
      "appointment_type_title": "Follow-Up",
      "billing": {
        "billing_note": "This is a billing note",
        "referring_provider": "Dr. John Doe",
        "referring_provider_state": "CA"
      },
      "created_at": "2016-10-13T00:47:01Z",
      "deleted_at": "",
      "description": "follow up to procedure",
      "instructions": "Please arrive 5 minutes early",
      "last_modified_at": "2016-10-13T00:59:16Z",
      "metadata": {
        "baz": 42,
        "foo": "bar"
      },
      "mode": "VIDEO",
      "patient_id": "64058687489",
      "payment": {
        "amount": "20.00",
        "appointment_id": "67176890458",
        "bill": 42,
        "created_at": "2020-01-27T16:17:43Z",
        "deleted_at": null,
        "id": "140755836010857",
        "payment_collected_at": "2020-01-27T16:17:43Z"
      },
      "physician_id": "131074",
      "practice_id": "65540",
      "service_location": {
        "address_line1": "123 Main Street",
        "address_line2": "Suite 200",
        "city": "San Francisco",
        "id": "13631735",
        "name": "Elation North",
        "phone_number": "555-555-5555",
        "state": "CA",
        "zip": "94107"
      },
      "status": null,
      "time_slot_status": "booked",
      "time_slot_type": "appointment"
    }
  ]
}
{
  "$result_object_key": [
    {
      "appointment_datetime": "Scheduled date and time of the appointment.",
      "appointment_duration_in_minutes": "Duration of the appointment in minutes. Must be between 1 and 1440 minutes.",
      "appointment_id": "Unique identifier for the appointment. Read-only field.",
      "appointment_location_details": "Details for telehealth appointments. DEPRECATED as of 2024-06-11.",
      "appointment_type_title": "Reason for the appointment. Required field, maximum 50 characters.",
      "billing": {
        "billing_note": "Additional billing notes.",
        "referring_provider": "Name of the referring provider.",
        "referring_provider_state": "Two-letter state code of the referring provider."
      },
      "created_at": "Timestamp when the appointment was created.",
      "deleted_at": "Timestamp when the appointment was deleted, if applicable.",
      "description": "Additional description of the appointment. Maximum 500 characters.",
      "instructions": "Instructions for the appointment. Maximum 500 characters.",
      "last_modified_at": "Timestamp when the appointment was last modified.",
      "metadata": "Additional metadata associated with the appointment.",
      "mode": "Mode of the appointment. Must be either IN_PERSON or VIDEO.",
      "patient_id": "ID of the patient for this appointment.",
      "payment": {
        "amount": "Payment amount in decimal format.",
        "appointment_id": "ID of the associated appointment.",
        "bill": "Associated bill identifier, if any.",
        "created_at": "Timestamp when the payment record was created.",
        "deleted_at": "Timestamp when the payment record was deleted, if applicable.",
        "id": "Unique identifier for the payment. Read-only field.",
        "payment_collected_at": "Timestamp when the payment was collected."
      },
      "physician_id": "ID of the physician for this appointment.",
      "practice_id": "ID of the practice for this appointment.",
      "service_location": {
        "address_line1": "First line of the service location address.",
        "address_line2": "Second line of the service location address.",
        "city": "City of the service location.",
        "id": "Unique identifier for the service location.",
        "name": "Name of the service location.",
        "phone_number": "Contact phone number for the service location.",
        "state": "State of the service location.",
        "zip": "ZIP code of the service location."
      },
      "status": "Current status of the appointment.",
      "time_slot_status": "Status of the time slot.",
      "time_slot_type": "Type of time slot."
    }
  ]
}

Parameters

Action
Parameters
{
  "$result_object_key": [
    {
      "appointment_datetime": "2016-10-13T11:15:00Z",
      "appointment_duration_in_minutes": 15,
      "appointment_id": "67176890458",
      "appointment_location_details": "Zoom",
      "appointment_type_title": "Follow-Up",
      "billing": {
        "billing_note": "This is a billing note",
        "referring_provider": "Dr. John Doe",
        "referring_provider_state": "CA"
      },
      "created_at": "2016-10-13T00:47:01Z",
      "deleted_at": "",
      "description": "follow up to procedure",
      "instructions": "Please arrive 5 minutes early",
      "last_modified_at": "2016-10-13T00:59:16Z",
      "metadata": {
        "baz": 42,
        "foo": "bar"
      },
      "mode": "VIDEO",
      "patient_id": "64058687489",
      "payment": {
        "amount": "20.00",
        "appointment_id": "67176890458",
        "bill": 42,
        "created_at": "2020-01-27T16:17:43Z",
        "deleted_at": null,
        "id": "140755836010857",
        "payment_collected_at": "2020-01-27T16:17:43Z"
      },
      "physician_id": "131074",
      "practice_id": "65540",
      "service_location": {
        "address_line1": "123 Main Street",
        "address_line2": "Suite 200",
        "city": "San Francisco",
        "id": "13631735",
        "name": "Elation North",
        "phone_number": "555-555-5555",
        "state": "CA",
        "zip": "94107"
      },
      "status": null,
      "time_slot_status": "booked",
      "time_slot_type": "appointment"
    }
  ]
}
{
  "$result_object_key": [
    {
      "appointment_datetime": "Scheduled date and time of the appointment.",
      "appointment_duration_in_minutes": "Duration of the appointment in minutes. Must be between 1 and 1440 minutes.",
      "appointment_id": "Unique identifier for the appointment. Read-only field.",
      "appointment_location_details": "Details for telehealth appointments. DEPRECATED as of 2024-06-11.",
      "appointment_type_title": "Reason for the appointment. Required field, maximum 50 characters.",
      "billing": {
        "billing_note": "Additional billing notes.",
        "referring_provider": "Name of the referring provider.",
        "referring_provider_state": "Two-letter state code of the referring provider."
      },
      "created_at": "Timestamp when the appointment was created.",
      "deleted_at": "Timestamp when the appointment was deleted, if applicable.",
      "description": "Additional description of the appointment. Maximum 500 characters.",
      "instructions": "Instructions for the appointment. Maximum 500 characters.",
      "last_modified_at": "Timestamp when the appointment was last modified.",
      "metadata": "Additional metadata associated with the appointment.",
      "mode": "Mode of the appointment. Must be either IN_PERSON or VIDEO.",
      "patient_id": "ID of the patient for this appointment.",
      "payment": {
        "amount": "Payment amount in decimal format.",
        "appointment_id": "ID of the associated appointment.",
        "bill": "Associated bill identifier, if any.",
        "created_at": "Timestamp when the payment record was created.",
        "deleted_at": "Timestamp when the payment record was deleted, if applicable.",
        "id": "Unique identifier for the payment. Read-only field.",
        "payment_collected_at": "Timestamp when the payment was collected."
      },
      "physician_id": "ID of the physician for this appointment.",
      "practice_id": "ID of the practice for this appointment.",
      "service_location": {
        "address_line1": "First line of the service location address.",
        "address_line2": "Second line of the service location address.",
        "city": "City of the service location.",
        "id": "Unique identifier for the service location.",
        "name": "Name of the service location.",
        "phone_number": "Contact phone number for the service location.",
        "state": "State of the service location.",
        "zip": "ZIP code of the service location."
      },
      "status": "Current status of the appointment.",
      "time_slot_status": "Status of the time slot.",
      "time_slot_type": "Type of time slot."
    }
  ]
}

Result Object Field Details

You can use the result of the action’s data as inputs to downstream workflow actions.

Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow.

Here we demonstrate how to refer to this data using the prefix $result_object_key.

[]Appointment
Fetch Action Response Object