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

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

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

Outputs

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

Example

Sample request body:

{
  "inputs" : [{
    "serviceAppointmentId" : "08p000000000001AAA",
    "operatingHoursId" : "0OH000000000001AAA",
    "schedulingPolicyId" : "0Vr000000000001AAA",
    "timeZoneName" : "America/Los_Angeles"
  }]
}

Sample response body:

{
  "actionName" : "getAppointmentBookingSlots",
  "errors" : null,
  "isSuccess" : true,
  "outputValues" : {
    "availableSlots" : "[{\"startTime\":\"2026-08-28T17:00:00.000Z\",\"endTime\":\"2026-08-28T18:00:00.000Z\"}]"
  }
}