POST

Query Schedules

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 schedules, given the provided paging and filtering.

By default only ACTIVE schedules are returned, unless you provide a different status filter.

Currently, you can't sort the response.

Query schedules runs with these defaults, which you can override:

  • cursorPaging.limit is 50

For field support for filters, see Schedules V3: Supported Filters.

To learn about working with Query endpoints, see API Query Language and Sorting and Paging.

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
POST
https://www.wixapis.com/calendar/v3/schedules/query
Errors

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

Did this help?