GET

List Events


Retrieves a list of events from all external calendar accounts, based on the provided filtering and paging.

Filters

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.

Sorting

Returned events are sorted by start date in ascending order. You can't adjust the sorting.

Personal data

By default, the following event fields aren't returned:

  • calendarName.
  • title.
  • scheduleOwnerName.

You can retrieve these fields, by specifying {"fieldsets": "OWN_PI"}.

Partial success

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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/bookings/v2/external-calendars/events

Errors

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

Did this help?