Get Slots Action

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.

{
    "inputs": [
        {
            "startDate": "2025-07-14T00:12:00.7912",
            "endDate": "2025-07-15T06:59:59.000Z",
            "channelId": "0eFxx000000Mexx2AK",
            "workTypeId": "08qxx0000009cxxYAA",
            "sourceSystem": "Salesforce",
            "resources": [
                {
                    "resourceId": "0bSxx0000004pxx2AA",
                    "serviceTerritoryId": "0Hhxx000000Efxx0AK",
                    "serviceResourceId": "0Hnxx000000DAxx0AG",
                    "resourceType": "Provider",
                    "assetCategory": ""
                }
            ],
            "appointmentTypes": [],
            "serviceCategories": [],
            "serviceTypes": []
        }
    ]
}

This sample response is for the Get Slots action.

[
    {
        "resourceSlotDetails": [
            {
                "resourceId": "0bSxx0000004pxx2AA",
                "availableSlots": [
                    {
                        "slotId": "slot-xyz-1",
                        "slotStartDate": "2025-07-14T11:00:00.000Z",
                        "slotEndDate": "2025-07-14T11:30:00.000Z",
                        "sourceSystem": "Salesforce"
                    },
                    {
                        "slotId": "slot-xyz-2",
                        "slotStartDate": "2025-07-14T14:30:00.000Z",
                        "slotEndDate": "2025-07-14T15:00:00.000Z",
                        "sourceSystem": "Salesforce"
                    }
                ]
            }
        ]
    }
]