> 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

# GetConnection

# Package: calendar

# Namespace: ExternalCalendarService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/bookings/calendar/external-calendar-v2/get-connection.md

## Permission Scopes:
Manage External Calendars: SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
Manage External Calendars: SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS

## Introduction

Retrieves an external calendar connection by ID.


The `syncConfig` property contains configuration details about event import
from and event export to the external calendar.

---

## REST API

### Schema

```
 Method: getConnection
 Description: Retrieves an external calendar connection by GUID.   The `syncConfig` property contains configuration details about event import from and event export to the external calendar.
 URL: https://www.wixapis.com/bookings/v2/external-calendars/connections/{connectionId}
 Method: GET
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  connectionId
 Method parameters: 
   param name: connectionId | type:   none | required: true
 Return type: GetConnectionResponse
  - name: connection | type: Connection | description: Retrieved external calendar connection. 
     - name: id | type: string | description: GUID of the connection between the external calendar and the Wix site. 
     - name: providerId | type: string | description: GUID of the external calendar provider. 
     - name: calendarType | type: CalendarType | description: External calendar 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: scheduleId | type: string | description: GUID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) that's connected to the external calendar. 
     - name: userId | type: string | description: GUID of the [Wix user](https://dev.wix.com/docs/rest/articles/getting-started/about-identities.md#wix-user) to whom the external calendar connection belongs. 
     - name: appId | type: string | description: GUID of the app which created the external calendar connection. 
     - name: externalAccountEmail | type: string | description: Email address associated with the external calendar account. Available only after completed successfully. 
     - name: status | type: Status | description: Connection status. 
         - enum:
         -     UNDEFINED: There is no information about the connection status.
         -     CONNECTED: The external calendar is connected to the Wix [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md), but the sync process hasn't started yet.
         -     SYNC_IN_PROGRESS: Sync process is ongoing.
         -     SYNCED: The Wix calendar and the external calendar are in sync.
         -     DISCONNECTED: The external calender has been disconnected from the Wix [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md).
         -     ERROR: The calendars sync is in error state.
     - name: errorReason | type: ErrorReason | description: Reason for the error. Available only if `status` is `ERROR`. 
         - enum:
         -     UNDEFINED: There is no information about the connection error.
         -     TOKEN_REVOKED: The external calendar's access token has been revoked.
         -     EXTERNAL_CALENDAR_CREATION_FAILED: The external calendar couldn't be created.
         -     EXTERNAL_CALENDAR_DELETED: The external calendar was deleted.
     - name: syncConfig | type: ConnectionSyncConfig | description: Settings about which sync operations are supported. 
        - name: listEventFromCalendars | type: ListEventFromCalendars | description: Configuration for importing events from the external calendar to the Wix site. 
           - ONE-OF: 
              - name: primaryCalendar | type: PrimaryCalendar | description: An empty `primaryCalendar` object indicates that you can import events only from the primary external calendar. Keep in mind that not all external calendar providers support primary calendars. 
       EMPTY-OBJECT {}
              - name: calendars | type: Calendars | description: You can import events from the list of specified external calendar accounts. The list may include the primary calendar. 
                 - name: calendars | type: array<Calendar> | description:  
                    - name: id | type: string | description: GUID of the external calendar account. 
                    - name: name | type: string | description: Display name of the external calendar account. For example, `Primary` or `Birthdays`. 
           - name: enabled | type: boolean | description: Whether you can call [List Events](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/list-events.md) to import events from the external calendar to the Wix site. 
        - name: syncToCalendar | type: SyncToCalendar | description: Configuration for exporting events from the Wix site to the external calendar. 
           - ONE-OF: 
              - name: primaryCalendar | type: PrimaryCalendar | description: An empty `primaryCalendar` object indicates that Wix events are exported only to the primary account of the external calendar. 
              - name: dedicatedCalendar | type: DedicatedCalendar | description: An empty `dedicatedCalendar` object indicates that Wix events are exported only to the dedicated account of the external calendar. 
       EMPTY-OBJECT {}
           - name: enabled | type: boolean | description: Whether Wix [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) are exported to the external calendar. 


```

### Examples

### Get an external calendar connection by ID
```curl
curl -X GET 'https://www.wixapis.com/bookings/v2/external-calendars/connections/4WnvD8QzxhkAjVPBKUCvLIMpbuuUCMID7rYhqOpIGDae9JYyQj0JS71sdJukve86B38sWvS6TOvMQqBxszjEMN7MfiUjvCwgx0inoCXpg7JpM0QXmxYW4E2dXHAmKaNKk4M5jez8KwwxQxUNygYrvR0V08GW0weMqwMW1GYslMM1kVPcGuiwqJ7' \
-H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.calendar.ExternalCalendarService.getConnection(connectionId)
 Description: Retrieves an external calendar connection by GUID.   The `syncConfig` property contains configuration details about event import from and event export to the external calendar.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  connectionId
 Method parameters: 
   param name: connectionId | type: string | description: GUID of the connection to retrieve. | required: true
 Return type: PROMISE<GetConnectionResponse>
  - name: connection | type: Connection | description: Retrieved external calendar connection. 
     - name: _id | type: string | description: GUID of the connection between the external calendar and the Wix site. 
     - name: providerId | type: string | description: GUID of the external calendar provider. 
     - name: calendarType | type: CalendarType | description: External calendar 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: scheduleId | type: string | description: GUID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md) that's connected to the external calendar. 
     - name: userId | type: string | description: GUID of the [Wix user](https://dev.wix.com/docs/rest/articles/getting-started/about-identities.md#wix-user) to whom the external calendar connection belongs. 
     - name: appId | type: string | description: GUID of the app which created the external calendar connection. 
     - name: externalAccountEmail | type: string | description: Email address associated with the external calendar account. Available only after completed successfully. 
     - name: status | type: Status | description: Connection status. 
         - enum:
         -     UNDEFINED: There is no information about the connection status.
         -     CONNECTED: The external calendar is connected to the Wix [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md), but the sync process hasn't started yet.
         -     SYNC_IN_PROGRESS: Sync process is ongoing.
         -     SYNCED: The Wix calendar and the external calendar are in sync.
         -     DISCONNECTED: The external calender has been disconnected from the Wix [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction.md).
         -     ERROR: The calendars sync is in error state.
     - name: errorReason | type: ErrorReason | description: Reason for the error. Available only if `status` is `ERROR`. 
         - enum:
         -     UNDEFINED: There is no information about the connection error.
         -     TOKEN_REVOKED: The external calendar's access token has been revoked.
         -     EXTERNAL_CALENDAR_CREATION_FAILED: The external calendar couldn't be created.
         -     EXTERNAL_CALENDAR_DELETED: The external calendar was deleted.
     - name: syncConfig | type: ConnectionSyncConfig | description: Settings about which sync operations are supported. 
        - name: listEventFromCalendars | type: ListEventFromCalendars | description: Configuration for importing events from the external calendar to the Wix site. 
           - ONE-OF: 
              - name: calendars | type: Calendars | description: You can import events from the list of specified external calendar accounts. The list may include the primary calendar. 
                 - name: calendars | type: array<Calendar> | description:  
                    - name: _id | type: string | description: GUID of the external calendar account. 
                    - name: name | type: string | description: Display name of the external calendar account. For example, `Primary` or `Birthdays`. 
           - name: enabled | type: boolean | description: Whether you can call [List Events](https://dev.wix.com/docs/rest/business-solutions/bookings/calendar/external-calendar-v2/list-events.md) to import events from the external calendar to the Wix site. 
        - name: syncToCalendar | type: SyncToCalendar | description: Configuration for exporting events from the Wix site to the external calendar. 
           - name: enabled | type: boolean | description: Whether Wix [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction.md) are exported to the external calendar. 


```

### Examples

### getConnection
```javascript
import { externalCalendars } from '@wix/bookings';

async function getConnection(connectionId) {
  const response = await externalCalendars.getConnection(connectionId);
};
```

### getConnection (with elevated permissions)
```javascript
import { externalCalendars } from '@wix/bookings';
import { auth } from '@wix/essentials';

async function myGetConnectionMethod(connectionId) {
  const elevatedGetConnection = auth.elevate(externalCalendars.getConnection);
  const response = await elevatedGetConnection(connectionId);
}
```

### getConnection (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 getConnection(connectionId) {
  const response = await myWixClient.externalCalendars.getConnection(connectionId);
};
```

---