> ## Documentation Index
> Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Appointment

> Documentation for the Get Appointment action for Intakeq

![images/intakeq.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/intakeq.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=191a6c088f13edff5cd7f23a84babb49)

# Parameters

**Action** `Parameters`

**parameters**

**Appointment ID** `string` *required*

`ID`
This field maps to the destination API `appointment_id` field.

```json Result Object Example theme={null}
{
  "$result_object_key": {
    "additional_clients": [
      {
        "client_id": 42,
        "email_address": "ettore@bugatti.com",
        "name": "Ettore Bugatti",
        "phone_number": "5554016515"
      }
    ],
    "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_meeting_join_url": "https://example.com/meeting/123456",
    "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",
    "attendance_confirmation_response": "The confirmation response for the appt. (None, Confirmed, Cancelled)",
    "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",
    "intake_id": "00000000-0000-0000-0000-000000000000",
    "intakeq_patient_id": "83212",
    "invitation": "Please join the video call using the link below: ....",
    "invoice_id": "65fdd9e89c7e50a54b3090ae",
    "invoice_number": 168,
    "last_updated_at": "2024-01-23T10:21:17Z",
    "practitioner_note": "Patient needs to complete intake form",
    "price": 150
  }
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": {
    "additional_clients": {
      "client_id": "IntakeQ's unique identifier for the client",
      "email_address": "Email address of the client",
      "name": "Full name of the client",
      "phone_number": "Primary phone number of the client"
    },
    "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_meeting_join_url": "URL to join telehealth meeting if applicable",
    "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",
    "attendance_confirmation_response": "Response to the attendance confirmation request",
    "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",
    "intake_id": "ID of the intake form associated with the appointment, if any",
    "intakeq_patient_id": "IntakeQ's unique identifier for the patient",
    "invitation": "Telehealth invitation text, may include the meeting link and password",
    "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 an object name, which nests the action's result data inside the downstream data context in the workflow. See [Passing Data Between Actions](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) for how to set it and reference the result from downstream nodes.

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

**Appointment** `Fetch Action Response Object`

**fields**

**appointment\_id** `string` *required*

Unique identifier for the appointment

```json CEL theme={null}
$result_object_key.appointment_id
```

```json Example theme={null}
"12342"
```

**appointment\_email\_address** `string` *required*

Email address of the client

```json CEL theme={null}
$result_object_key.appointment_email_address
```

```json Example theme={null}
"patient@email.com"
```

**appointment\_phone\_number** `string` *required*

Phone number of the client

```json CEL theme={null}
$result_object_key.appointment_phone_number
```

```json Example theme={null}
"(222) 222-2222"
```

**appointment\_type\_id** `string` *required*

Service ID for the appointment type

```json CEL theme={null}
$result_object_key.appointment_type_id
```

```json Example theme={null}
"16f7f7e3-8df6-4eab-986d-d1fd8375926b"
```

**appointment\_type\_title** `string` *required*

Name of the service/appointment type

```json CEL theme={null}
$result_object_key.appointment_type_title
```

```json Example theme={null}
"Initial Consultation"
```

**appointment\_client\_confirmed** `bool` *required*

Whether the appointment was booked/confirmed by the client

```json CEL theme={null}
$result_object_key.appointment_client_confirmed
```

```json Example theme={null}
true
```

**appointment\_location\_detail** `string` *required*

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

```json CEL theme={null}
$result_object_key.appointment_location_detail
```

```json Example theme={null}
"Manhattan Office"
```

**appointment\_zoom\_meeting\_password** `string`

Password for telehealth meeting if applicable

```json CEL theme={null}
$result_object_key.appointment_zoom_meeting_password
```

```json Example theme={null}
"123456"
```

**appointment\_provider\_id** `string` *required*

ID of the practitioner

```json CEL theme={null}
$result_object_key.appointment_provider_id
```

```json Example theme={null}
"acbdefg"
```

**appointment\_provider\_full\_name** `string` *required*

Full name of the practitioner

```json CEL theme={null}
$result_object_key.appointment_provider_full_name
```

```json Example theme={null}
"Marie Curie"
```

**appointment\_provider\_email** `string` *required*

Email address of the practitioner

```json CEL theme={null}
$result_object_key.appointment_provider_email
```

```json Example theme={null}
"mariec@radioactiverus.com"
```

**appointment\_datetime** `timing.v1.Timestamp` *required*

Start time of the appointment

```json CEL theme={null}
$result_object_key.appointment_datetime
```

```json Example theme={null}
"2024-01-23T10:00:00Z"
```

**appointment\_end\_datetime** `timing.v1.Timestamp` *required*

End time of the appointment

```json CEL theme={null}
$result_object_key.appointment_end_datetime
```

```json Example theme={null}
"2024-01-23T11:30:00Z"
```

**appointment\_length\_minutes** `uint64` *required*

Duration of appointment in minutes

```json CEL theme={null}
$result_object_key.appointment_length_minutes
```

```json Example theme={null}
90
```

**appointment\_created\_at** `timing.v1.Timestamp` *required*

Time the appointment was created

```json CEL theme={null}
$result_object_key.appointment_created_at
```

```json Example theme={null}
"2024-01-23T10:00:00Z"
```

**appointment\_created\_by** `string` *required*

Name of person who created the appointment

```json CEL theme={null}
$result_object_key.appointment_created_by
```

```json Example theme={null}
"John Smith"
```

**appointment\_first\_name** `string` *required*

Client's first name

```json CEL theme={null}
$result_object_key.appointment_first_name
```

```json Example theme={null}
"John"
```

**appointment\_last\_name** `string` *required*

Client's last name

```json CEL theme={null}
$result_object_key.appointment_last_name
```

```json Example theme={null}
"Smith"
```

**appointment\_day\_of\_week** `string` *required*

Day of week for the appointment

```json CEL theme={null}
$result_object_key.appointment_day_of_week
```

```json Example theme={null}
"Tuesday"
```

**appointment\_day\_of\_month** `string` *required*

Day of month for the appointment

```json CEL theme={null}
$result_object_key.appointment_day_of_month
```

```json Example theme={null}
"23"
```

**appointment\_month** `string` *required*

Month of the appointment

```json CEL theme={null}
$result_object_key.appointment_month
```

```json Example theme={null}
"January"
```

**appointment\_date** `string` *required*

Full date of the appointment

```json CEL theme={null}
$result_object_key.appointment_date
```

```json Example theme={null}
"January 23, 2024"
```

**appointment\_time** `string` *required*

Time of the appointment in local timezone

```json CEL theme={null}
$result_object_key.appointment_time
```

```json Example theme={null}
"10:00AM"
```

**appointment\_status** `string` *required*

Status of the appointment

```json CEL theme={null}
$result_object_key.appointment_status
```

```json Example theme={null}
"Confirmed"
```

**intakeq\_patient\_id** `string` *required*

IntakeQ's unique identifier for the patient

```json CEL theme={null}
$result_object_key.intakeq_patient_id
```

```json Example theme={null}
"83212"
```

**last\_updated\_at** `timing.v1.Timestamp` *required*

When the appointment was last updated

```json CEL theme={null}
$result_object_key.last_updated_at
```

```json Example theme={null}
"2024-01-23T10:21:17Z"
```

**price** `float64 (double)`

Price of the appointment (USD)

```json CEL theme={null}
$result_object_key.price
```

```json Example theme={null}
150
```

**invoice\_id** `string`

ID of the invoice associated with the appointment

```json CEL theme={null}
$result_object_key.invoice_id
```

```json Example theme={null}
"65fdd9e89c7e50a54b3090ae"
```

**invoice\_number** `int64`

Invoice number associated with the appointment

```json CEL theme={null}
$result_object_key.invoice_number
```

```json Example theme={null}
168
```

**client\_note** `string`

Client Note

```json CEL theme={null}
$result_object_key.client_note
```

```json Example theme={null}
"(905) 875-7338"
```

**practitioner\_note** `string`

Note provided by the practitioner

```json CEL theme={null}
$result_object_key.practitioner_note
```

```json Example theme={null}
"Patient needs to complete intake form"
```

**full\_cancellation\_reason** `string`

Full reason for appointment cancellation

```json CEL theme={null}
$result_object_key.full_cancellation_reason
```

```json Example theme={null}
"Patient requested cancellation due to being cured"
```

**cancellation\_reason\_note** `string`

Additional notes about the cancellation

```json CEL theme={null}
$result_object_key.cancellation_reason_note
```

```json Example theme={null}
"Patient will reschedule next week"
```

**cancelled\_at** `timing.v1.Timestamp`

If cancelled: when the appointment was cancelled

```json CEL theme={null}
$result_object_key.cancelled_at
```

```json Example theme={null}
"2024-01-22T15:30:00Z"
```

**attendance\_confirmation\_response** `string`

Response to the attendance confirmation request

```json CEL theme={null}
$result_object_key.attendance_confirmation_response
```

```json Example theme={null}
"The confirmation response for the appt. (None, Confirmed, Cancelled)"
```

**additional\_clients** `[]object` *required*

Additional clients associated with the appointment

```json CEL theme={null}
$result_object_key.additional_clients
```

```json Example theme={null}
[
{
"client_id": 42,
"email_address": "ettore@bugatti.com",
"name": "Ettore Bugatti",
"phone_number": "5554016515"
}
]
```

**additional\_clients.map(x, x.client\_id)** `[]int64` *required*

Mapped array of: IntakeQ's unique identifier for the client

```json CEL theme={null}
$result_object_key.additional_clients.map(x, x.client_id)
```

```json Example theme={null}
[
42
]
```

**additional\_clients.map(x, x.name)** `[]string` *required*

Mapped array of: Full name of the client

```json CEL theme={null}
$result_object_key.additional_clients.map(x, x.name)
```

```json Example theme={null}
[
"Ettore Bugatti"
]
```

**additional\_clients.map(x, x.email\_address)** `[]string` *required*

Mapped array of: Email address of the client

```json CEL theme={null}
$result_object_key.additional_clients.map(x, x.email_address)
```

```json Example theme={null}
[
"ettore@bugatti.com"
]
```

**additional\_clients.map(x, x.phone\_number)** `[]string` *required*

Mapped array of: Primary phone number of the client

```json CEL theme={null}
$result_object_key.additional_clients.map(x, x.phone_number)
```

```json Example theme={null}
[
"5554016515"
]
```

**invitation** `string`

Telehealth invitation text, may include the meeting link and password

```json CEL theme={null}
$result_object_key.invitation
```

```json Example theme={null}
"Please join the video call using the link below: ...."
```

**appointment\_meeting\_join\_url** `string`

URL to join telehealth meeting if applicable

```json CEL theme={null}
$result_object_key.appointment_meeting_join_url
```

```json Example theme={null}
"https://example.com/meeting/123456"
```

**intake\_id** `string`

ID of the intake form associated with the appointment, if any

```json CEL theme={null}
$result_object_key.intake_id
```

```json Example theme={null}
"00000000-0000-0000-0000-000000000000"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.