listProviders( )

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 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.

Admin Method

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

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings - all permissions
Manage External Calendars
Learn more about permission scopes.
Method Declaration
This method does not take any parameters
Return Type:Promise<ListProvidersResponse>
Was this helpful?