listScheduleTimeFrames( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of schedule time frames by schedule IDs.

Sorted by schedule ID in ascending order.

Permissions
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Read Bookings Calendar Availability
Read bookings calendar - including participants
Read Bookings Calendar
Manage Calendars
Read Calendar - Including PI
Read Calendar
Learn more about app permissions.
Method Declaration
Copy
function listScheduleTimeFrames(
  ids: Array<string>,
  options: ListScheduleTimeFramesOptions,
): Promise<ListScheduleTimeFramesResponse>;
Method Parameters
idsArray<string>Required

IDs of the schedules for which to retrieve schedule time frames.

Min: 1 schedule ID Max: 100 schedule IDs

optionsListScheduleTimeFramesOptions
Returns
Return Type:Promise<ListScheduleTimeFramesResponse>
JavaScript
import { scheduleTimeFrames } from "@wix/calendar";

async function listScheduleTimeFrames(ids, options) {
  const response = await scheduleTimeFrames.listScheduleTimeFrames(
    ids,
    options,
  );
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?