> 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 # GetConference # Package: conferencing # Namespace: ConferencingService # Method link: https://dev.wix.com/docs/api-reference/business-management/calendar/conferencing/conference-v1/get-conference.md ## Permission Scopes: Manage_Wix_Rentals_App_Forms_submissions: SCOPE.RENTALS.MANAGE ## Introduction Retrieves a conference's details. --- ## REST API ### Schema ``` Method: getConference Description: Retrieves a conference's details. URL: https://www.wixapis.com/calendar/v3/conferences/v1/conferences/{conferenceId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: conferenceId Method parameters: query param name: appId | type: appId | description: GUID of the conferencing provider app that owns the conference being retrieved. | validation: format GUID param name: conferenceId | type: none | required: true query param name: resourceId | type: resourceId | description: GUID of the resource. When absent, the request targets the business resource (`4e0579a5-491e-4e70-a872-d097eed6e520`), a site-level account shared by the business. | validation: format GUID Return type: GetConferenceResponse - name: conference | type: Conference | description: Retrieved conference. - name: id | type: string | description: Conference GUID. Assigned by the conferencing provider. | read-only: true | validation: maxLength 100 - name: url | type: string | description: URL to join the conference. All participants use this URL to join. | read-only: true | validation: maxLength 2048 - name: hostUrl | type: string | description: URL for the host to start the conference. Returned only when the conferencing provider supplies a separate host URL, such as Zoom. | read-only: true | validation: maxLength 2048 - name: password | type: string | description: Password required to join the conference. | read-only: true | validation: maxLength 100 - name: title | type: string | description: Title or topic of the meeting. | validation: maxLength 500 - name: startTime | type: string | description: Scheduled start time of the meeting. | validation: format date-time - name: durationInMinutes | type: integer | description: Duration of the meeting in minutes. | validation: format int32 - name: timezone | type: string | description: Time zone for the meeting in IANA Time Zone Database format. For example, `America/New_York`. | validation: maxLength 100 - name: description | type: string | description: Human-readable description of the conference. For example, `Personal Zoom Room`. | validation: maxLength 500 - name: appId | type: string | description: GUID of the conferencing provider app that owns this conference. Matches the `id` of a provider returned by List Providers. | read-only: true | validation: format GUID - name: resourceId | type: string | description: GUID of the resource of the connection the conference was created with. If the request fell back to the site's default business resource (`4e0579a5-491e-4e70-a872-d097eed6e520`), that resource GUID appears here. | read-only: true | validation: format GUID Possible Errors: HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: PERMISSION_DENIED | Description: The identity used to call the method doesn't have the required permissions to manage this resource. HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: PROVIDER_NOT_FOUND | Description: Couldn't find the conferencing provider. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RESOURCE_NOT_CONNECTED | Description: The resource isn't connected to a conferencing provider. ``` ### Examples ### Get a conference Retrieves a Zoom conference's details. ```curl curl -X GET \ 'https://www.wixapis.com/calendar/v3/conferences/v1/conferences/84729105634?appId=c6d111d1-1a8d-49f0-a78c-4f1823fb6592&resourceId=a1f3c9e2-6b7d-4e58-9c0a-2d4b8e7f1356' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.calendar.conferencing.getConference(conferenceId, options) Description: Retrieves a conference's details. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: conferenceId Method parameters: param name: conferenceId | type: string | description: GUID of the conference to retrieve. | required: true | validation: maxLength 100 param name: options | type: GetConferenceOptions none - name: appId | type: string | description: GUID of the conferencing provider app that owns the conference being retrieved. | validation: format GUID - name: resourceId | type: string | description: GUID of the resource. When absent, the request targets the business resource (`4e0579a5-491e-4e70-a872-d097eed6e520`), a site-level account shared by the business. | validation: format GUID Return type: PROMISE - name: _id | type: string | description: Conference GUID. Assigned by the conferencing provider. | read-only: true | validation: maxLength 100 - name: url | type: string | description: URL to join the conference. All participants use this URL to join. | read-only: true | validation: maxLength 2048 - name: hostUrl | type: string | description: URL for the host to start the conference. Returned only when the conferencing provider supplies a separate host URL, such as Zoom. | read-only: true | validation: maxLength 2048 - name: password | type: string | description: Password required to join the conference. | read-only: true | validation: maxLength 100 - name: title | type: string | description: Title or topic of the meeting. | validation: maxLength 500 - name: startTime | type: Date | description: Scheduled start time of the meeting. - name: durationInMinutes | type: integer | description: Duration of the meeting in minutes. | validation: format int32 - name: timezone | type: string | description: Time zone for the meeting in IANA Time Zone Database format. For example, `America/New_York`. | validation: maxLength 100 - name: description | type: string | description: Human-readable description of the conference. For example, `Personal Zoom Room`. | validation: maxLength 500 - name: appId | type: string | description: GUID of the conferencing provider app that owns this conference. Matches the `id` of a provider returned by List Providers. | read-only: true | validation: format GUID - name: resourceId | type: string | description: GUID of the resource of the connection the conference was created with. If the request fell back to the site's default business resource (`4e0579a5-491e-4e70-a872-d097eed6e520`), that resource GUID appears here. | read-only: true | validation: format GUID Possible Errors: HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: PERMISSION_DENIED | Description: The identity used to call the method doesn't have the required permissions to manage this resource. HTTP Code: 404 | Status Code: NOT_FOUND | Application Code: PROVIDER_NOT_FOUND | Description: Couldn't find the conferencing provider. HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: RESOURCE_NOT_CONNECTED | Description: The resource isn't connected to a conferencing provider. ``` ### Examples ### Get a conference Retrieves a Zoom conference's details. ```javascript import { conferencing } from "@wix/calendar"; async function getConference() { const response = await conferencing.getConference("84729105634", { appId: "c6d111d1-1a8d-49f0-a78c-4f1823fb6592", resourceId: "a1f3c9e2-6b7d-4e58-9c0a-2d4b8e7f1356", }); } /* Promise resolves to: * { * "conference": { * "_id": "84729105634", * "url": "https://zoom.us/j/84729105634", * "hostUrl": "https://zoom.us/s/84729105634", * "password": "582916", * "title": "Personal training session", * "startTime": "2026-11-10T09:00:00.000Z", * "durationInMinutes": 60, * "timezone": "America/New_York", * "appId": "c6d111d1-1a8d-49f0-a78c-4f1823fb6592", * "resourceId": "a1f3c9e2-6b7d-4e58-9c0a-2d4b8e7f1356" * } * } */ ``` ### getConference (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 { conferencing } from '@wix/calendar'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { conferencing }, // Include the auth strategy and host as relevant }); async function getConference(conferenceId,options) { const response = await myWixClient.conferencing.getConference(conferenceId,options); }; ``` ---