Logo
Zoom Public API Documentation

Get a group's settings

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

Get settings for a group. 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_authentication` - View the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. * `recording_authentication` - View the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. * `meeting_security` - View the meeting security settings applied to the user's account.
custom_query_fields
string Provide the name of the field to use to filter the response. For example, if you provide `host_video` as the value of this field, you will get a response similar to this: { `schedule_meeting`: { `host_video`: false } } Provide multiple values by separating them with commas, such as `host_video,participant_video`.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "audio_conferencing": { "toll_free_and_fee_based_toll_call": { "allow_webinar_attendees_dial": "<boolean>", "enable": "<boolean>", "numbers": [ { "code": "<string>", "country_code": "<string>", "country_name": "<string>", "display_number": "<string>", "number": "<string>" } ] } }, "email_notification": { "alternative_host_reminder": "<boolean>", "cancel_meeting_reminder": "<boolean>", "cloud_recording_available_reminder": "<boolean>", "jbh_reminder": "<boolean>", "recording_available_reminder_alternative_hosts": "<boolean>", "recording_available_reminder_schedulers": "<boolean>", "schedule_for_reminder": "<boolean>" }, "in_meeting": { "alert_guest_join": "<boolean>", "allow_users_to_delete_messages_in_meeting_chat": "<boolean>
Curl
curl -X GET 'https://api.zoom.us/v2/groups/:groupId/settings?option=recording_authentication&custom_query_fields=<string>?option=recording_authentication&custom_query_fields=<string>' -H 'Accept: application/json'

ENDPOINTS