Logo
Zoom Public API Documentation

Get locked settings

GET {{baseUrl}}/groups/:groupId/lock_settings?option=<string>

Retrieve a group's locked settings. If you lock a setting, the group members will not be able to modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is to be deprecated on September 22, 2019. This field is replaced by another field that will provide the same functionality.

Prerequisite: Pro, Business, or Education account

Scopes: group:read:admin

Rate Limit Label: MEDIUM

 

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.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "audio_conferencing": { "toll_free_and_fee_based_toll_call": "<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>", "attendee_on_hold": 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>", "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>", "non_verbal_feedback": "<boolean>", "original_audio": "<boolean>", "polling": "<boolean>", "post_meeting_feedback": "<boolean>", "private_chat": "<boolean>", "remote_control": "<boolean>", "remote_support": "<boolean>", "request_permission_to_unmute_participants": "<boolean>", "save_caption": "<boolean>", "save_captions": "<boolean>", "screen_sharing": "<boolean>", "sending_default_email_invites": "<boolean>", "show_a_join_from_your_browser_link": "<boolean>", "show_browser_join_link": "<boolean>", "show_meeting_control_toolbar": "<boolean>", "slide_control": "<boolean>", "stereo_audio": "<boolean>", "use_html_format_email": "<boolean>", "virtual_background": "<boolean>", "waiting_room": "<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>" }, "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": { "enable": "<boolean>", "ip_addresses_or_ranges": "<string>" }, "local_recording": "<boolean>", "prevent_host_access_recording": "<boolean>", "recording_authentication": "<boolean>", "archive": "<boolean>" }, "schedule_meeting": { "audio_type": "<boolean>", "embed_password_in_join_link": "<boolean>", "force_pmi_jbh_password": "<boolean>", "host_video": "<boolean>", "join_before_host": "<boolean>", "meeting_authentication": "<boolean>", "mute_upon_entry": "<boolean>", "participant_video": "<boolean>", "pstn_password_protected": "<boolean>", "require_password_for_instant_meetings": "<boolean>", "require_password_for_pmi_meetings": "<boolean>", "require_password_for_scheduling_new_meetings": "<boolean>", "upcoming_meeting_reminder": "<boolean>", "continuous_meeting_chat": "<boolean>" }, "telephony": { "telephony_regions": "<boolean>", "third_party_audio": "<boolean>" } }



Curl
curl -X GET 'https://api.zoom.us/v2/groups/:groupId/lock_settings?option=<string>?option=<string>' -H 'Accept: application/json'

ENDPOINTS