listConnections( )

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsListConnectionsOptions

Options to use when listing connections.

Returns
Return Type:Promise<ListConnectionsResponse>
Errors

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

Did this help?