Get account settings

GET {{baseUrl}}/accounts/:accountId/settings?option=recording_authentication&custom_query_fields=<string>

Get an account's settings.

To get settings for a master account, use the me value for the accountId path parameter.

Prerequisites:

• The account must be a paid account.

Scopes: account:read:admin

Rate Limit Label : MEDIUM

Request Params

| Key | Datatype | Required | Description | | option | string | | Optional query parameters.

• meeting_authentication - View the meeting authentication settings applied to the user's account.
• recording_authentication - View the recording authentication settings applied to the user's account.
• security - View the account's security settings. For example, passcode requirements for user login or two-factor authentication.
• meeting_security - View the meeting security settings applied to the user's account. | | custom_query_fields | string | | The name of the field to use to filter the response. For example, if you provide the host_video value for this field, you will get a response similar to.

{ schedule_meeting: { host_video: false } }

To use multiple values, comma-separate each value, like host_video,participant_video. |

HEADERS

| Key | Datatype | Required | Description | | Accept | string | | |

RESPONSES

status: OK

{"security":{"admin_change_name_pic":"\u003cboolean\u003e","admin_change_user_info":"\u003cboolean\u003e","user_modifiable_info_by_admin":["sign_in_email"],"signin_with_sso":{"enable":"\u003cboolean\u003e","require_sso_for_domains":"\u003cboolean\u003e","domains":["\u003cstring\u003e"],"sso_bypass_users":[{"id":"\u003cstring\u003e","email":"\u003cstring\u003e"}]},"hide_billing_info":"\u003cboolean\u003e","import_photos_from_devices":"\u003cboolean\u003e","password_requirement":{"consecutive_characters_length":"\u003cinteger\u003e","have_special_character":"\u003cboolean\u003e","minimum_password_length":"\u003cinteger\u003e","weak_enhance_detection":"\u003cboolean\u003e"},"sign_again_period_for_inactivity_on_client":"\u003cinteger\u003e","sign_again_period_for_inactivity_on_web":"\u003cinteger\u003e","sign_in_with_two_factor_auth":"role","sign_in_with_two_factor_auth_groups":["\u003cstring\u003e"],"sign_in_with_two_factor_auth_roles":["\u003cstring\u003e"]},"audio_conferencing":{"toll_free_and_fee_based_toll_call":{"allow_webinar_attendees_dial":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","numbers":[{"code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","country_name":"\u003cstring\u003e","display_number":"\u003cstring\u003e","number":"\u003cstring\u003e"}]}},"chat":{"allow_bots_chat":"\u003cboolean\u003e","share_files":{"enable":"\u003cboolean\u003e","share_option":"account","restrictions":{"only_allow_specific_file_types":"\u003cboolean\u003e","file_type_restrictions":[".xmind"],"file_type_restrictions_for_external":[".7z"],"maximum_file_size":"\u003cboolean\u003e","file_size_restrictions":100,"file_size_restrictions_for_external":200}},"chat_emojis":{"enable":"\u003cboolean\u003e","emojis_option":"selected"},"record_voice_messages":"\u003cboolean\u003e","record_video_messages":"\u003cboolean\u003e","screen_capture":"\u003cboolean\u003e","create_public_channels":"\u003cboolean\u003e","create_private_channels":"\u003cboolean\u003e","share_links_in_chat":"\u003cboolean\u003e","schedule_meetings_in_chat":"\u003cboolean\u003e","set_retention_period_in_cloud":{"enable":"\u003cboolean\u003e","retention_period_of_direct_messages_and_group_conversation":"\u003cstring\u003e","retention_period_of_channels":"\u003cstring\u003e"},"set_retention_period_in_local":{"enable":"\u003cboolean\u003e","retention_period_of_direct_messages_and_group_conversation":"\u003cstring\u003e","retention_period_of_channels":"\u003cstring\u003e"},"allow_users_to_add_contacts":{"enable":"\u003cboolean\u003e","selected_option":3,"user_email_addresses":"\u003cstring\u003e"},"allow_users_to_chat_with_others":{"enable":"\u003cboolean\u003e","selected_option":3,"user_email_addresses":"\u003cstring\u003e"},"chat_etiquette_tool":{"enable":"\u003cboolean\u003e","policies":[{"description":"\u003cstring\u003e","id":"\u003cstring\u003e","is_locked":"\u003cboolean\u003e","keywords":["\u003cstring\u003e"],"name":"\u003cstring\u003e","regular_expression":"\u003cstring\u003e","status":"activated","trigger_action":2}],"policy_max_count":"\u003cinteger\u003e"},"send_data_to_third_party_archiving_service":{"enable":"\u003cboolean\u003e","type":"global_relay","smtp_delivery_address":"\u003cstring\u003e","user_name":"\u003cstring\u003e","passcode":"\u003cstring\u003e","authorized_channel_token":"\u003cstring\u003e"},"apply_local_storage_to_personal_channel":{"enable":"\u003cboolean\u003e","retention_period":"\u003cstring\u003e"},"translate_messages":"\u003cboolean\u003e","search_and_send_animated_gif_images":{"enable":"\u003cboolean\u003e","giphy_content_rating":2}},"email_notification":{"alternative_host_reminder":"\u003cboolean\u003e","cancel_meeting_reminder":"\u003cboolean\u003e","cloud_recording_available_reminder":"\u003cboolean\u003e","jbh_reminder":"\u003cboolean\u003e","low_host_count_reminder":"\u003cboolean\u003e","recording_available_reminder_alternative_hosts":"\u003cboolean\u003e","recording_available_reminder_schedulers":"\u003cboolean\u003e","schedule_for_reminder":"\u003cboolean\u003e"},"feature":{"meeting_capacity":"\u003cinteger\u003e"},"in_meeting":{"auto_generated_translation":{"language_item_pairList":{"trans_lang_config":[{"speak_language":{"name":"Chinese (Simplified)","code":"ja"},"translate_to":{"all":"\u003cboolean\u003e","language_config":[{"name":"English","code":"en"}]}}],"all":"\u003cboolean\u003e"},"enable":"\u003cboolean\u003e"},"alert_guest_join":"\u003cboolean\u003e","allow_host_to_enable_focus_mode":"\u003cboolean\u003e","allow_live_streaming":"\u003cboolean\u003e","allow_participants_chat_with":2,"allow_participants_to_rename":"\u003cboolean\u003e","allow_show_zoom_windows":"\u003cboolean\u003e","allow_users_save_chats":1,"annotation":"\u003cboolean\u003e","anonymous_question_answer":"\u003cboolean\u003e","attendee_on_hold":false,"attention_mode_focus_mode":false,"auto_answer":"\u003cboolean\u003e","auto_saving_chat":"\u003cboolean\u003e","breakout_room":"\u003cboolean\u003e","breakout_room_schedule":"\u003cboolean\u003e","chat":"\u003cboolean\u003e","meeting_question_answer":"\u003cboolean\u003e","closed_caption":"\u003cboolean\u003e","closed_captioning":{"auto_transcribing":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","save_caption":"\u003cboolean\u003e","third_party_captioning_service":"\u003cboolean\u003e","view_full_transcript":"\u003cboolean\u003e"},"co_host":"\u003cboolean\u003e","custom_data_center_regions":"\u003cboolean\u003e","custom_live_streaming_service":"\u003cboolean\u003e","custom_service_instructions":"\u003cstring\u003e","meeting_data_transit_and_residency_method":"cloud","data_center_regions":["LA"],"disable_screen_sharing_for_host_meetings":"\u003cboolean\u003e","disable_screen_sharing_for_in_meeting_guests":"\u003cboolean\u003e","dscp_audio":"\u003cinteger\u003e","dscp_marking":"\u003cboolean\u003e","dscp_video":"\u003cinteger\u003e","dscp_dual":"\u003cboolean\u003e","e2e_encryption":"\u003cboolean\u003e","entry_exit_chime":"all","far_end_camera_control":"\u003cboolean\u003e","feedback":"\u003cboolean\u003e","file_transfer":"\u003cboolean\u003e","group_hd":"\u003cboolean\u003e","webinar_group_hd":"\u003cboolean\u003e","join_from_desktop":"\u003cboolean\u003e","join_from_mobile":"\u003cboolean\u003e","language_interpretation":{"custom_languages":["\u003cstring\u003e"],"enable":"\u003cboolean\u003e","enable_language_interpretation_by_default":"\u003cboolean\u003e","allow_participants_to_speak_in_listening_channel":"\u003cboolean\u003e","allow_up_to_25_custom_languages_when_scheduling_meetings":"\u003cboolean\u003e","languages":["English"]},"sign_language_interpretation":{"enable":"\u003cboolean\u003e","enable_sign_language_interpretation_by_default":"\u003cboolean\u003e","languages":["Russian"],"custom_languages":["\u003cstring\u003e"]},"live_streaming_facebook":"\u003cboolean\u003e","live_streaming_youtube":"\u003cboolean\u003e","manual_captioning":{"allow_to_type":"\u003cboolean\u003e","auto_generated_captions":"\u003cboolean\u003e","full_transcript":"\u003cboolean\u003e","manual_captions":"\u003cboolean\u003e","save_captions":"\u003cboolean\u003e","third_party_captioning_service":"\u003cboolean\u003e"},"meeting_polling":{"advanced_polls":"\u003cboolean\u003e","allow_alternative_host_to_add_edit":"\u003cboolean\u003e","manage_saved_polls_and_quizzes":"\u003cboolean\u003e","allow_host_to_upload_image":"\u003cboolean\u003e","require_answers_to_be_anonymous":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"meeting_reactions":"\u003cboolean\u003e","meeting_reactions_emojis":"all","allow_host_panelists_to_use_audible_clap":"\u003cboolean\u003e","webinar_reactions":"\u003cboolean\u003e","meeting_survey":"\u003cboolean\u003e","original_audio":"\u003cboolean\u003e","p2p_connetion":"\u003cboolean\u003e","p2p_ports":"\u003cboolean\u003e","polling":"\u003cboolean\u003e","ports_range":"","post_meeting_feedback":"\u003cboolean\u003e","private_chat":"\u003cboolean\u003e","record_play_own_voice":"\u003cboolean\u003e","remote_control":"\u003cboolean\u003e","non_verbal_feedback":false,"remote_support":false,"request_permission_to_unmute_participants":"\u003cboolean\u003e","screen_sharing":"\u003cboolean\u003e","sending_default_email_invites":"\u003cboolean\u003e","show_a_join_from_your_browser_link":"\u003cboolean\u003e","show_meeting_control_toolbar":"\u003cboolean\u003e","slide_control":"\u003cboolean\u003e","stereo_audio":"\u003cboolean\u003e","unchecked_data_center_regions":["LA"],"use_html_format_email":"\u003cboolean\u003e","virtual_background":"\u003cboolean\u003e","virtual_background_settings":{"allow_upload_custom":"\u003cboolean\u003e","allow_videos":"\u003cboolean\u003e","enable":"\u003cboolean\u003e","files":[{"id":"\u003cstring\u003e","is_default":"\u003cboolean\u003e","name":"\u003cstring\u003e","size":"\u003cinteger\u003e","type":"\u003cstring\u003e"}]},"watermark":"\u003cboolean\u003e","webinar_chat":{"allow_attendees_chat_with":1,"allow_auto_save_local_chat_file":"\u003cboolean\u003e","allow_panelists_chat_with":2,"allow_panelists_send_direct_message":"\u003cboolean\u003e","allow_users_save_chats":1,"allow_users_to_delete_messages_in_meeting_chat":"\u003cboolean\u003e","default_attendees_chat_with":2,"enable":"\u003cboolean\u003e"},"webinar_live_streaming":{"custom_service_instructions":"\u003cstring\u003e","enable":"\u003cboolean\u003e","live_streaming_reminder":"\u003cboolean\u003e","live_streaming_service":["custom_live_streaming_service"]},"webinar_polling":{"advanced_polls":"\u003cboolean\u003e","allow_alternative_host_to_add_edit":"\u003cboolean\u003e","require_answers_to_be_anonymous":"\u003cboolean\u003e","manage_saved_polls_and_quizzes":"\u003cboolean\u003e","allow_host_to_upload_image":"\u003cboolean\u003e","enable":"\u003cboolean\u003e"},"webinar_question_answer":"\u003cboolean\u003e","webinar_survey":"\u003cboolean\u003e","whiteboard":"\u003cboolean\u003e","who_can_share_screen":"all","who_can_share_screen_when_someone_is_sharing":"all","participants_share_simultaneously":"one","workplace_by_facebook":"\u003cboolean\u003e","transfer_meetings_between_devices":"\u003cboolean\u003e"},"integration":{"box":"\u003cboolean\u003e","dropbox":"\u003cboolean\u003e","google_calendar":"\u003cboolean\u003e","google_drive":"\u003cboolean\u003e","kubi":"\u003cboolean\u003e","microsoft_one_drive":"\u003cboolean\u003e"},"other_options":{"allow_auto_active_users":"\u003cboolean\u003e","allow_users_contact_support_via_chat":"\u003cboolean\u003e","allow_users_enter_and_share_pronouns":"\u003cboolean\u003e","blur_snapshot":"\u003cboolean\u003e","display_meetings_scheduled_for_others":"\u003cboolean\u003e","meeting_qos_and_mos":0,"show_one_user_meeting_on_dashboard":"\u003cboolean\u003e","use_cdn":"wangsu","webinar_registration_options":{"allow_host_to_enable_join_info":"\u003cboolean\u003e","allow_host_to_enable_social_share_buttons":"\u003cboolean\u003e","enable_custom_questions":"\u003cboolean\u003e"},"email_in_attendee_report_for_meeting":"\u003cboolean\u003e"},"profile":{"recording_storage_location":{"allowed_values":["\u003cstring\u003e"],"value":"\u003cstring\u003e"}},"recording":{"account_user_access_recording":"\u003cboolean\u003e","allow_recovery_deleted_cloud_recordings":"\u003cboolean\u003e","archive":{"enable":"\u003cboolean\u003e","settings":{"audio_file":"\u003cboolean\u003e","cc_transcript_file":"\u003cboolean\u003e","chat_file":"\u003cboolean\u003e","chat_with_sender_email":"\u003cboolean\u003e","video_file":"\u003cboolean\u003e","chat_with_direct_message":"\u003cboolean\u003e","archive_retention":7,"action_when_archive_failed":2,"notification_when_archiving_starts":"participants","play_voice_prompt_when_archiving_starts":"guest"},"type":3},"auto_delete_cmr":"\u003cboolean\u003e","auto_delete_cmr_days":30,"auto_recording":"cloud","cloud_recording":"\u003cboolean\u003e","cloud_recording_download":"\u003cboolean\u003e","cloud_recording_download_host":"\u003cboolean\u003e","display_participant_name":"\u003cboolean\u003e","host_delete_cloud_recording":"\u003cboolean\u003e","ip_address_access_control":{"enable":"\u003cboolean\u003e","ip_addresses_or_ranges":"\u003cstring\u003e"},"local_recording":"\u003cboolean\u003e","optimize_recording_for_3rd_party_video_editor":"\u003cboolean\u003e","prevent_host_access_recording":"\u003cboolean\u003e","record_audio_file":"\u003cboolean\u003e","record_audio_file_each_participant":"\u003cboolean\u003e","record_files_separately":{"active_speaker":"\u003cboolean\u003e","gallery_view":"\u003cboolean\u003e","shared_screen":"\u003cboolean\u003e"},"record_gallery_view":"\u003cboolean\u003e","record_speaker_view":"\u003cboolean\u003e","recording_audio_transcript":"\u003cboolean\u003e","recording_disclaimer":"\u003cboolean\u003e","recording_highlight":"\u003cboolean\u003e","smart_recording":{"create_recording_highlights":"\u003cboolean\u003e","create_smart_chapters":"\u003cboolean\u003e","create_next_steps":"\u003cboolean\u003e"},"recording_password_requirement":{"have_letter":"\u003cboolean\u003e","have_number":"\u003cboolean\u003e","have_special_character":"\u003cboolean\u003e","length":"\u003cinteger\u003e","only_allow_numeric":"\u003cboolean\u003e"},"recording_thumbnails":"\u003cboolean\u003e","required_password_for_existing_cloud_recordings":"\u003cboolean\u003e","required_password_for_shared_cloud_recordings":"\u003cboolean\u003e","save_chat_text":"\u003cboolean\u003e","save_close_caption":"\u003cboolean\u003e","save_panelist_chat":"\u003cboolean\u003e","save_poll_results":"\u003cboolean\u003e","show_timestamp":"\u003cboolean\u003e"},"schedule_meeting":{"audio_type":"both","enforce_login":"\u003cboolean\u003e","enforce_login_domains":"\u003cstring\u003e","enforce_login_with_domains":"\u003cboolean\u003e","force_pmi_jbh_password":"\u003cboolean\u003e","host_video":"\u003cboolean\u003e","enable_dedicated_group_chat":"\u003cboolean\u003e","jbh_time":0,"join_before_host":"\u003cboolean\u003e","meeting_password_requirement":{"consecutive_characters_length":8,"have_letter":"\u003cboolean\u003e","have_number":"\u003cboolean\u003e","have_special_character":"\u003cboolean\u003e","have_upper_and_lower_characters":"\u003cboolean\u003e","length":"\u003cinteger\u003e","only_allow_numeric":"\u003cboolean\u003e","weak_enhance_detection":"\u003cboolean\u003e"},"not_store_meeting_topic":"\u003cboolean\u003e","participant_video":"\u003cboolean\u003e","allow_host_to_disable_participant_video":"\u003cboolean\u003e","personal_meeting":"\u003cboolean\u003e","require_password_for_instant_meetings":"\u003cboolean\u003e","require_password_for_pmi_meetings":"jbh_only","require_password_for_scheduled_meetings":"\u003cboolean\u003e","require_password_for_scheduling_new_meetings":"\u003cboolean\u003e","use_pmi_for_instant_meetings":"\u003cboolean\u003e","use_pmi_for_scheduled_meetings":"\u003cboolean\u003e","always_display_zoom_meeting_as_topic":{"enable":"\u003cboolean\u003e","display_topic_for_scheduled_meetings":"\u003cboolean\u003e"},"hide_meeting_description":{"enable":"\u003cboolean\u003e","hide_description_for_scheduled_meetings":"\u003cboolean\u003e"},"always_display_zoom_webinar_as_topic":{"enable":"\u003cboolean\u003e","display_topic_for_scheduled_webinars":"\u003cboolean\u003e"},"hide_webinar_description":{"enable":"\u003cboolean\u003e","hide_description_for_scheduled_webinars":"\u003cboolean\u003e"},"meeting_template":{"enable":"\u003cboolean\u003e","templates":[{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","enable":"\u003cboolean\u003e"}]},"continuous_meeting_chat":{"enable":"\u003cboolean\u003e","can_add_external_users":"\u003cboolean\u003e","auto_add_invited_external_users":"\u003cboolean\u003e"}},"telephony":{"audio_conference_info":"\u003cstring\u003e","telephony_regions":{"allowed_values":["\u003cstring\u003e"],"selection_values":"\u003cstring\u003e"},"third_party_audio":"\u003cboolean\u003e"},"tsp":{"call_out":"\u003cboolean\u003e","call_out_countries":["\u003cstring\u003e"],"display_toll_free_numbers":"\u003cboolean\u003e","show_international_numbers_link":"\u003cboolean\u003e"},"zoom_rooms":{"auto_start_stop_scheduled_meetings":"\u003cboolean\u003e","cmr_for_instant_meeting":"\u003cboolean\u003e","force_private_meeting":"\u003cboolean\u003e","hide_host_information":"\u003cboolean\u003e","list_meetings_with_calendar":"\u003cboolean\u003e","start_airplay_manually":"\u003cboolean\u003e","ultrasonic":"\u003cboolean\u003e","upcoming_meeting_alert":"\u003cboolean\u003e","weekly_system_restart":"\u003cboolean\u003e","zr_post_meeting_feedback":"\u003cboolean\u003e"}}