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

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

1{
2        "inputs": [
3        {
4        "resourceId": "0Hnxx000000DAxx0AG",
5        "resourceType": "Provider",
6        "serviceTerritoryId": "0Hhxx000000Efxx0AK",
7        "serviceResourceId": "0Hnxx000000DAxx0AG",
8        "assetCategory": "",
9        "startDate": "2026-07-15T00:00:00Z",
10        "endDate": "2026-07-16T00:00:00Z",
11        "workTypeId": "08qxx0000009cxxYAA",
12        "channelId": "0eFxx000000Mexx2AK",
13        "sourceSystem": "Salesforce",
14        "serviceCategories": [],
15        "serviceTypes": [],
16        "appointmentTypes": []
17        }
18        ]
19        }

Sample Response

1[
2        {
3        "availableSlots": [
4        {
5        "slotId": "slot-xyz-1",
6        "slotStartDate": "2026-07-15T11:00:00.000Z",
7        "slotEndDate": "2026-07-15T11:30:00.000Z",
8        "sourceSystem": "Salesforce"
9        },
10        {
11        "slotId": "slot-xyz-2",
12        "slotStartDate": "2026-07-15T14:30:00.000Z",
13        "slotEndDate": "2026-07-15T15:00:00.000Z",
14        "sourceSystem": "Salesforce"
15        }
16        ]
17        }
18        ]