Retrieves a list of events from all external calendar accounts, based on the provided filtering and paging.
You must filter by specifying both from and to dates, unless you specify
cursorPaging.cursor.
Additionally, you can specify scheduleIds or userIds to further limit
which events are returned. By default, events related to all schedules and
Wix users are returned.
Returned events are sorted by start date in ascending order. You can't adjust the sorting.
By default, the following event fields aren't returned:
calendarName.title.scheduleOwnerName.You can retrieve these fields, by specifying {"fieldsets": "OWN_PI"}.
By default, the call fails if events for at least 1 connection can't be
retrieved from an external provider. However, you can specify
{"partialFailure": true} to allow the call to succeed, if details for at
least 1 connection can be retrieved.
You can only call this method when authenticated as a Wix app or Wix user identity.
Date and time from which to retrieve events,
formatted according to RFC 3339.
Required, unless cursorPaging.cursor is provided.
Events which start before the from time and end after it are included in the returned list.
Date and time until which to retrieve events,
formatted according to RFC 3339.
Required, unless cursorPaging.cursor is provided.
Events which start before the to time and end after it are included in the returned list.
Schedule IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to the specified schedules. Maximum of 100 schedule IDs per request.
Wix user IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to schedules belonging to the specified Wix users. Maximum of 100 Wix user IDs per request.
Whether to include only all-day events in the returned list.
If true, only all-day events are returned.
If false, only events with a specified time are returned.
Default: All events are returned.
Predefined sets of fields to return.
NO_PI: Returns event objects without personal information.OWN_PI: Returns complete event objects, including personal information.Default: NO_PI
Number of events to load.
Max: 1000
Pointer to the next or previous page in the list of results.
You can get the relevant cursor token
from the pagingMetadata object in the previous call's response.
Not relevant for the first request.
Whether to return a partial list of events if details can't be retrieved for some connections.
Default: false
List of external calendar events matching the filters.
Paging metadata.
List of provider IDs for connections for which retrieval of events failed. Returned only if partialFailure body parameter is true in the request.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.