Reference

Endpoint Get Webinar Settings By Id

Name

get_webinar

Description

Use this API to get details of a scheduled webinar. [API reference]

Related Tables

Webinars

Parameters

Parameter Required Options
Name: WebinarId

Label: WebinarId

The Webinar ID for which you want to get details. 		YES

Output Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
id DT_I8 bigint
host_id DT_WSTR nvarchar(100) 100
host_email DT_WSTR nvarchar(255) 255
topic DT_WSTR nvarchar(255) 255
type DT_I8 bigint
start_time DT_DBTIMESTAMP datetime
duration DT_I8 bigint
timezone DT_WSTR nvarchar(100) 100
agenda DT_WSTR nvarchar(1000) 1000
created_at DT_DBTIMESTAMP datetime
start_url DT_WSTR nvarchar(4000) 4000
join_url DT_WSTR nvarchar(1000) 1000
password DT_WSTR nvarchar(100) 100
settings_host_video DT_BOOL bit
settings_panelists_video DT_BOOL bit
settings_approval_type DT_I8 bigint
settings_audio DT_WSTR nvarchar(16) 16
settings_auto_recording DT_WSTR nvarchar(100) 100
settings_enforce_login DT_BOOL bit
settings_enforce_login_domains DT_WSTR nvarchar(100) 100
settings_alternative_hosts DT_WSTR nvarchar(100) 100
settings_alternative_host_update_polls DT_BOOL bit
settings_close_registration DT_BOOL bit
settings_show_share_button DT_BOOL bit
settings_allow_multiple_devices DT_BOOL bit
settings_practice_session DT_BOOL bit
settings_hd_video DT_BOOL bit
settings_question_answer DT_BOOL bit
settings_registrants_confirmation_email DT_BOOL bit
settings_on_demand DT_BOOL bit
settings_request_permission_to_unmute_participants DT_BOOL bit
settings_contact_name DT_WSTR nvarchar(255) 255
settings_contact_email DT_WSTR nvarchar(255) 255
settings_registrants_restrict_number DT_I8 bigint
settings_registrants_email_notification DT_BOOL bit
settings_post_webinar_survey DT_BOOL bit
settings_meeting_authentication DT_BOOL bit
settings_question_and_answer_enable DT_BOOL bit
settings_question_and_answer_allow_anonymous_questions DT_BOOL bit
settings_question_and_answer_answer_questions DT_WSTR nvarchar(255) 255
settings_question_and_answer_attendees_can_upvote DT_BOOL bit
settings_question_and_answer_attendees_can_comment DT_BOOL bit
settings_hd_video_for_attendees DT_BOOL bit
settings_send_1080p_video_to_attendees DT_BOOL bit
settings_email_language DT_WSTR nvarchar(100) 100
settings_panelists_invitation_email_notification DT_BOOL bit
settings_attendees_and_panelists_reminder_email_notification_enable DT_BOOL bit
settings_attendees_and_panelists_reminder_email_notification_type DT_I8 bigint
settings_follow_up_attendees_email_notification_enable DT_BOOL bit
settings_follow_up_attendees_email_notification_type DT_I8 bigint
settings_follow_up_absentees_email_notification_enable DT_BOOL bit
settings_follow_up_absentees_email_notification_type DT_I8 bigint
settings_enable_session_branding DT_BOOL bit
uuid DT_WSTR nvarchar(100) 100
If the column you are looking for is missing, consider customizing Zoom Connector.

Input Columns

Label Data Type (SSIS) Data Type (SQL) Length Description
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime.

Examples

SSIS

Use Zoom Connector in API Source or in API Destination SSIS Data Flow components to read or write data.

API Source

This Endpoint belongs to the Webinars table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Zoom
Read and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.
Zoom
Webinars
Required Parameters
WebinarId Fill-in the parameter...
SSIS API Source - Read from table or endpoint

API Destination

This Endpoint belongs to the Webinars table, therefore it is better to use it, instead of accessing the endpoint directly. Use this table and table-operation pair to get webinar settings by id:

API Destination - Zoom
Read and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.
Zoom
Webinars
Lookup
Required Parameters
WebinarId Fill-in the parameter...
SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Read webinar by ID

<p>Reads detailed configuration for a specific webinar. Use this to retrieve settings like approval type, audio options, and alternative hosts.</p> <p>Use the <code>WHERE id=...</code> clause on the <code>Webinars</code> table to locate a specific webinar record.</p> 

SELECT * FROM Webinars WHERE id=1234

get_webinar endpoint belongs to Webinars table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Read webinar by ID

<p>Reads detailed configuration for a specific webinar. Use this to retrieve settings like approval type, audio options, and alternative hosts.</p> <p>Use the <code>WHERE id=...</code> clause on the <code>Webinars</code> table to locate a specific webinar record.</p> 

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Webinars WHERE id=1234';

EXEC (@MyQuery) AT [LS_TO_ZOOM_IN_GATEWAY];

get_webinar endpoint belongs to Webinars table(s), and can therefore be used via those table(s).