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.
Query containing filters and paging.
Information about which fields containing personal data to return. Refer to the permissions article for more information.
Supported values:
PI_FIELDS
: Returns all fields with personal data. Your app must have Read Calendars - Including PI
or Manage Calendars
permission scope.OWN_PI_FIELDS
: Returns only fields containing your own personal data.Max: 1 field Default: No personal data is returned.
Retrieved schedules matching the provided query.
Paging metadata.
curl -X POST \
'https://www.wixapis.com/calendar/v3/schedules/query' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{
"schedules": [
{
"id": "132db383-1378-4903-820b-4eebf4242de2",
"externalId": "4187d1f3-38a2-4cfd-b8f1-6333cd012e33",
"name": "Hip Hop Groove",
"status": "ACTIVE",
"timeZone": "Europe/Dublin",
"businessTimeZoneEnabled": true,
"defaultTitle": "Hip Hop Groove",
"defaultLocation": {
"type": "BUSINESS"
},
"defaultCapacity": 50,
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"permissions": [],
"revision": "1",
"createdDate": "2024-10-06T17:16:35.344Z",
"updatedDate": "2024-10-06T17:16:35.344Z"
},
{
"id": "37e01b7f-7137-4c06-bca5-02eb435c1503",
"externalId": "38e25e56-d50f-42b4-a3b6-aa04c61dded1",
"name": "Full Body Strength",
"status": "ACTIVE",
"timeZone": "Europe/Dublin",
"businessTimeZoneEnabled": true,
"defaultTitle": "Full Body Strength",
"defaultLocation": {
"type": "BUSINESS"
},
"defaultCapacity": 50,
"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97",
"permissions": [],
"revision": "1",
"createdDate": "2024-10-06T17:16:35.386Z",
"updatedDate": "2024-10-06T17:16:35.386Z"
}
],
"pagingMetadata": {
"count": 2,
"hasNext": false
}
}
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.