listConnections( )

Developer Preview

Retrieves a list of external calendar connections.

Description

Each external calendar connections contain details of a connection between a Wix site's calendar and calendars hosted by an external provider.

The syncConfig property of each connection contains configuration details for importing events from an external calendar, exporting events to an external calendar, or both.

Admin Method

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

Syntax

function listConnections(options: ListConnectionsOptions): Promise<ListConnectionsResponse>

listConnections Parameters

NAME

TYPE

DESCRIPTION

options

Optional

ListConnectionsOptions

Returns

Return Type:

Promise<

ListConnectionsResponse

NAME

TYPE

DESCRIPTION

connections

Array<

Connection

List of external calendar connections.

failedProviderIds

Array<

string

List of provider IDs for connections for which retrieval failed. Returned only if partialFailure parameter is true in the request.

Was this helpful?

List all connections

Copy Code

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

List connections by schedule ID

Copy Code

1import {externalCalendars} from 'wix-bookings.v2';
2
3async function listConnections(scheduleId) {
4    const options = {
5        scheduleId
6    }
7    const {connections} = await externalCalendars.listConnections(options)
8    return connections
9}