listEvents( )

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 events from all connected external calendars, based on the provided filtering and paging.

Use List Events to retrieve an aggregated list of events in the connected external calendars for a specified time range, sorted by start date.

Note: Before using this function, establish a connection with an external calendar using connectByCredentials() or connectByOAuth().

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Method Declaration
Copy
function listEvents(options: ListEventsOptions): Promise<ListEventsResponse>;
Method Parameters
optionsListEventsOptions
Returns
Return Type:Promise<ListEventsResponse>
JavaScript
import { externalCalendars } from "@wix/bookings";

async function listEvents(options) {
  const response = await externalCalendars.listEvents(options);
}
Errors

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

Did this help?