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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
connectionIdstringRequired

ID of the external calendar connection to list calendars for.

Returns
Return Type:Promise<ListCalendarsResponse>
List calendars belonging to an external calendar account
JavaScript
Errors

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

Did this help?