GET

List Schedule Time Frames


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.
Endpoint
GET
https://www.wixapis.com/calendar/v3/schedules/timeframe

Query Params
idsArray <string>Required

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

Min: 1 schedule ID Max: 100 schedule IDs


timeZonestring

Time zone for adjusting the times of the returned schedule time frames.

Default: timeZone of the site properties

Response Object
scheduleTimeFramesArray <ScheduleTimeFrame>

Retrieved schedule time frames.

List Schedule Time Frames
Request
cURL
curl -X GET \ 'https://www.wixapis.com/calendar/v3/schedules/timeframe?ids=bac52132-220a-4361-8bd4-2a884af45eb6&ids=ea54fba1-8bad-4d1a-992a-a0fc772c6b46' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "scheduleTimeFrames": [ { "id": "bac52132-220a-4361-8bd4-2a884af45eb6", "status": "INFINITE", "firstEventStartDate": { "localDate": "2024-10-07T17:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T16:00:00Z" }, "adjustedFirstEventStartDate": { "localDate": "2024-10-07T17:00:00", "timeZone": "Europe/Dublin" }, "revision": "4" }, { "id": "ea54fba1-8bad-4d1a-992a-a0fc772c6b46", "status": "INFINITE", "firstEventStartDate": { "localDate": "2024-10-07T16:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-10-07T15:00:00Z" }, "adjustedFirstEventStartDate": { "localDate": "2024-10-07T16:00:00", "timeZone": "Europe/Dublin" }, "revision": "4" } ] }
Errors

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

Did this help?