Get Slots Action | Salesforce Health Cloud Developer Guide

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI
/services/data/v66.0/connect/health/appointment-management/slots
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token

Inputs

Input	Details
appointmentTypes	Type Array Description Types of appointments to search such as `Follow-up`. Required, if none of the following are provided: workTypeId serviceTypes serviceCategories.
channelId	Type String Description ID of the engagement channel associated with the appointment. Required, if an engagement channel is configured for a Work Type.
endDate	Type String Description End date and time for the slot search range.
resources	Type Array Description Array of resource objects to find slots for.
serviceCategories	Type Array Description Category of service to find slots for. Required, if none of the following are provided: workTypeId serviceTypes appointmentTypes.
serviceTypes	Type Array Description Services types to find slots for. Required, if none of the following: workTypeId serviceCategories appointmentTypes.
sourceSystem	Type String Description Description of the external system defined in Salesforce, such as `cerner`. Required, if workTypeId is not provided.
startDate	Type String Description Required. Start date and time for the slot search range.
workTypeId	Type String Description ID of the Work Type associated with the desired appointment. Required, if none of the following are provided: serviceTypes serviceCategories appointmentTypes.

Outputs

Output	Description
resourceSlotDetails	Type Array Description List of resources and their corresponding available slots.

Example

POST

This sample request is for the Get Slots action.

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

This sample response is for the Get Slots action.

1[
2    {
3        "resourceSlotDetails": [
4            {
5                "resourceId": "0bSxx0000004pxx2AA",
6                "availableSlots": [
7                    {
8                        "slotId": "slot-xyz-1",
9                        "slotStartDate": "2025-07-14T11:00:00.000Z",
10                        "slotEndDate": "2025-07-14T11:30:00.000Z",
11                        "sourceSystem": "Salesforce"
12                    },
13                    {
14                        "slotId": "slot-xyz-2",
15                        "slotStartDate": "2025-07-14T14:30:00.000Z",
16                        "slotEndDate": "2025-07-14T15:00:00.000Z",
17                        "sourceSystem": "Salesforce"
18                    }
19                ]
20            }
21        ]
22    }
23]