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 external calendar connections.
Each external calendar connections contains 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.
You can only call this method when authenticated as a Wix app or Wix user identity.
Schedule IDs to filter by. If provided, only connections between external calendars and the specified schedules is returned.
Default: Returns all connections.
Whether to return a partial list of connections if details can't be retrieved for some connections.
Default: false
List of external calendar connections.
List of provider IDs for connections for which retrieval failed. Returned only if partialFailure body parameter is true in the request.
curl -X GET 'https://www.wixapis.com/bookings/v2/external-calendars/connections' \
-H 'Authorization: <AUTH>'{
"connections": [
{
"id": "4WnvD8QzxhkAjVPBKUCvLIMpbuuUCMID7rYhqOpIGDae9JYyQj0JS71sdJukve86B38sWvS6TOvMQqBxszjEMN7MfiUjvCwgx0inoCXpg7JpM0QXmxYW4E2dXHAmKaNKk4M5jez8KwwxQxUNygYrvR0V08GW0weMqwMW1GYslMM1kVPcGuiwqJ7",
"providerId": "9f084ae8-b3a6-4eb6-a29d-bc682c04b5fc",
"calendarType": "I_CAL",
"scheduleId": "100ef23e-9e92-4293-8e08-d3747537138f",
"userId": "f7f363b1-8ef8-4118-9612-0e6b3910745a",
"externalAccountEmail": "some@email.com",
"status": "CONNECTED",
"syncConfig": {
"listEventFromCalendars": {
"enabled": true,
"calendars": {
"calendars": [
{
"id": "2cnk4sgx4haqxbuz0sao0flxw"
},
{
"id": "4xve0tohyhnrlzy3lp4zf7b07"
},
{
"id": "a68yu6lp6584z66zorp19z1ab"
}
]
}
}
}
},
{
"id": "NKUjjvm8geI1xEEE6pU5of0blj4oIHvJy7M4KGCDHidQzOiHHWchOJ31inHqv3fCFo5mtX62Wp5PV4Kv5cTJRANJJbw1ukkwesjQVKeM7VAjq8ErrMDutLTq2dDvkUc0eFN36l3n1g45JWkAn1t8d",
"providerId": "6c533722-f1f9-4847-95c7-d4c4922ae9b0",
"calendarType": "GOOGLE",
"scheduleId": "b936298d-18a6-4ae8-8e9f-10bf49314c95",
"externalAccountEmail": "some-other@email.com",
"status": "SYNCED",
"syncConfig": {
"listEventFromCalendars": {
"enabled": true,
"primaryCalendar": {}
},
"syncToCalendar": {
"enabled": true,
"primaryCalendar": {}
}
}
}
]
}This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.