POST

Query Schedules

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

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

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

PropertyFiltersSort
_id$eq, $inNone
externalId$eq, $inNone
appId$eq, $inNone
status$eq, $inNone
Permissions
Read Calendar
Read Calendar - Including PI
Learn more about app permissions.
Method Declaration
Copy
Errors

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

Did this help?