listCalendars( )

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 calendars belonging to the connected external calendar account.

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 listCalendars(connectionId: string): Promise<ListCalendarsResponse>;
Method Parameters
connectionIdstringRequired

ID of the external calendar connection to list calendars for.

Returns
Return Type:Promise<ListCalendarsResponse>
JavaScript
import { externalCalendars } from "@wix/bookings";

async function listCalendars(connectionId) {
  const response = await externalCalendars.listCalendars(connectionId);
}
Errors
403Permission Denied

There is 1 error with this status code.

428Failed Precondition

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?