Get Slots Action

Retrieve available appointment slots for one or more resources.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

URI: /services/data/vXX.X/connect/health/appointment-management/slots

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

Outputs

Output	Type	Description
`resourceSlotDetails`	Array	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]