Logo
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: account:read:admin

Rate Limit Label: MEDIUM

 

Body PARAM

Key Datatype Required Description 
option
string Optional query parameters: * `meeting_security` &mdash; 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 &quot;host_video&quot; as the value of this field, you will get a response similar to the following: { &quot;schedule_meeting&quot;: { &quot;host_video&quot;: false } } You can provide multiple values by separating them with commas(example: &quot;host_video,participant_video&rdquo;).



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_rem
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