---
schema_version: "1"
id: d0ecee3e1b58fb1ef58e2c1869adf238d39e2bbb21dede13071129255c67b270
title: Get Appointment Slots Action
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/hc_actions_get_appointment_slots.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/hc_actions_get_appointment_slots.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: ff256ff5bfe26ae3fed5d48f0f66c04616050131cb267c1b66662f054fb289b3
description: Get available appointment slots for healthcare providers or assets based on specified criteria. Calls the Get Appointment Slots Connect API.
---
# Get Appointment Slots Action

Get available appointment slots for healthcare providers or assets based on specified criteria. Calls the Get Appointment Slots Connect API.

This action is available in API version 68.0 and later.

## Supported REST HTTP Methods

**URI**: /services/data/vXX.X/actions/standard/getAppointmentSlots

Where XX.X is the latest API version.

**Formats**: JSON, XML

**HTTP Methods**: POST

**Authentication**: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

## Inputs

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d327904e100">Input</th>

              <th class="featureTableHeader  " id="d327904e103">Type</th>

              <th class="featureTableHeader  " id="d327904e106">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">appointmentTypes</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">Array</td>

              <td class="entry" headers="d327904e106" data-title="Description">Types of appointments available for selection.</td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">assetCategory</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">String</td>

              <td class="entry" headers="d327904e106" data-title="Description">Category of the asset. Used only when the resource type is
                <span class="keyword parmname">Asset</span>.
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">channelId</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">String</td>

              <td class="entry" headers="d327904e106" data-title="Description">Required<p class="p">ID of the engagement channel.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">endDate</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">String</td>

              <td class="entry" headers="d327904e106" data-title="Description">Required<p class="p">Ending date and time for the slot search in ISO 8601 format. Must be after
                  the start date.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">resourceId</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">ID</td>

              <td class="entry" headers="d327904e106" data-title="Description">Required<p class="p">ID of the healthcare provider or asset for the appointment search.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">resourceType</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">String</td>

              <td class="entry" headers="d327904e106" data-title="Description">Required<p class="p">Type of resource, such as <span class="keyword parmname">Provider</span> or
                  <span class="keyword parmname">Asset</span>. The default value is
                  <span class="keyword parmname">Provider</span>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">serviceCategories</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">Array</td>

              <td class="entry" headers="d327904e106" data-title="Description">Service categories associated with the appointment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">serviceResourceId</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">ID</td>

              <td class="entry" headers="d327904e106" data-title="Description">ID of the service resource associated with the appointment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">serviceTerritoryId</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">ID</td>

              <td class="entry" headers="d327904e106" data-title="Description">ID of the location, such as the service territory for a provider or the
                account for an asset.</td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">serviceTypes</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">Array</td>

              <td class="entry" headers="d327904e106" data-title="Description">Service types associated with the appointment.</td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">sourceSystem</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">String</td>

              <td class="entry" headers="d327904e106" data-title="Description">Source system where the appointment slots originate.</td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">startDate</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">String</td>

              <td class="entry" headers="d327904e106" data-title="Description">Required<p class="p">Beginning date and time for the slot search in ISO 8601 format (for
                  example, <span class="keyword parmname">2026-07-15T00:00:00Z</span>).</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d327904e100" data-title="Input">
                <span class="keyword parmname">workTypeId</span>
              </td>

              <td class="entry" headers="d327904e103" data-title="Type">String</td>

              <td class="entry" headers="d327904e106" data-title="Description">Required<p class="p">ID of the work type. Required unless service categories, service types, or
                  appointment types are provided.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Outputs

| Output | Type | Description |
| --- | --- | --- |
| availableSlots | Array | List of available appointment slots for the requested resource and date range. |

## Example

**Sample Request**

{
        "inputs": \[
        {
        "resourceId": "0Hnxx000000DAxx0AG",
        "resourceType": "Provider",
        "serviceTerritoryId": "0Hhxx000000Efxx0AK",
        "serviceResourceId": "0Hnxx000000DAxx0AG",
        "assetCategory": "",
        "startDate": "2026-07-15T00:00:00Z",
        "endDate": "2026-07-16T00:00:00Z",
        "workTypeId": "08qxx0000009cxxYAA",
        "channelId": "0eFxx000000Mexx2AK",
        "sourceSystem": "Salesforce",
        "serviceCategories": \[\],
        "serviceTypes": \[\],
        "appointmentTypes": \[\]
        }
        \]
        }

**Sample Response**

\[
        {
        "availableSlots": \[
        {
        "slotId": "slot-xyz-1",
        "slotStartDate": "2026-07-15T11:00:00.000Z",
        "slotEndDate": "2026-07-15T11:30:00.000Z",
        "sourceSystem": "Salesforce"
        },
        {
        "slotId": "slot-xyz-2",
        "slotStartDate": "2026-07-15T14:30:00.000Z",
        "slotEndDate": "2026-07-15T15:00:00.000Z",
        "sourceSystem": "Salesforce"
        }
        \]
        }
        \]