> ## 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 Type

> Documentation for the Get Appointment Type action for Acuity

<img src="https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/acuity.svg?fit=max&auto=format&n=EU2WCxuXGIUQcziR&q=85&s=79bd07b287bc363d66588a4b8e013663" alt="images/acuity.svg" width="40" height="40" data-path="images/acuity.svg" />

# Parameters

<ResponseField name="Action" type="Parameters">
  <Expandable title="parameters" defaultOpen="true">
    <ResponseField name="Appointment Type ID" type="string" required>
      `ID`
      This field maps to the destination API `appointment_type_id` field.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```json Result Object Example theme={null}
  {
    "$result_object_key": {
      "active": true,
      "calendar_ids": [
        "7568038"
      ],
      "category": "Consultations",
      "description": "First consultation with a provider",
      "id": "38932233",
      "length_minutes": 30,
      "minutes_padding_after": 5,
      "minutes_padding_before": 5,
      "name": "Initial Visit",
      "private": false,
      "scheduling_url": "https://app.acuityscheduling.com/schedule.php?owner=27553604"
    }
  }
  ```
</RequestExample>

<ResponseExample>
  ```json Result Object Description theme={null}
  {
    "$result_object_key": {
      "active": "Whether the appointment type is deleted (true = active, false = deleted)",
      "calendar_ids": "List of calendar IDs associated with this appointment type",
      "category": "The category of the appointment type",
      "description": "Optional description of the appointment type",
      "id": "Unique identifier for the appointment type",
      "length_minutes": "Duration of the appointment type in minutes",
      "minutes_padding_after": "The time padding after the appointment",
      "minutes_padding_before": "The time padding before the appointment",
      "name": "The name of the appointment type",
      "private": "Whether the appointment type is private",
      "scheduling_url": "URL for scheduling this appointment type"
    }
  }
  ```
</ResponseExample>

### 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`.

<ResponseField name="AppointmentType" type="Fetch Action Response Object">
  <Expandable title="fields" defaultOpen="true">
    <ResponseField name="id" type="string" required>
      Unique identifier for the appointment type

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

      ```json Example theme={null}
      "38932233"
      ```
    </ResponseField>

    <ResponseField name="active" type="bool" required>
      Whether the appointment type is deleted (true = active, false = deleted)

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

      ```json Example theme={null}
      true
      ```
    </ResponseField>

    <ResponseField name="name" type="string" required>
      The name of the appointment type

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

      ```json Example theme={null}
      "Initial Visit"
      ```
    </ResponseField>

    <ResponseField name="description" type="string">
      Optional description of the appointment type

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

      ```json Example theme={null}
      "First consultation with a provider"
      ```
    </ResponseField>

    <ResponseField name="length_minutes" type="uint64" required>
      Duration of the appointment type in minutes

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

      ```json Example theme={null}
      30
      ```
    </ResponseField>

    <ResponseField name="category" type="string">
      The category of the appointment type

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

      ```json Example theme={null}
      "Consultations"
      ```
    </ResponseField>

    <ResponseField name="private" type="bool" required>
      Whether the appointment type is private

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

      ```json Example theme={null}
      false
      ```
    </ResponseField>

    <ResponseField name="minutes_padding_before" type="uint64" required>
      The time padding before the appointment

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

      ```json Example theme={null}
      5
      ```
    </ResponseField>

    <ResponseField name="minutes_padding_after" type="uint64" required>
      The time padding after the appointment

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

      ```json Example theme={null}
      5
      ```
    </ResponseField>

    <ResponseField name="calendar_ids" type="[]string" required>
      List of calendar IDs associated with this appointment type

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

      ```json Example theme={null}
      [
      "7568038"
      ]
      ```
    </ResponseField>

    <ResponseField name="scheduling_url" type="string">
      URL for scheduling this appointment type

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

      ```json Example theme={null}
      "https://app.acuityscheduling.com/schedule.php?owner=27553604"
      ```
    </ResponseField>
  </Expandable>
</ResponseField>