Zoom Public API Documentation
Get user settings
GET {{baseUrl}}/users/:userId/settings?login_type=99&option=recording_authentication&custom_query_fields=<string>
Retrieve a user's settings. For user-level apps, pass the Scopes: Rate Limit Label: me value instead of the userId parameter.user:read:admin,user:readMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
login_type
|
number | The user's login method. * `0` - Facebook OAuth * `1` - Google OAuth * `24` - Apple OAuth * `27` - Microsoft OAuth * `97` - Mobile device * `98` - RingCentral OAuth * `99` - API user * `100` - Zoom Work email * `101` - Single Sign-On (SSO) These login methods are only available in China: * `11` - Phone number * `21` - WeChat * `23` - Alipay | |
option
|
string | Optional query parameters. * `meeting_authentication` - Use this query parameter to 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` - Use this query parameter to 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` - 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 to filter the response. For example, if you provide `host_video` as the value of this field, you'll get a response similar to this. { schedule_meeting: { host_video: false } } To provide multiple values, separate them with commas, like `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": false,
"cancel_meeting_reminder": false,
"cloud_recording_available_reminder": "<boolean>",
"jbh_reminder": false,
"recording_available_reminder_alternative_hosts": "<boolean>",
"recording_available_reminder_schedulers": "<boolean>",
"schedule_for_reminder": false
},
"feature": {
"cn_meeting": "<boolean>",
"concurrent_meeting": "Basic",
"in_meeting": "<boolean>",
"large_meeting": "<boolean>",
"large_meeting_capacity": "<integer>",
"meeting_capacity": "<integer>",
"webinar": "<boolean>",
"webinar_capacity": "<integer>",
"zoom_events": "<boolean>",
"zoom_events_capacity": 30000,
"zoom_events_unlimited": "<boolean>",
"zoom_events_unlimited_capacities": [
100
],
"zoom_sessions_unlimited": "<boolean>",
"zoom_sessions_unlimited_capacities": [
50000
],
"zoom_events_pay_per_attendee": "<boolean>",
"zoom_sessions_pay_per_attendee": "<boolean>",
"zoom_phone": "<boolean>",
"zoom_iq_for_sales": "<boolean>",
"zoom_revenue_accelerator": "<boolean>",
"zoom_whiteboard": "<boolean>",
"zoom_whiteboard_plus": "<boolean>",
"zoom_translated_captions": "<boolean>",
"zoom_customer_managed_key": "<boolean>",
"zoom_huddles": "<boolean>",
"zoom_quality_management": "<boolean>",
"zoom_workforce_management": "<boolean>",
"zoom_scheduler": "<boolean>",
"zoom_clips_plus": "<boolean>",
"zoom_mail_calendar": "<boolean>"
},
"in_meeting": {
"allow_host_to_enable_focus_mode": "<boolean>",
"allow_users_to_delete_messages_in_meeting_chat": "<boolean>",
"allow_live_streaming": "<boolean>",
"post_meeting_feedback": "<boolean>",
"whiteboard": "<boolean>",
"allow_participants_chat_with": 2,
"allow_users_save_chats": 3,
"annotation": false,
"attendee_on_hold": false,
"attention_mode_focus_mode": false,
"auto_saving_chat": false,
"breakout_room": false,
"breakout_room_schedule": "<boolean>",
"chat": false,
"meeting_question_answer": "<boolean>",
"closed_caption": false,
"closed_captioning": {
"auto_transcribing": "<boolean>",
"enable": "<boolean>",
"save_caption": "<boolean>",
"third_party_captioning_service": "<boolean>",
"view_full_transcript": "<boolean>"
},
"co_host": false,
"custom_data_center_regions": "<boolean>",
"custom_live_streaming_service": "<boolean>",
"custom_service_instructions": "<string>",
"data_center_regions": [
"CA"
],
"disable_screen_sharing_for_host_meetings": "<boolean>",
"disable_screen_sharing_for_in_meeting_guests": "<boolean>",
"e2e_encryption": "<boolean>",
"entry_exit_chime": "all",
"far_end_camera_control": false,
"feedback": false,
"file_transfer": "<boolean>",
"group_hd": false,
"webinar_group_hd": false,
"join_from_desktop": "<boolean>",
"join_from_mobile": "<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": [
"Spanish"
]
},
"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": false,
"polling": false,
"private_chat": false,
"record_play_voice": "<boolean>",
"remote_control": false,
"remote_support": false,
"request_permission_to_unmute_participants": "<boolean>",
"screen_sharing": "<boolean>",
"share_dual_camera": false,
"show_a_join_from_your_browser_link": "<boolean>",
"show_meeting_control_toolbar": "<boolean>",
"slide_control": "<boolean>",
"unchecked_data_center_regions": [
"EU"
],
"virtual_background": false,
"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": false,
"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": 1,
"default_attendees_chat_with": 1,
"enable": "<boolean>"
},
"webinar_live_streaming": {
"custom_service_instructions": "<string>",
"enable": "<boolean>",
"live_streaming_reminder": "<boolean>",
"live_streaming_service": [
"facebook"
]
},
"meeting_polling": {
"advanced_polls": "<boolean>",
"allow_alternative_host_to_add_edit": "<boolean>",
"require_answers_to_be_anonymous": "<boolean>",
"allow_host_to_upload_image": "<boolean>",
"enable": "<boolean>"
},
"webinar_polling": {
"advanced_polls": "<boolean>",
"allow_alternative_host_to_add_edit": "<boolean>",
"require_answers_to_be_anonymous": "<boolean>",
"allow_host_to_upload_image": "<boolean>",
"enable": "<boolean>"
},
"webinar_survey": "<boolean>",
"who_can_share_screen": "all",
"who_can_share_screen_when_someone_is_sharing": "all",
"participants_share_simultaneously": "one",
"workplace_by_facebook": "<boolean>",
"transfer_meetings_between_devices": "<boolean>",
"allow_show_zoom_windows": "<boolean>"
},
"profile": {
"recording_storage_location": {
"allowed_values": [
"<string>"
],
"value": "<string>"
}
},
"recording": {
"ask_host_to_confirm_disclaimer": "<boolean>",
"ask_participants_to_consent_disclaimer": "<boolean>",
"auto_delete_cmr": false,
"auto_delete_cmr_days": 120,
"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>",
"auto_recording": "local",
"cloud_recording": false,
"host_pause_stop_recording": false,
"ip_address_access_control": {
"enable": "<boolean>",
"ip_addresses_or_ranges": "<string>"
},
"local_recording": "<boolean>",
"record_audio_file": false,
"record_gallery_view": false,
"record_speaker_view": false,
"recording_audio_transcript": "<boolean>",
"recording_disclaimer": "<boolean>",
"smart_recording": {
"create_recording_highlights": "<boolean>",
"create_smart_chapters": "<boolean>",
"create_next_steps": "<boolean>"
},
"recording_password_requirement": {
"have_letter": "<boolean>",
"have_number": "<boolean>",
"have_special_character": "<boolean>",
"length": "<integer>",
"only_allow_numeric": "<boolean>"
},
"save_chat_text": false,
"show_timestamp": false
},
"schedule_meeting": {
"audio_type": "voip",
"default_password_for_scheduled_meetings": "<string>",
"embed_password_in_join_link": "<boolean>",
"force_pmi_jbh_password": "<boolean>",
"host_video": "<boolean>",
"join_before_host": "<boolean>",
"meeting_password_requirement": {
"consecutive_characters_length": 5,
"have_letter": "<boolean>",
"have_number": "<boolean>",
"have_special_character": "<boolean>",
"have_upper_and_lower_characters": "<boolean>",
"length": "<integer>",
"only_allow_numeric": "<boolean>",
"weak_enhance_detection": "<boolean>"
},
"participants_video": "<boolean>",
"personal_meeting": "<boolean>",
"pmi_password": "<string>",
"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>",
"use_pmi_for_instant_meetings": "<boolean>",
"use_pmi_for_scheduled_meetings": "<boolean>",
"continuous_meeting_chat": {
"enable": "<boolean>",
"can_add_external_users": "<boolean>",
"auto_add_invited_external_users": "<boolean>"
}
},
"telephony": {
"audio_conference_info": "",
"show_international_numbers_link": "<boolean>",
"telephony_regions": {
"allowed_values": [
"<string>"
],
"selection_values": "<string>"
},
"third_party_audio": "<boolean>"
},
"tsp": {
"call_out": "<boolean>",
"show_international_numbers_link": "<boolean>"
},
"whiteboard": {
"out_meeting_advanced_whiteboard": "<boolean>",
"in_meeting_advanced_whiteboard": "<boolean>"
}
} |
Curl
curl -X GET 'https://api.zoom.us/v2/users/:userId/settings?login_type=99&option=recording_authentication&custom_query_fields=<string>?login_type=99&option=recording_authentication&custom_query_fields=<string>' -H 'Accept: application/json'
ENDPOINTS