listCalendars( )

Developer Preview

Retrieves a list of calendars belonging to the connected external calendar account.

Description

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

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Syntax

function listCalendars(connectionId: string): Promise<ListCalendarsResponse>

listCalendars Parameters

NAME

TYPE

DESCRIPTION

connectionId

string

ID of the external calendar connection to list calendars for.

Returns

Return Type:

Promise<

ListCalendarsResponse

NAME

TYPE

DESCRIPTION

calendars

Array<

Calendar

List of calendars belonging to the external calendar account.

Was this helpful?

List calendars belonging to an external calendar account

Copy Code

1import {externalCalendars} from 'wix-bookings.v2';
2
3async function listCalendars(connectionId) {
4    const {calendars} = await externalCalendars.listCalendars(connectionId)
5    return calendars
6}