Zoom Public API Documentation
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: Rate Limit Label: account:read:adminMEDIUM
Body
PARAM
| 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": "<boolean>"
},
"chat": {
"share_files": "<boolean>",
"chat_emojis": "<boolean>",
"record_voice_messages": "<boolean>",
"record_video_messages": "<boolean>",
"screen_capture": "<boolean>",
"share_links_in_chat": "<boolean>",
"schedule_meetings_in_chat": "<boolean>",
"set_retention_period_in_cloud": "<boolean>",
"set_retention_period_in_local": "<boolean>",
"allow_users_to_add_contacts": "<boolean>",
"allow_users_to_chat_with_others": "<boolean>",
"chat_etiquette_tool": "<boolean>",
"send_data_to_third_party_archiving_service": "<boolean>",
"translate_messages": "<boolean>",
"search_and_send_animated_gif_images": "<boolean>"
},
"email_notification": {
"alternative_host_reminder": "<boolean>",
"cancel_meeting_reminder": "<boolean>",
"cloud_recording_available_reminder": "<boolean>",
"jbh_reminder": "<boolean>",
"schedule_for_reminder": "<boolean>"
},
"in_meeting": {
"alert_guest_join": "<boolean>",
"allow_users_to_delete_messages_in_meeting_chat": "<boolean>",
"allow_live_streaming": "<boolean>",
"allow_show_zoom_windows": "<boolean>",
"annotation": "<boolean>",
"anonymous_question_answer": "<boolean>",
"attendee_on_hold": false,
"attention_mode_focus_mode": false,
"auto_answer": "<boolean>",
"auto_generated_captions": "<boolean>",
"auto_saving_chat": "<boolean>",
"breakout_room": "<boolean>",
"chat": "<boolean>",
"meeting_question_answer": "<boolean>",
"closed_caption": "<boolean>",
"co_host": "<boolean>",
"custom_data_center_regions": "<boolean>",
"disable_screen_sharing_for_host_meetings": "<boolean>",
"disable_screen_sharing_for_in_meeting_guests": "<boolean>",
"dscp_marking": "<boolean>",
"e2e_encryption": "<boolean>",
"entry_exit_chime": "<string>",
"far_end_camera_control": "<boolean>",
"feedback": "<boolean>",
"file_transfer": "<boolean>",
"full_transcript": "<boolean>",
"group_hd": "<boolean>",
"webinar_group_hd": "<boolean>",
"language_interpretation": "<boolean>",
"sign_language_interpretation": "<boolean>",
"manual_captions": "<boolean>",
"meeting_reactions": "<boolean>",
"webinar_reactions": "<boolean>",
"meeting_survey": "<boolean>",
"original_audio": "<boolean>",
"polling": "<boolean>",
"post_meeting_feedback": "<boolean>",
"private_chat": "<boolean>",
"remote_control": "<boolean>",
"non_verbal_feedback": false,
"remote_support": false,
"request_permission_to_unmute_participants": "<boolean>",
"save_caption": "<boolean>",
"save_captions": "<boolean>",
"screen_sharing": "<boolean>",
"sending_default_email_invites": "<boolean>",
"show_meeting_control_toolbar": "<boolean>",
"slide_control": "<boolean>",
"stereo_audio": "<boolean>",
"use_html_format_email": "<boolean>",
"virtual_background": "<boolean>",
"webinar_chat": "<boolean>",
"webinar_live_streaming": "<boolean>",
"webinar_polling": "<boolean>",
"webinar_question_answer": "<boolean>",
"webinar_survey": "<boolean>",
"whiteboard": "<boolean>"
},
"other_options": {
"blur_snapshot": "<boolean>",
"webinar_registration_options": "<boolean>"
},
"recording": {
"account_user_access_recording": "<boolean>",
"auto_delete_cmr": "<boolean>",
"auto_recording": "<boolean>",
"cloud_recording": "<boolean>",
"cloud_recording_download": "<boolean>",
"host_delete_cloud_recording": "<boolean>",
"ip_address_access_control": "<boolean>",
"local_recording": "<boolean>",
"prevent_host_access_recording": "<boolean>",
"recording_authentication": "<boolean>",
"archive": "<boolean>"
},
"schedule_meeting": {
"audio_type": "<boolean>",
"embed_password_in_join_link": "<boolean>",
"enforce_login": "<boolean>",
"enforce_login_domains": "<string>",
"enforce_login_with_domains": "<boolean>",
"host_video": "<boolean>",
"join_before_host": "<boolean>",
"meeting_authentication": "<boolean>",
"not_store_meeting_topic": "<boolean>",
"always_display_zoom_webinar_as_topic": "<boolean>",
"participant_video": "<boolean>",
"require_password_for_instant_meetings": "<boolean>",
"require_password_for_pmi_meetings": "<boolean>",
"require_password_for_scheduling_new_meetings": "<boolean>",
"use_pmi_for_instant_meetings": "<boolean>",
"use_pmi_for_scheduled_meetings": "<boolean>",
"continuous_meeting_chat": "<boolean>"
},
"telephony": {
"telephony_regions": "<boolean>",
"third_party_audio": "<boolean>"
},
"tsp": {
"call_out": "<boolean>",
"show_international_numbers_link": "<boolean>"
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/accounts/:accountId/lock_settings?option=<string>&custom_query_fields=<string>?option=<string>&custom_query_fields=<string>' -H 'Accept: application/json'
ENDPOINTS