Get Appointment Slots Action

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

Input	Type	Description
appointmentTypes	Array	Types of appointments available for selection.
assetCategory	String	Category of the asset. Used only when the resource type is Asset.
channelId	String	Required ID of the engagement channel.
endDate	String	Required Ending date and time for the slot search in ISO 8601 format. Must be after the start date.
resourceId	ID	Required ID of the healthcare provider or asset for the appointment search.
resourceType	String	Required Type of resource, such as Provider or Asset. The default value is Provider.
serviceCategories	Array	Service categories associated with the appointment.
serviceResourceId	ID	ID of the service resource associated with the appointment.
serviceTerritoryId	ID	ID of the location, such as the service territory for a provider or the account for an asset.
serviceTypes	Array	Service types associated with the appointment.
sourceSystem	String	Source system where the appointment slots originate.
startDate	String	Required Beginning date and time for the slot search in ISO 8601 format (for example, 2026-07-15T00:00:00Z).
workTypeId	String	Required ID of the work type. Required unless service categories, service types, or appointment types are provided.

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"
        }
        ]
        }
        ]