{
  "$result_object_key":  [
    {
      "appointment_client_confirmed":  true,
      "appointment_created_at":  "2024-01-23T10:00:00Z",
      "appointment_created_by":  "John Smith",
      "appointment_date":  "January 23, 2024",
      "appointment_datetime":  "2024-01-23T10:00:00Z",
      "appointment_day_of_month":  "23",
      "appointment_day_of_week":  "Tuesday",
      "appointment_email_address":  "patient@email.com",
      "appointment_end_datetime":  "2024-01-23T11:30:00Z",
      "appointment_first_name":  "John",
      "appointment_id":  "12342",
      "appointment_last_name":  "Smith",
      "appointment_length_minutes":  90,
      "appointment_location_detail":  "Manhattan Office",
      "appointment_month":  "January",
      "appointment_phone_number":  "(222) 222-2222",
      "appointment_provider_email":  "mariec@radioactiverus.com",
      "appointment_provider_full_name":  "Marie Curie",
      "appointment_provider_id":  "acbdefg",
      "appointment_status":  "Confirmed",
      "appointment_time":  "10:00AM",
      "appointment_type_id":  "16f7f7e3-8df6-4eab-986d-d1fd8375926b",
      "appointment_type_title":  "Initial Consultation",
      "appointment_zoom_meeting_password":  "123456",
      "cancellation_reason_note":  "Patient will reschedule next week",
      "cancelled_at":  "2024-01-22T15:30:00Z",
      "client_note":  "(905) 875-7338",
      "full_cancellation_reason":  "Patient requested cancellation due to being cured",
      "intakeq_patient_id":  "83212",
      "invoice_id":  "65fdd9e89c7e50a54b3090ae",
      "invoice_number":  168,
      "last_updated_at":  "2024-01-23T10:21:17Z",
      "practitioner_note":  "Patient needs to complete intake form",
      "price":  150
    }
  ]
}

{
  "$result_object_key":  [
    {
      "appointment_client_confirmed":  "Whether the appointment was booked/confirmed by the client",
      "appointment_created_at":  "Time the appointment was created",
      "appointment_created_by":  "Name of person who created the appointment",
      "appointment_date":  "Full date of the appointment",
      "appointment_datetime":  "Start time of the appointment",
      "appointment_day_of_month":  "Day of month for the appointment",
      "appointment_day_of_week":  "Day of week for the appointment",
      "appointment_email_address":  "Email address of the client",
      "appointment_end_datetime":  "End time of the appointment",
      "appointment_first_name":  "Client's first name",
      "appointment_id":  "Unique identifier for the appointment",
      "appointment_last_name":  "Client's last name",
      "appointment_length_minutes":  "Duration of appointment in minutes",
      "appointment_location_detail":  "Location details - either physical location name or telehealth visit (e.g. Zoom) URL",
      "appointment_month":  "Month of the appointment",
      "appointment_phone_number":  "Phone number of the client",
      "appointment_provider_email":  "Email address of the practitioner",
      "appointment_provider_full_name":  "Full name of the practitioner",
      "appointment_provider_id":  "ID of the practitioner",
      "appointment_status":  "Status of the appointment",
      "appointment_time":  "Time of the appointment in local timezone",
      "appointment_type_id":  "Service ID for the appointment type",
      "appointment_type_title":  "Name of the service/appointment type",
      "appointment_zoom_meeting_password":  "Password for telehealth meeting if applicable",
      "cancellation_reason_note":  "Additional notes about the cancellation",
      "cancelled_at":  "If cancelled: when the appointment was cancelled",
      "client_note":  "Client Note",
      "full_cancellation_reason":  "Full reason for appointment cancellation",
      "intakeq_patient_id":  "IntakeQ's unique identifier for the patient",
      "invoice_id":  "ID of the invoice associated with the appointment",
      "invoice_number":  "Invoice number associated with the appointment",
      "last_updated_at":  "When the appointment was last updated",
      "practitioner_note":  "Note provided by the practitioner",
      "price":  "Price of the appointment (USD)"
    }
  ]
}

​
Parameters

​
Action
Parameters
​
Client Email Address
string
required

PII This field maps to the destination API client field.

​
Earliest Date
values.v1.Date

This field maps to the destination API startDate field.

​
Latest Date
values.v1.Date

This field maps to the destination API endDate field.

{
  "$result_object_key":  [
    {
      "appointment_client_confirmed":  true,
      "appointment_created_at":  "2024-01-23T10:00:00Z",
      "appointment_created_by":  "John Smith",
      "appointment_date":  "January 23, 2024",
      "appointment_datetime":  "2024-01-23T10:00:00Z",
      "appointment_day_of_month":  "23",
      "appointment_day_of_week":  "Tuesday",
      "appointment_email_address":  "patient@email.com",
      "appointment_end_datetime":  "2024-01-23T11:30:00Z",
      "appointment_first_name":  "John",
      "appointment_id":  "12342",
      "appointment_last_name":  "Smith",
      "appointment_length_minutes":  90,
      "appointment_location_detail":  "Manhattan Office",
      "appointment_month":  "January",
      "appointment_phone_number":  "(222) 222-2222",
      "appointment_provider_email":  "mariec@radioactiverus.com",
      "appointment_provider_full_name":  "Marie Curie",
      "appointment_provider_id":  "acbdefg",
      "appointment_status":  "Confirmed",
      "appointment_time":  "10:00AM",
      "appointment_type_id":  "16f7f7e3-8df6-4eab-986d-d1fd8375926b",
      "appointment_type_title":  "Initial Consultation",
      "appointment_zoom_meeting_password":  "123456",
      "cancellation_reason_note":  "Patient will reschedule next week",
      "cancelled_at":  "2024-01-22T15:30:00Z",
      "client_note":  "(905) 875-7338",
      "full_cancellation_reason":  "Patient requested cancellation due to being cured",
      "intakeq_patient_id":  "83212",
      "invoice_id":  "65fdd9e89c7e50a54b3090ae",
      "invoice_number":  168,
      "last_updated_at":  "2024-01-23T10:21:17Z",
      "practitioner_note":  "Patient needs to complete intake form",
      "price":  150
    }
  ]
}

{
  "$result_object_key":  [
    {
      "appointment_client_confirmed":  "Whether the appointment was booked/confirmed by the client",
      "appointment_created_at":  "Time the appointment was created",
      "appointment_created_by":  "Name of person who created the appointment",
      "appointment_date":  "Full date of the appointment",
      "appointment_datetime":  "Start time of the appointment",
      "appointment_day_of_month":  "Day of month for the appointment",
      "appointment_day_of_week":  "Day of week for the appointment",
      "appointment_email_address":  "Email address of the client",
      "appointment_end_datetime":  "End time of the appointment",
      "appointment_first_name":  "Client's first name",
      "appointment_id":  "Unique identifier for the appointment",
      "appointment_last_name":  "Client's last name",
      "appointment_length_minutes":  "Duration of appointment in minutes",
      "appointment_location_detail":  "Location details - either physical location name or telehealth visit (e.g. Zoom) URL",
      "appointment_month":  "Month of the appointment",
      "appointment_phone_number":  "Phone number of the client",
      "appointment_provider_email":  "Email address of the practitioner",
      "appointment_provider_full_name":  "Full name of the practitioner",
      "appointment_provider_id":  "ID of the practitioner",
      "appointment_status":  "Status of the appointment",
      "appointment_time":  "Time of the appointment in local timezone",
      "appointment_type_id":  "Service ID for the appointment type",
      "appointment_type_title":  "Name of the service/appointment type",
      "appointment_zoom_meeting_password":  "Password for telehealth meeting if applicable",
      "cancellation_reason_note":  "Additional notes about the cancellation",
      "cancelled_at":  "If cancelled: when the appointment was cancelled",
      "client_note":  "Client Note",
      "full_cancellation_reason":  "Full reason for appointment cancellation",
      "intakeq_patient_id":  "IntakeQ's unique identifier for the patient",
      "invoice_id":  "ID of the invoice associated with the appointment",
      "invoice_number":  "Invoice number associated with the appointment",
      "last_updated_at":  "When the appointment was last updated",
      "practitioner_note":  "Note provided by the practitioner",
      "price":  "Price of the appointment (USD)"
    }
  ]
}

​
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
​
appointment_id
string
required

Unique identifier for the appointment

CEL
$result_object_key[*].appointment_id
Example
"12342"
​
appointment_email_address
string
required

Email address of the client

CEL
$result_object_key[*].appointment_email_address
Example
"patient@email.com"
​
appointment_phone_number
string
required

Phone number of the client

CEL
$result_object_key[*].appointment_phone_number
Example
"(222) 222-2222"
​
appointment_type_id
string
required

Service ID for the appointment type

CEL
$result_object_key[*].appointment_type_id
Example
"16f7f7e3-8df6-4eab-986d-d1fd8375926b"
​
appointment_type_title
string
required

Name of the service/appointment type

CEL
$result_object_key[*].appointment_type_title
Example
"Initial Consultation"
​
appointment_client_confirmed
bool
required

Whether the appointment was booked/confirmed by the client

CEL
$result_object_key[*].appointment_client_confirmed
Example
true
​
appointment_location_detail
string
required

Location details - either physical location name or telehealth visit (e.g. Zoom) URL

CEL
$result_object_key[*].appointment_location_detail
Example
"Manhattan Office"
​
appointment_zoom_meeting_password
string

Password for telehealth meeting if applicable

CEL
$result_object_key[*].appointment_zoom_meeting_password
Example
"123456"
​
appointment_provider_id
string
required

ID of the practitioner

CEL
$result_object_key[*].appointment_provider_id
Example
"acbdefg"
​
appointment_provider_full_name
string
required

Full name of the practitioner

CEL
$result_object_key[*].appointment_provider_full_name
Example
"Marie Curie"
​
appointment_provider_email
string
required

Email address of the practitioner

CEL
$result_object_key[*].appointment_provider_email
Example
"mariec@radioactiverus.com"
​
appointment_datetime
timing.v1.Timestamp
required

Start time of the appointment

CEL
$result_object_key[*].appointment_datetime
Example
"2024-01-23T10:00:00Z"
​
appointment_end_datetime
timing.v1.Timestamp
required

End time of the appointment

CEL
$result_object_key[*].appointment_end_datetime
Example
"2024-01-23T11:30:00Z"
​
appointment_length_minutes
uint64
required

Duration of appointment in minutes

CEL
$result_object_key[*].appointment_length_minutes
Example
90
​
appointment_created_at
timing.v1.Timestamp
required

Time the appointment was created

CEL
$result_object_key[*].appointment_created_at
Example
"2024-01-23T10:00:00Z"
​
appointment_created_by
string
required

Name of person who created the appointment

CEL
$result_object_key[*].appointment_created_by
Example
"John Smith"
​
appointment_first_name
string
required

Client’s first name

CEL
$result_object_key[*].appointment_first_name
Example
"John"
​
appointment_last_name
string
required

Client’s last name

CEL
$result_object_key[*].appointment_last_name
Example
"Smith"
​
appointment_day_of_week
string
required

Day of week for the appointment

CEL
$result_object_key[*].appointment_day_of_week
Example
"Tuesday"
​
appointment_day_of_month
string
required

Day of month for the appointment

CEL
$result_object_key[*].appointment_day_of_month
Example
"23"
​
appointment_month
string
required

Month of the appointment

CEL
$result_object_key[*].appointment_month
Example
"January"
​
appointment_date
string
required

Full date of the appointment

CEL
$result_object_key[*].appointment_date
Example
"January 23, 2024"
​
appointment_time
string
required

Time of the appointment in local timezone

CEL
$result_object_key[*].appointment_time
Example
"10:00AM"
​
appointment_status
string
required

Status of the appointment

CEL
$result_object_key[*].appointment_status
Example
"Confirmed"
​
intakeq_patient_id
string
required

IntakeQ’s unique identifier for the patient

CEL
$result_object_key[*].intakeq_patient_id
Example
"83212"
​
last_updated_at
timing.v1.Timestamp
required

When the appointment was last updated

CEL
$result_object_key[*].last_updated_at
Example
"2024-01-23T10:21:17Z"
​
price
float64 (double)

Price of the appointment (USD)

CEL
$result_object_key[*].price
Example
150
​
invoice_id
string

ID of the invoice associated with the appointment

CEL
$result_object_key[*].invoice_id
Example
"65fdd9e89c7e50a54b3090ae"
​
invoice_number
int64

Invoice number associated with the appointment

CEL
$result_object_key[*].invoice_number
Example
168
​
client_note
string

Client Note

CEL
$result_object_key[*].client_note
Example
"(905) 875-7338"
​
practitioner_note
string

Note provided by the practitioner

CEL
$result_object_key[*].practitioner_note
Example
"Patient needs to complete intake form"
​
full_cancellation_reason
string

Full reason for appointment cancellation

CEL
$result_object_key[*].full_cancellation_reason
Example
"Patient requested cancellation due to being cured"
​
cancellation_reason_note
string

Additional notes about the cancellation

CEL
$result_object_key[*].cancellation_reason_note
Example
"Patient will reschedule next week"
​
cancelled_at
timing.v1.Timestamp

If cancelled: when the appointment was cancelled

CEL
$result_object_key[*].cancelled_at
Example
"2024-01-22T15:30:00Z"