Search.../
  1. APIs

listProviders( )

Developer Preview

Retrieves a list of the external calendar providers for which the site supports integration.

Description

The list of external calendar providers includes:

  • External calendar providers that are supported by default, such as Google, Apple, and Microsoft.
  • External calenders for which the site owner has enabled integration by installing an app.

For each external calendar provider, the list contains information about supported connection methods and features. For each provider, check features.connectMethods to find out whether to use connectByCredentials() or connectByOAuth() to establish a connection.

Admin Method

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

Authorization

Request

This endpoint does not take any parameters

Response Object

NAME
TYPE
DESCRIPTION
providers
Array<
Provider
>

Retrieves a list of the external calendar providers for which the site supports integration.

The list of external calendar providers includes:

  • External calendar providers that are supported by default, such as Google, Apple, and Microsoft.
  • External calenders for which the site owner has enabled integration by installing an app.

For each external calendar provider, the list contains information about supported connection methods and features. For each provider, check features.connectMethods to find out whether to use connectByCredentials() or connectByOAuth() to establish a connection.

Status/Error Codes

Was this helpful?

List the supported external calendar providers

Copy Code
1import {externalCalendars} from 'wix-bookings.v2';
2

3async function listProviders() {
4    const {providers} = await externalCalendars.listProviders()
5    return providers
6}