> 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`). > - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # ListConnections # Package: conferencing # Namespace: ConferencingProvider # Method link: https://dev.wix.com/docs/api-reference/business-management/calendar/conferencing/conferencing-provider-v1/list-connections.md ## Introduction Retrieves the connections your implementation stores, optionally filtered by resource. Wix calls this method on demand to read the current connection state. Your implementation owns and stores connections; Wix doesn't persist them. Wix uses the returned connections to show connection status. When a conference is requested without a provider, Wix uses the connection with the most recent `connectedDate` across all providers. *Your implementation should:** - Return all connections you store for the given `resourceIds`, or all connections when none are specified. - Set `connectedDate` on every connection you return. Wix ignores connections without it. *Error handling:** If your implementation returns an error, Wix leaves your provider's connections out of the results instead of failing the request. --- ## REST API ### Schema ``` Method: listConnections Description: Retrieves the connections your implementation stores, optionally filtered by resource. Wix calls this method on demand to read the current connection state. Your implementation owns and stores connections; Wix doesn't persist them. Wix uses the returned connections to show connection status. When a conference is requested without a provider, Wix uses the connection with the most recent `connectedDate` across all providers. *Your implementation should:** - Return all connections you store for the given `resourceIds`, or all connections when none are specified. - Set `connectedDate` on every connection you return. Wix ignores connections without it. *Error handling:** If your implementation returns an error, Wix leaves your provider's connections out of the results instead of failing the request. URL: {DEPLOYMENT-URI}/v1/list-connections Method: POST Method parameters: param name: resourceIds | type: array | description: IDs of the resources to return connections for. When empty, return all connections you store. | validation: maxItems 100, format GUID Return type: ListConnectionsResponse - name: connections | type: array | description: Connections you store for the requested resources. - name: id | type: string | description: Connection GUID. Generate a stable, unique GUID for the connection. Wix passes it back to reference the connection later. | read-only: true | validation: format GUID - name: status | type: ConnectionStatus | description: Connection status. - enum: - CONNECTED: The connection is usable now. - DISCONNECTED: The user or your implementation intentionally disconnected the account. - ERROR: The connection was established but is now broken, for example tokens were revoked or expired externally, and needs reconnection. - name: email | type: string | description: Email associated with the connection. | validation: maxLength 320 - name: connectionMethod | type: ConnectionMethod | description: Method used to establish this connection. - enum: - OAUTH: OAuth authorization flow. - CREDENTIALS: Username and password authentication. - name: connectedDate | type: string | description: Date and time the connection was established, in UTC. Set this on every connection you store. Wix ignores connections without it. | read-only: true | validation: format date-time - name: resourceId | type: string | description: GUID of the resource this connection belongs to. Treat it as an opaque, stable Wix identifier. Replaces `accountOwnerId`. | validation: format GUID ``` ### Examples ### List a resource's connections Wix sends the request payload as an encoded JWT. For the purposes of this example, we show the request and response objects decoded. ```curl curl -X POST \ 'https://my-conferencing.example.com/v1/list-connections' \ -H 'user-agent: Wix' \ -H 'Content-Type: text/plain; charset=utf-8' \ -d '{ "resourceIds": [ "a1f3c9e2-6b7d-4e58-9c0a-2d4b8e7f1356" ] }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.calendar.conferencingProvider.listConnections(request, metadata) Description: Retrieves the connections your implementation stores, optionally filtered by resource. Wix calls this method on demand to read the current connection state. Your implementation owns and stores connections; Wix doesn't persist them. Wix uses the returned connections to show connection status. When a conference is requested without a provider, Wix uses the connection with the most recent `connectedDate` across all providers. *Your implementation should:** - Return all connections you store for the given `resourceIds`, or all connections when none are specified. - Set `connectedDate` on every connection you return. Wix ignores connections without it. *Error handling:** If your implementation returns an error, Wix leaves your provider's connections out of the results instead of failing the request. Method parameters: param name: metadata | type: Context | description: this message is not directly used by any service, it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform. e.g. SPIs, event-handlers, etc.. NOTE: this context object MUST be provided as the last argument in each Velo method signature. Example: ```typescript export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) { ... } ``` - name: requestId | type: string | description: A unique identifier of the request. You may print this GUID to your logs to help with future debugging and easier correlation with Wix's logs. - name: currency | type: string | description: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code. | validation: format CURRENCY - name: identity | type: IdentificationData | description: An object that describes the identity that triggered this request. - ONE-OF: - name: anonymousVisitorId | type: string | description: GUID of a site visitor that has not logged in to the site. | validation: format GUID - name: memberId | type: string | description: GUID of a site visitor that has logged in to the site. | validation: format GUID - name: wixUserId | type: string | description: GUID of a Wix user (site owner, contributor, etc.). | validation: format GUID - name: appId | type: string | description: GUID of an app. | validation: format GUID - name: languages | type: array | description: A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`. - name: instanceId | type: string | description: The service provider app's instance GUID. | validation: format GUID param name: request | type: ListConnectionsRequest - name: resourceIds | type: array | description: IDs of the resources to return connections for. When empty, return all connections you store. | validation: maxItems 100, format GUID Return type: PROMISE - name: connections | type: array | description: Connections you store for the requested resources. - name: _id | type: string | description: Connection GUID. Generate a stable, unique GUID for the connection. Wix passes it back to reference the connection later. | read-only: true | validation: format GUID - name: status | type: ConnectionStatus | description: Connection status. - enum: - CONNECTED: The connection is usable now. - DISCONNECTED: The user or your implementation intentionally disconnected the account. - ERROR: The connection was established but is now broken, for example tokens were revoked or expired externally, and needs reconnection. - name: email | type: string | description: Email associated with the connection. | validation: maxLength 320 - name: connectionMethod | type: ConnectionMethod | description: Method used to establish this connection. - enum: - OAUTH: OAuth authorization flow. - CREDENTIALS: Username and password authentication. - name: connectedDate | type: Date | description: Date and time the connection was established, in UTC. Set this on every connection you store. Wix ignores connections without it. | read-only: true - name: resourceId | type: string | description: GUID of the resource this connection belongs to. Treat it as an opaque, stable Wix identifier. Replaces `accountOwnerId`. | validation: format GUID ``` ### Examples ### List a resource's connections Returns the connections you store for the requested resources. ```javascript import { conferencingProvider } from "@wix/calendar/service-plugins"; conferencingProvider.provideHandlers({ listConnections: async (payload) => { const { request, metadata } = payload; const { resourceIds } = request; // Return the connections you store for `resourceIds`, or all connections when it's empty. return { connections: [ { _id: "c3e9a7b1-5d2f-4a86-9e14-7b0d2f6c8a53", status: conferencingProvider.ConnectionStatus.CONNECTED, connectionMethod: conferencingProvider.ConnectionMethod.OAUTH, connectedDate: new Date("2026-11-02T08:14:22.512Z"), resourceId: "a1f3c9e2-6b7d-4e58-9c0a-2d4b8e7f1356", }, ], }; }, }); /* Promise resolves to: * { * "connections": [ * { * "_id": "c3e9a7b1-5d2f-4a86-9e14-7b0d2f6c8a53", * "status": "CONNECTED", * "connectionMethod": "OAUTH", * "connectedDate": "2026-11-02T08:14:22.512Z", * "resourceId": "a1f3c9e2-6b7d-4e58-9c0a-2d4b8e7f1356" * } * ] * } */ ``` ### listConnections (self-managed) Self-managed 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 { conferencingProvider } from '@wix/calendar/service-plugins'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { conferencingProvider }, // Include the auth strategy and host as relevant }); async function listConnections(request,metadata) { const response = await myWixClient.conferencingProvider.listConnections(request,metadata); }; ``` ---