GET

List Connections

Retrieves a list of external calendar connections.

Filter

You can filter by schedule ID (SDK | REST).

Partial success

By default, the call fails if details for at least 1 connection can't be retrieved from the external provider. However, you can specify {"partialFailure": true} to allow the call to succeed, if details for at least 1 connection can be retrieved.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/bookings/v2/external-calendars/connections
Query Params
scheduleIdsArray <string>

Schedule IDs (SDK | REST) to filter by.

Default: Returns all connections.

partialFailureboolean

Whether to return a partial list of connections if details can't be retrieved for all connections.

Default: false

Response Object
connectionsArray <Connection>

Retrieved external calendar connections.

failedProviderIdsArray <string>

List of provider IDs for which connection retrieval failed. Returned only if you specify {"partialFailure": true}.

Request
cURL
Response
JSON
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?