Get Service Appointment Time Slots

Retrieves available service appointment time slots based on the time zone, operating hours, scheduling policy and time zone name parameters.

This action is available in API version 62.0 and later.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/getAppointmentBookingSlots
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
serviceAppointmentId
Type
string
Description
Required. The ID of the service appointment to get available time slots for.
operatingHoursId
Type
string
Description
Required. The operating hours ID of the appointment to get time slots for.
schedulingPolicyId
Type
string
Description
Required. The scheduling policy ID of the appointment to get time slots for.
timeZoneName
Type
string
Description
Required. The name of the time zone to use when searching for and showing time slots.

Outputs

Output Details
availableSlots
Type
string
Description
The available time slots for the service appointment.

Example

Sample request body:

1{
2  "inputs" : [{
3    "serviceAppointmentId" : "08p000000000001AAA",
4    "operatingHoursId" : "0OH000000000001AAA",
5    "schedulingPolicyId" : "0Vr000000000001AAA",
6    "timeZoneName" : "America/Los_Angeles"
7  }]
8}

Sample response body:

1{
2  "actionName" : "getAppointmentBookingSlots",
3  "errors" : null,
4  "isSuccess" : true,
5  "outputValues" : {
6    "availableSlots" : "[{\"startTime\":\"2026-08-28T17:00:00.000Z\",\"endTime\":\"2026-08-28T18:00:00.000Z\"}]"
7  }
8}