GET

Get Schedule Time Frame


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 schedule time frame by schedule ID.

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/{id}

Path Params
idstringRequired

Schedule ID for which to retrieve the schedule time frame.

Query Params
timeZonestring

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

Default: timeZone of the site properties

Response Object
scheduleTimeFrameScheduleTimeFrame

Retrieved schedule time frame.

Get Schedule Time Frame
Request
cURL
curl -X GET \ 'https://www.wixapis.com/calendar/v3/schedules/timeframe/05279386-2859-49d6-9727-0096ad74e014' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "scheduleTimeFrame": { "id": "05279386-2859-49d6-9727-0096ad74e014", "status": "FINITE", "firstEventStartDate": { "localDate": "2024-09-24T16:30:00", "timeZone": "Europe/Dublin", "utcDate": "2024-09-24T15:30:00Z" }, "lastEventEndDate": { "localDate": "2024-11-27T17:00:00", "timeZone": "Europe/Dublin", "utcDate": "2024-11-27T17:00:00Z" }, "adjustedFirstEventStartDate": { "localDate": "2024-09-24T16:30:00", "timeZone": "Europe/Dublin" }, "adjustedLastEventEndDate": { "localDate": "2024-11-27T17:00:00", "timeZone": "Europe/Dublin" }, "revision": "15" } }
Errors

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

Did this help?