Get locked settings
GET {{baseUrl}}/accounts/:accountId/lock_settings?option=<string>&custom_query_fields=<string>
Retrieve an account's locked settings.
Account admins and account owners can use Account Locked Settings to toggle settings on or off for all users in their account.
Note: You can use Account Locked Settings with accounts that have master and sub accounts enabled.
Prerequisites:
- Pro or a higher paid account.
Scopes:
account:read:admin
Rate Limit Label
:
MEDIUM
Request Params
| Key | Datatype | Required | Description |
| option
| string | | Optional query parameters:
meeting_security
— Use this query parameter to view the meeting security settings applied to the user's account. | |custom_query_fields
| string | | Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following:
{ "schedule_meeting": { "host_video": false } }
You can provide multiple values by separating them with commas(example: "host_video,participant_video”). |
HEADERS
| Key | Datatype | Required | Description |
| Accept
| string | | |
RESPONSES
status: OK
{"audio_conferencing":{"toll_free_and_fee_based_toll_call":"\u003cboolean\u003e"},"chat":{"share_files":"\u003cboolean\u003e","chat_emojis":"\u003cboolean\u003e","record_voice_messages":"\u003cboolean\u003e","record_video_messages":"\u003cboolean\u003e","screen_capture":"\u003cboolean\u003e","share_links_in_chat":"\u003cboolean\u003e","schedule_meetings_in_chat":"\u003cboolean\u003e","set_retention_period_in_cloud":"\u003cboolean\u003e","set_retention_period_in_local":"\u003cboolean\u003e","allow_users_to_add_contacts":"\u003cboolean\u003e","allow_users_to_chat_with_others":"\u003cboolean\u003e","chat_etiquette_tool":"\u003cboolean\u003e","send_data_to_third_party_archiving_service":"\u003cboolean\u003e","translate_messages":"\u003cboolean\u003e","search_and_send_animated_gif_images":"\u003cboolean\u003e"},"email_notification":{"alternative_host_reminder":"\u003cboolean\u003e","cancel_meeting_reminder":"\u003cboolean\u003e","cloud_recording_available_reminder":"\u003cboolean\u003e","jbh_reminder":"\u003cboolean\u003e","schedule_for_reminder":"\u003cboolean\u003e"},"in_meeting":{"alert_guest_join":"\u003cboolean\u003e","allow_users_to_delete_messages_in_meeting_chat":"\u003cboolean\u003e","allow_live_streaming":"\u003cboolean\u003e","allow_show_zoom_windows":"\u003cboolean\u003e","annotation":"\u003cboolean\u003e","anonymous_question_answer":"\u003cboolean\u003e","attendee_on_hold":false,"attention_mode_focus_mode":false,"auto_answer":"\u003cboolean\u003e","auto_generated_captions":"\u003cboolean\u003e","auto_saving_chat":"\u003cboolean\u003e","breakout_room":"\u003cboolean\u003e","chat":"\u003cboolean\u003e","meeting_question_answer":"\u003cboolean\u003e","closed_caption":"\u003cboolean\u003e","co_host":"\u003cboolean\u003e","custom_data_center_regions":"\u003cboolean\u003e","disable_screen_sharing_for_host_meetings":"\u003cboolean\u003e","disable_screen_sharing_for_in_meeting_guests":"\u003cboolean\u003e","dscp_marking":"\u003cboolean\u003e","e2e_encryption":"\u003cboolean\u003e","entry_exit_chime":"\u003cstring\u003e","far_end_camera_control":"\u003cboolean\u003e","feedback":"\u003cboolean\u003e","file_transfer":"\u003cboolean\u003e","full_transcript":"\u003cboolean\u003e","group_hd":"\u003cboolean\u003e","webinar_group_hd":"\u003cboolean\u003e","language_interpretation":"\u003cboolean\u003e","sign_language_interpretation":"\u003cboolean\u003e","manual_captions":"\u003cboolean\u003e","meeting_reactions":"\u003cboolean\u003e","webinar_reactions":"\u003cboolean\u003e","meeting_survey":"\u003cboolean\u003e","original_audio":"\u003cboolean\u003e","polling":"\u003cboolean\u003e","post_meeting_feedback":"\u003cboolean\u003e","private_chat":"\u003cboolean\u003e","remote_control":"\u003cboolean\u003e","non_verbal_feedback":false,"remote_support":false,"request_permission_to_unmute_participants":"\u003cboolean\u003e","save_caption":"\u003cboolean\u003e","save_captions":"\u003cboolean\u003e","screen_sharing":"\u003cboolean\u003e","sending_default_email_invites":"\u003cboolean\u003e","show_meeting_control_toolbar":"\u003cboolean\u003e","slide_control":"\u003cboolean\u003e","stereo_audio":"\u003cboolean\u003e","use_html_format_email":"\u003cboolean\u003e","virtual_background":"\u003cboolean\u003e","webinar_chat":"\u003cboolean\u003e","webinar_live_streaming":"\u003cboolean\u003e","webinar_polling":"\u003cboolean\u003e","webinar_question_answer":"\u003cboolean\u003e","webinar_survey":"\u003cboolean\u003e","whiteboard":"\u003cboolean\u003e"},"other_options":{"blur_snapshot":"\u003cboolean\u003e","webinar_registration_options":"\u003cboolean\u003e"},"recording":{"account_user_access_recording":"\u003cboolean\u003e","auto_delete_cmr":"\u003cboolean\u003e","auto_recording":"\u003cboolean\u003e","cloud_recording":"\u003cboolean\u003e","cloud_recording_download":"\u003cboolean\u003e","host_delete_cloud_recording":"\u003cboolean\u003e","ip_address_access_control":"\u003cboolean\u003e","local_recording":"\u003cboolean\u003e","prevent_host_access_recording":"\u003cboolean\u003e","recording_authentication":"\u003cboolean\u003e","archive":"\u003cboolean\u003e"},"schedule_meeting":{"audio_type":"\u003cboolean\u003e","embed_password_in_join_link":"\u003cboolean\u003e","enforce_login":"\u003cboolean\u003e","enforce_login_domains":"\u003cstring\u003e","enforce_login_with_domains":"\u003cboolean\u003e","host_video":"\u003cboolean\u003e","join_before_host":"\u003cboolean\u003e","meeting_authentication":"\u003cboolean\u003e","not_store_meeting_topic":"\u003cboolean\u003e","always_display_zoom_webinar_as_topic":"\u003cboolean\u003e","participant_video":"\u003cboolean\u003e","require_password_for_instant_meetings":"\u003cboolean\u003e","require_password_for_pmi_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","continuous_meeting_chat":"\u003cboolean\u003e"},"telephony":{"telephony_regions":"\u003cboolean\u003e","third_party_audio":"\u003cboolean\u003e"},"tsp":{"call_out":"\u003cboolean\u003e","show_international_numbers_link":"\u003cboolean\u003e"}}