Reference

Endpoint GET Settings

Name

get_settings

Description

Retrieve a user's settings. For user-level apps, pass the me value instead of the userId parameter. [API reference]

Related Tables

UserSettings

Parameters

Parameter	Required	Options
Name: UserId Label: UserId The user ID or email address of the user. For user-level apps, pass the me value.	YES

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length
schedule_meeting_host_video	`DT_BOOL`	`bit`
schedule_meeting_participants_video	`DT_BOOL`	`bit`
schedule_meeting_audio_type	`DT_WSTR`	`nvarchar(16)`	16
schedule_meeting_join_before_host	`DT_BOOL`	`bit`
schedule_meeting_personal_meeting	`DT_BOOL`	`bit`
schedule_meeting_use_pmi_for_scheduled_meetings	`DT_BOOL`	`bit`
schedule_meeting_use_pmi_for_instant_meetings	`DT_BOOL`	`bit`
schedule_meeting_force_pmi_jbh_password	`DT_BOOL`	`bit`
schedule_meeting_require_password_for_scheduling_new_meetings	`DT_BOOL`	`bit`
schedule_meeting_require_password_for_scheduled_meetings	`DT_BOOL`	`bit`
schedule_meeting_default_password_for_scheduled_meetings	`DT_WSTR`	`nvarchar(24)`	24
schedule_meeting_require_password_for_instant_meetings	`DT_BOOL`	`bit`
schedule_meeting_require_password_for_pmi_meetings	`DT_WSTR`	`nvarchar(12)`	12
schedule_meeting_pmi_password	`DT_WSTR`	`nvarchar(24)`	24
schedule_meeting_pstn_password_protected	`DT_BOOL`	`bit`
schedule_meeting_mute_upon_entry	`DT_BOOL`	`bit`
schedule_meeting_embed_password_in_join_link	`DT_BOOL`	`bit`
schedule_meeting_meeting_password_requirement_length	`DT_I8`	`bigint`
schedule_meeting_meeting_password_requirement_have_letter	`DT_BOOL`	`bit`
schedule_meeting_meeting_password_requirement_have_number	`DT_BOOL`	`bit`
schedule_meeting_meeting_password_requirement_have_special_character	`DT_BOOL`	`bit`
schedule_meeting_meeting_password_requirement_have_upper_and_lower_characters	`DT_BOOL`	`bit`
schedule_meeting_meeting_password_requirement_only_allow_numeric	`DT_BOOL`	`bit`
schedule_meeting_meeting_password_requirement_consecutive_characters_length	`DT_I8`	`bigint`
schedule_meeting_meeting_password_requirement_weak_enhance_detection	`DT_BOOL`	`bit`
in_meeting_e2e_encryption	`DT_BOOL`	`bit`
in_meeting_chat	`DT_BOOL`	`bit`
in_meeting_private_chat	`DT_BOOL`	`bit`
in_meeting_auto_saving_chat	`DT_BOOL`	`bit`
in_meeting_entry_exit_chime	`DT_WSTR`	`nvarchar(16)`	16
in_meeting_record_play_voice	`DT_BOOL`	`bit`
in_meeting_file_transfer	`DT_BOOL`	`bit`
in_meeting_feedback	`DT_BOOL`	`bit`
in_meeting_attendee_on_hold	`DT_BOOL`	`bit`
in_meeting_show_meeting_control_toolbar	`DT_BOOL`	`bit`
in_meeting_allow_show_zoom_windows	`DT_BOOL`	`bit`
in_meeting_annotation	`DT_BOOL`	`bit`
in_meeting_remote_control	`DT_BOOL`	`bit`
in_meeting_non_verbal_feedback	`DT_BOOL`	`bit`
in_meeting_breakout_room	`DT_BOOL`	`bit`
in_meeting_closed_caption	`DT_BOOL`	`bit`
in_meeting_remote_support	`DT_BOOL`	`bit`
in_meeting_far_end_camera_control	`DT_BOOL`	`bit`
in_meeting_virtual_background	`DT_BOOL`	`bit`
in_meeting_virtual_background_settings_enable	`DT_BOOL`	`bit`
in_meeting_virtual_background_settings_allow_videos	`DT_BOOL`	`bit`
in_meeting_virtual_background_settings_allow_upload_custom	`DT_BOOL`	`bit`
in_meeting_virtual_background_settings_files	`DT_WSTR`	`nvarchar(8)`	8
in_meeting_auto_answer	`DT_BOOL`	`bit`
in_meeting_screen_sharing	`DT_BOOL`	`bit`
in_meeting_attention_mode_focus_mode	`DT_BOOL`	`bit`
in_meeting_who_can_share_screen	`DT_WSTR`	`nvarchar(16)`	16
in_meeting_who_can_share_screen_when_someone_is_sharing	`DT_WSTR`	`nvarchar(16)`	16
in_meeting_waiting_room	`DT_BOOL`	`bit`
in_meeting_participants_to_place_in_waiting_room	`DT_I8`	`bigint`
in_meeting_request_permission_to_unmute_participants	`DT_BOOL`	`bit`
in_meeting_meeting_reactions	`DT_BOOL`	`bit`
in_meeting_show_a_join_from_your_browser_link	`DT_BOOL`	`bit`
in_meeting_allow_participants_to_rename	`DT_BOOL`	`bit`
in_meeting_allow_participants_chat_with	`DT_I8`	`bigint`
in_meeting_allow_users_save_chats	`DT_I8`	`bigint`
in_meeting_meeting_polling_enable	`DT_BOOL`	`bit`
in_meeting_closed_captioning_enable	`DT_BOOL`	`bit`
in_meeting_closed_captioning_save_caption	`DT_BOOL`	`bit`
in_meeting_slide_control	`DT_BOOL`	`bit`
in_meeting_webinar_polling_enable	`DT_BOOL`	`bit`
in_meeting_disable_screen_sharing_for_host_meetings	`DT_BOOL`	`bit`
in_meeting_disable_screen_sharing_for_in_meeting_guests	`DT_BOOL`	`bit`
email_notification_jbh_reminder	`DT_BOOL`	`bit`
email_notification_cancel_meeting_reminder	`DT_BOOL`	`bit`
recording_local_recording	`DT_BOOL`	`bit`
recording_auto_recording	`DT_WSTR`	`nvarchar(16)`	16
recording_recording_disclaimer	`DT_BOOL`	`bit`
recording_auto_delete_cmr	`DT_BOOL`	`bit`
recording_recording_password_requirement_length	`DT_I8`	`bigint`
recording_recording_password_requirement_have_letter	`DT_BOOL`	`bit`
recording_recording_password_requirement_have_number	`DT_BOOL`	`bit`
recording_recording_password_requirement_have_special_character	`DT_BOOL`	`bit`
recording_recording_password_requirement_only_allow_numeric	`DT_BOOL`	`bit`
telephony_third_party_audio	`DT_BOOL`	`bit`
telephony_audio_conference_info	`DT_WSTR`	`nvarchar(80)`	80
telephony_show_international_numbers_link	`DT_BOOL`	`bit`
telephony_telephony_regions_allowed_values	`DT_WSTR`	`nvarchar(344)`	344
feature_meeting_capacity	`DT_I8`	`bigint`
feature_large_meeting	`DT_BOOL`	`bit`
feature_webinar	`DT_BOOL`	`bit`
feature_zoom_events	`DT_BOOL`	`bit`
feature_cn_meeting	`DT_BOOL`	`bit`
feature_in_meeting	`DT_BOOL`	`bit`
feature_zoom_phone	`DT_BOOL`	`bit`
feature_zoom_iq_for_sales	`DT_BOOL`	`bit`
integration_linkedin_sales_navigator	`DT_BOOL`	`bit`
audio_conferencing_toll_free_and_fee_based_toll_call_enable	`DT_BOOL`	`bit`

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 UserSettings table, therefore it is better to use it, instead of accessing the endpoint directly:

API Source - Zoom

Zoom Connector can be used to integrate Zoom REST API in your App / BI Tools. You can read/write data about Meetings, Invite, Users, Accounts and more.

Zoom

UserSettings

Required Parameters
UserId	Fill-in the parameter...

SSIS API Source - Read from table or endpoint

API Destination

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

API Destination - Zoom

Zoom Connector can be used to integrate Zoom REST API in your App / BI Tools. You can read/write data about Meetings, Invite, Users, Accounts and more.

Zoom

UserSettings

Select

Required Parameters
UserId	Fill-in the parameter...

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get Settings

Get the user settings by by user id

SELECT * FROM UserSettings
WITH(
  UserId='me' -- enter user id or email
)
--You can get UserId by selecting from 'list_users' endpoint and also this value available as dropdown value for UserId parameter.

get_settings endpoint belongs to UserSettings 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:

Get Settings

Get the user settings by by user id

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM UserSettings
WITH(
  UserId=''me'' -- enter user id or email
)
--You can get UserId by selecting from ''list_users'' endpoint and also this value available as dropdown value for UserId parameter.';

EXEC (@MyQuery) AT [LS_TO_ZOOM_IN_GATEWAY];

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