> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListProviders # Package: calendar # Namespace: ExternalCalendarService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/list-providers.md ## Permission Scopes: Manage External Calendars: SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS ## Introduction Retrieves a list of external calendar providers supported on the Wix site. 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 provider, check `features.connectMethods` to find out whether to use [Connect By Credentials](https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/connect-by-credentials.md) or [Connect By OAuth](https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/connect-by-o-auth.md) to establish a connection. --- ## REST API ### Schema ``` Method: listProviders Description: Retrieves a list of external calendar providers supported on the Wix site. 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 provider, check `features.connectMethods` to find out whether to use [Connect By Credentials](https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/connect-by-credentials.md) or [Connect By OAuth](https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/connect-by-o-auth.md) to establish a connection. URL: https://www.wixapis.com/bookings/v2/external-calendars/providers Method: GET Return type: ListProvidersResponse - name: providers | type: array | description: List of external calendar providers supported on the site. - name: id | type: string | description: GUID of the external calendar provider. - name: name | type: string | description: Name of the external calendar provider. - name: calendarType | type: CalendarType | description: External calendar provider type. - enum: - UNDEFINED: There is no information about the external calendar type. - GOOGLE: [Google Calendar](https://developers.google.com/calendar/api/guides/overview). - I_CAL: Apple iCalendar. - OUTLOOK: __Deprecated__. Use `MICROSOFT` instead. - OFFICE_365: __Deprecated__. Use `MICROSOFT` instead. - MICROSOFT: Microsoft Calendar. For example, Office 365 calendar or Outlook calendar. - OTHER: A different type of external calendar, not listed here. - name: features | type: ProviderFeatures | description: Information about how you can connect the external calendar to the Wix site, and which functionality it supports. - name: connectMethods | type: array | description: List of supported connection methods. - enum: - UNDEFINED: There is no information about how you can connect the external calendar to the Wix site. - OAUTH: You can connect the external calendar to the Wix site by calling [Connect By O Auth](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/connect-by-o-auth.md). - CREDENTIALS: You can connect the external calendar to the Wix site by calling [Connect By Credentials](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/connect-by-credentials.md). - name: updateSyncConfig | type: boolean | description: Whether you can update `syncConfic` for all external calendar connections by calling [Update Sync Config](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/update-sync-config.md). - name: listEventFromCalendars | type: ListEventFromCalendars | description: Information about which events you can import from the external calendar to the Wix site. - enum: - UNDEFINED: There is no information about which external calendar events you can import to the Wix site. - NOT_SUPPORTED: You can't import any events from the external calendar to the Wix site. - PRIMARY_CALENDAR_ONLY: You can import events only for the external calendar that's designated as primary. - SPECIFIC_CALENDARS: You can import events only for a specific external calendar account. You can call [List Calendars](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/list-calendars.md) to retrieve a complete list of external calendar accounts. - name: syncToCalendar | type: SyncToCalendar | description: Whether you can export Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) to the external calendar. - enum: - UNDEFINED: There is no information about which Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) you can export to the external calendar. - NOT_SUPPORTED: You can't export any Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) to the external calendar. - PRIMARY_CALENDAR_ONLY: You can export Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) only to the external calendar that's designated as primary. - SPECIFIC_CALENDAR: Events can be exported to specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. - DEDICATED_CALENDAR: You can export Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) only to a dedicated external calendar account. You can call [List Calendars](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/list-calendars.md) to retrieve a complete list of external calendar accounts. ``` ### Examples ### List the external calendar providers supported by a Wix site ```curl curl -X GET 'https://www.wixapis.com/bookings/v2/external-calendars/providers' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.calendar.ExternalCalendarService.listProviders() Description: Retrieves a list of external calendar providers supported on the Wix site. 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 provider, check `features.connectMethods` to find out whether to use [Connect By Credentials](https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/connect-by-credentials.md) or [Connect By OAuth](https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/connect-by-o-auth.md) to establish a connection. Return type: PROMISE - name: providers | type: array | description: List of external calendar providers supported on the site. - name: _id | type: string | description: GUID of the external calendar provider. - name: name | type: string | description: Name of the external calendar provider. - name: calendarType | type: CalendarType | description: External calendar provider type. - enum: - UNDEFINED: There is no information about the external calendar type. - GOOGLE: [Google Calendar](https://developers.google.com/calendar/api/guides/overview). - I_CAL: Apple iCalendar. - OUTLOOK: __Deprecated__. Use `MICROSOFT` instead. - OFFICE_365: __Deprecated__. Use `MICROSOFT` instead. - MICROSOFT: Microsoft Calendar. For example, Office 365 calendar or Outlook calendar. - OTHER: A different type of external calendar, not listed here. - name: features | type: ProviderFeatures | description: Information about how you can connect the external calendar to the Wix site, and which functionality it supports. - name: connectMethods | type: array | description: List of supported connection methods. - enum: - UNDEFINED: There is no information about how you can connect the external calendar to the Wix site. - OAUTH: You can connect the external calendar to the Wix site by calling [Connect By O Auth](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/connect-by-o-auth.md). - CREDENTIALS: You can connect the external calendar to the Wix site by calling [Connect By Credentials](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/connect-by-credentials.md). - name: updateSyncConfig | type: boolean | description: Whether you can update `syncConfic` for all external calendar connections by calling [Update Sync Config](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/update-sync-config.md). - name: listEventFromCalendars | type: ListEventFromCalendars | description: Information about which events you can import from the external calendar to the Wix site. - enum: - UNDEFINED: There is no information about which external calendar events you can import to the Wix site. - NOT_SUPPORTED: You can't import any events from the external calendar to the Wix site. - PRIMARY_CALENDAR_ONLY: You can import events only for the external calendar that's designated as primary. - SPECIFIC_CALENDARS: You can import events only for a specific external calendar account. You can call [List Calendars](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/list-calendars.md) to retrieve a complete list of external calendar accounts. - name: syncToCalendar | type: SyncToCalendar | description: Whether you can export Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) to the external calendar. - enum: - UNDEFINED: There is no information about which Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) you can export to the external calendar. - NOT_SUPPORTED: You can't export any Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) to the external calendar. - PRIMARY_CALENDAR_ONLY: You can export Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) only to the external calendar that's designated as primary. - SPECIFIC_CALENDAR: Events can be exported to specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. - DEDICATED_CALENDAR: You can export Wix calendar [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) only to a dedicated external calendar account. You can call [List Calendars](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/list-calendars.md) to retrieve a complete list of external calendar accounts. ``` ### Examples ### listProviders ```javascript import { externalCalendars } from '@wix/bookings'; async function listProviders() { const response = await externalCalendars.listProviders(); }; ``` ### listProviders (with elevated permissions) ```javascript import { externalCalendars } from '@wix/bookings'; import { auth } from '@wix/essentials'; async function myListProvidersMethod() { const elevatedListProviders = auth.elevate(externalCalendars.listProviders); const response = await elevatedListProviders(); } ``` ### listProviders (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { externalCalendars } from '@wix/bookings'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { externalCalendars }, // Include the auth strategy and host as relevant }); async function listProviders() { const response = await myWixClient.externalCalendars.listProviders(); }; ``` ---