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: Rate Limit Label: group:read:adminMEDIUM
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>",
"allow_live_streaming": "<boolean>",
"allow_participants_chat_with": 4,
"allow_show_zoom_windows": "<boolean>",
"allow_users_save_chats": 2,
"annotation": "<boolean>",
"attendee_on_hold": false,
"auto_answer": "<boolean>",
"auto_saving_chat": "<boolean>",
"breakout_room": "<boolean>",
"breakout_room_schedule": "<boolean>",
"chat": "<boolean>",
"meeting_question_answer": "<boolean>",
"closed_caption": "<boolean>",
"closed_captioning": {
"auto_transcribing": "<boolean>",
"enable": "<boolean>",
"save_caption": "<boolean>",
"third_party_captioning_service": "<boolean>",
"view_full_transcript": "<boolean>"
},
"co_host": "<boolean>",
"custom_data_center_regions": "<boolean>",
"custom_live_streaming_service": "<boolean>",
"custom_service_instructions": "<string>",
"data_center_regions": [
"HK"
],
"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>",
"group_hd": "<boolean>",
"webinar_group_hd": "<boolean>",
"join_from_desktop": "<boolean>",
"join_from_mobile": "<boolean>",
"auto_generated_translation": {
"language_item_pairList": {
"trans_lang_config": [
{
"speak_language": {
"name": "Spanish",
"code": "uk"
},
"translate_to": {
"all": "<boolean>",
"language_config": [
{
"name": "English",
"code": "en"
}
]
}
}
],
"all": "<boolean>"
},
"enable": "<boolean>"
},
"language_interpretation": {
"custom_languages": [
"<string>"
],
"enable_language_interpretation_by_default": "<boolean>",
"allow_participants_to_speak_in_listening_channel": "<boolean>",
"allow_up_to_25_custom_languages_when_scheduling_meetings": "<boolean>",
"enable": "<boolean>",
"languages": "Portuguese"
},
"sign_language_interpretation": {
"enable": "<boolean>",
"enable_sign_language_interpretation_by_default": "<boolean>",
"languages": [
"French"
],
"custom_languages": [
"<string>"
]
},
"live_streaming_facebook": "<boolean>",
"live_streaming_youtube": "<boolean>",
"manual_captioning": {
"allow_to_type": "<boolean>",
"auto_generated_captions": "<boolean>",
"full_transcript": "<boolean>",
"manual_captions": "<boolean>",
"save_captions": "<boolean>",
"third_party_captioning_service": "<boolean>"
},
"meeting_reactions": "<boolean>",
"meeting_reactions_emojis": "selected",
"allow_host_panelists_to_use_audible_clap": "<boolean>",
"webinar_reactions": "<boolean>",
"meeting_survey": "<boolean>",
"non_verbal_feedback": "<boolean>",
"only_host_view_device_list": "<boolean>",
"original_audio": "<boolean>",
"polling": "<boolean>",
"post_meeting_feedback": "<boolean>",
"private_chat": "<boolean>",
"record_play_own_voice": "<boolean>",
"remote_control": "<boolean>",
"remote_support": "<boolean>",
"request_permission_to_unmute_participants": "<boolean>",
"screen_sharing": "<boolean>",
"sending_default_email_invites": "<boolean>",
"show_a_join_from_your_browser_link": "<boolean>",
"show_browser_join_link": "<boolean>",
"show_device_list": "<boolean>",
"show_meeting_control_toolbar": "<boolean>",
"slide_control": "<boolean>",
"stereo_audio": "<boolean>",
"unchecked_data_center_regions": "IN",
"use_html_format_email": "<boolean>",
"virtual_background": "<boolean>",
"virtual_background_settings": {
"allow_upload_custom": "<boolean>",
"allow_videos": "<boolean>",
"enable": "<boolean>",
"files": [
{
"id": "<string>",
"is_default": "<boolean>",
"name": "<string>",
"size": "<integer>",
"type": "<string>"
}
]
},
"waiting_room": "<boolean>",
"webinar_chat": {
"allow_attendees_chat_with": 1,
"allow_auto_save_local_chat_file": "<boolean>",
"allow_panelists_chat_with": 2,
"allow_panelists_send_direct_message": "<boolean>",
"allow_users_save_chats": 2,
"default_attendees_chat_with": 2,
"enable": "<boolean>"
},
"webinar_live_streaming": {
"custom_service_instructions": "<string>",
"enable": "<boolean>",
"live_streaming_reminder": "<boolean>",
"live_streaming_service": [
"custom_live_streaming_service"
]
},
"meeting_polling": {
"enable": "<boolean>",
"advanced_polls": "<boolean>",
"manage_saved_polls_and_quizzes": "<boolean>",
"require_answers_to_be_anonymous": "<boolean>",
"allow_alternative_host_to_add_edit": "<boolean>",
"allow_host_to_upload_image": "<boolean>"
},
"webinar_polling": {
"enable": "<boolean>",
"advanced_polls": "<boolean>",
"manage_saved_polls_and_quizzes": "<boolean>",
"require_answers_to_be_anonymous": "<boolean>",
"allow_host_to_upload_image": "<boolean>",
"allow_alternative_host_to_add_edit": "<boolean>"
},
"webinar_question_answer": "<boolean>",
"webinar_survey": "<boolean>",
"whiteboard": "<boolean>",
"who_can_share_screen": "host",
"who_can_share_screen_when_someone_is_sharing": "all",
"participants_share_simultaneously": "multiple",
"workplace_by_facebook": "<boolean>"
},
"other_options": {
"allow_users_contact_support_via_chat": "<boolean>",
"blur_snapshot": "<boolean>",
"webinar_registration_options": {
"allow_host_to_enable_join_info": "<boolean>",
"allow_host_to_enable_social_share_buttons": "<boolean>",
"enable_custom_questions": "<boolean>"
}
},
"profile": {
"recording_storage_location": {
"allowed_values": [
"<string>"
],
"value": "<string>"
}
},
"recording": {
"account_user_access_recording": "<boolean>",
"archive": {
"enable": "<boolean>",
"settings": {
"audio_file": "<boolean>",
"cc_transcript_file": "<boolean>",
"chat_file": "<boolean>",
"chat_with_sender_email": "<boolean>",
"video_file": "<boolean>",
"chat_with_direct_message": "<boolean>",
"archive_retention": 27,
"action_when_archive_failed": 1,
"notification_when_archiving_starts": "guest",
"play_voice_prompt_when_archiving_starts": "guest"
},
"type": 2
},
"auto_recording": "<string>",
"cloud_recording": "<boolean>",
"cloud_recording_download": "<boolean>",
"cloud_recording_download_host": "<boolean>",
"host_delete_cloud_recording": "<boolean>",
"record_files_separately": {
"active_speaker": "<boolean>",
"gallery_view": "<boolean>",
"shared_screen": "<boolean>"
},
"display_participant_name": "<boolean>",
"recording_thumbnails": "<boolean>",
"optimize_recording_for_3rd_party_video_editor": "<boolean>",
"recording_highlight": "<boolean>",
"save_panelist_chat": "<boolean>",
"save_poll_results": "<boolean>",
"save_close_caption": "<boolean>",
"ip_address_access_control": {
"enable": "<boolean>",
"ip_addresses_or_ranges": "<string>"
},
"local_recording": "<boolean>",
"prevent_host_access_recording": "<boolean>",
"record_audio_file": "<boolean>",
"record_gallery_view": "<boolean>",
"record_speaker_view": "<boolean>",
"recording_audio_transcript": "<boolean>",
"smart_recording": {
"create_recording_highlights": "<boolean>",
"create_smart_chapters": "<boolean>",
"create_next_steps": "<boolean>"
},
"save_chat_text": "<boolean>",
"show_timestamp": "<boolean>"
},
"schedule_meeting": {
"audio_type": "<string>",
"embed_password_in_join_link": "<boolean>",
"force_pmi_jbh_password": "<boolean>",
"host_video": "<boolean>",
"join_before_host": "<boolean>",
"mute_upon_entry": "<boolean>",
"participant_video": "<boolean>",
"personal_meeting": "<boolean>",
"pstn_password_protected": "<boolean>",
"require_password_for_instant_meetings": "<boolean>",
"require_password_for_pmi_meetings": "all",
"require_password_for_scheduled_meetings": "<boolean>",
"require_password_for_scheduling_new_meetings": "<boolean>",
"upcoming_meeting_reminder": "<boolean>",
"use_pmi_for_instant_meetings": "<boolean>",
"use_pmi_for_schedule_meetings": "<boolean>",
"always_display_zoom_meeting_as_topic": {
"enable": "<boolean>",
"display_topic_for_scheduled_meetings": "<boolean>"
},
"always_display_zoom_webinar_as_topic": {
"enable": "<boolean>",
"display_topic_for_scheduled_webinars": "<boolean>"
},
"continuous_meeting_chat": {
"enable": "<boolean>",
"can_add_external_users": "<boolean>",
"auto_add_invited_external_users": "<boolean>"
}
},
"telephony": {
"audio_conference_info": "<string>",
"telephony_regions": {
"selection_values": "<string>"
},
"third_party_audio": "<boolean>"
},
"chat": {
"share_files": {
"enable": "<boolean>",
"share_option": "organization"
},
"chat_emojis": {
"enable": "<boolean>",
"emojis_option": "selected"
},
"record_voice_messages": "<boolean>",
"record_video_messages": "<boolean>",
"screen_capture": "<boolean>",
"create_public_channels": "<boolean>",
"create_private_channels": "<boolean>",
"share_links_in_chat": "<boolean>",
"schedule_meetings_in_chat": "<boolean>",
"set_retention_period_in_cloud": {
"enable": "<boolean>",
"retention_period_of_direct_messages_and_group_conversation": "<string>",
"retention_period_of_channels": "<string>"
},
"set_retention_period_in_local": {
"enable": "<boolean>",
"retention_period_of_direct_messages_and_group_conversation": "<string>",
"retention_period_of_channels": "<string>"
},
"allow_users_to_search_others_options": "<string>",
"allow_users_to_add_contacts": {
"enable": "<boolean>",
"selected_option": 1,
"user_email_addresses": "<string>"
},
"allow_users_to_chat_with_others": {
"enable": "<boolean>",
"selected_option": 4,
"user_email_addresses": "<string>"
},
"chat_etiquette_tool": {
"enable": "<boolean>",
"policies": [
{
"description": "<string>",
"id": "<string>",
"is_locked": "<boolean>",
"keywords": [
"<string>"
],
"name": "<string>",
"regular_expression": "<string>",
"status": "activated",
"trigger_action": 2
}
]
},
"send_data_to_third_party_archiving_service": {
"enable": "<boolean>"
},
"translate_messages": "<boolean>",
"search_and_send_animated_gif_images": {
"enable": "<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