This reference lists the available Zoom OAuth API endpoints and granular scopes.
Zoom Meeting
The following are the available Zoom Meeting APIs and their associated granular scopes.
Archiving
| API endpoint | granular scope |
|---|---|
| Get a meeting's archived files | archiving:read:archived_files:admin archiving:read:archived_files |
| Get archived file statistics | archiving:read:archived_file_statistics:admin |
| Get a meeting's archive token for local archiving | meeting:read:local_archiving_token:admin |
| List archived files | archiving:read:list_archived_files:admin archiving:read:list_archived_files:master |
| List archived files | archiving:read:list_archived_files:master |
| Update an archived file's auto-delete status | archiving:update:archived_file_auto_delete_status archiving:update:archived_file_auto_delete_status:admin |
| Delete a meeting's archived files | archiving:delete:archived_files:admin |
Cloud Recording
| API endpoint | granular scope |
|---|---|
| Get a meeting or webinar recording's analytics details | cloud_recording:read:recording_analytics_details cloud_recording:read:recording_analytics_details:master cloud_recording:read:recording_analytics_details:admin |
| Get a meeting or webinar recording's analytics details | cloud_recording:read:recording_analytics_details:master |
| Recover meeting recordings | cloud_recording:update:recover_meeting_recordings cloud_recording:update:recover_meeting_recordings:master cloud_recording:update:recover_meeting_recordings:admin |
| Recover meeting recordings | cloud_recording:update:recover_meeting_recordings:master |
| Get meeting recording settings | cloud_recording:read:recording_settings cloud_recording:read:recording_settings:admin cloud_recording:read:recording_settings:master |
| Get meeting recording settings | cloud_recording:read:recording_settings:master |
| Get registration questions | cloud_recording:read:registration_questions cloud_recording:read:registration_questions:master cloud_recording:read:registration_questions:admin |
| Get registration questions | cloud_recording:read:registration_questions:master |
| Create a recording registrant | cloud_recording:write:recording_registrant cloud_recording:write:recording_registrant:master cloud_recording:write:recording_registrant:admin |
| Create a recording registrant | cloud_recording:write:recording_registrant:master |
| List an account's recordings | cloud_recording:read:list_account_recordings:master cloud_recording:read:list_account_recordings:admin |
| Update a registrant's status | cloud_recording:update:registrant_status cloud_recording:update:registrant_status:master cloud_recording:update:registrant_status:admin |
| Update a registrant's status | cloud_recording:update:registrant_status:master |
| Get meeting recordings | cloud_recording:read:list_recording_files:admin cloud_recording:read:list_recording_files cloud_recording:read:list_recording_files:master |
| Get meeting recordings | cloud_recording:read:list_recording_files:master |
| Get a meeting or webinar recording's analytics summary | cloud_recording:read:recording_analytics_summary cloud_recording:read:recording_analytics_summary:master cloud_recording:read:recording_analytics_summary:admin |
| Get a meeting or webinar recording's analytics summary | cloud_recording:read:recording_analytics_summary:master |
| Recover a single recording | cloud_recording:update:recover_single_recording cloud_recording:update:recover_single_recording:master cloud_recording:update:recover_single_recording:admin |
| Recover a single recording | cloud_recording:update:recover_single_recording:master |
| List recording registrants | cloud_recording:read:list_recording_registrants cloud_recording:read:list_recording_registrants:admin cloud_recording:read:list_recording_registrants:master |
| List recording registrants | cloud_recording:read:list_recording_registrants:master |
| Delete a recording file for a meeting or webinar | cloud_recording:delete:recording_file cloud_recording:delete:recording_file:admin cloud_recording:delete:recording_file:master |
| Delete a recording file for a meeting or webinar | cloud_recording:delete:recording_file:master |
| Delete meeting or webinar recordings | cloud_recording:delete:meeting_recording cloud_recording:delete:meeting_recording:admin cloud_recording:delete:meeting_recording:master |
| Delete meeting or webinar recordings | cloud_recording:delete:meeting_recording:master |
| Update meeting recording settings | cloud_recording:update:recording_settings cloud_recording:update:recording_settings:master cloud_recording:update:recording_settings:admin |
| Update meeting recording settings | cloud_recording:update:recording_settings:master |
| List all recordings | cloud_recording:read:list_user_recordings cloud_recording:read:list_user_recordings:master cloud_recording:read:list_user_recordings:admin |
| List all recordings | cloud_recording:read:list_user_recordings:master |
| Update registration questions | cloud_recording:update:registration_questions:admin cloud_recording:update:registration_questions cloud_recording:update:registration_questions:master |
| Update registration questions | cloud_recording:update:registration_questions:master |
Devices
| API endpoint | granular scope |
|---|---|
| Upgrade ZPA firmware or app | device:write:zpa_os_app:admin device:write:zpa_os_app:master |
| Get ZPA version info | device:read:list_zpa_versions:admin device:read:list_zpa_versions:master |
| Assign a device to a user or commonarea | device:write:zpa_device:admin device:write:zpa_device:master |
| Delete ZPA device by vendor and mac address | device:delete:zpa_device:admin device:delete:zpa_device:master |
| Get ZDM group info | device:read:list_groups:admin device:read:list_groups:master |
| Assign a device to a group | device:write:group:admin device:write:group:master |
| Get Zoom Phone Appliance settings by user ID | device:read:user_setting:admin device:read:user_setting:master |
| Change device association | device:update:zdm_device_assignment:admin |
H323 Devices
| API endpoint | granular scope |
|---|---|
| Create a H.323/SIP device | h323_device:write:device:admin |
| Delete a H.323/SIP device | h323_device:delete:device:admin |
| Update a H.323/SIP device | h323_device:update:device:admin |
| List all H.323/SIP devices | h323_device:read:list_devices:admin |
In-Meeting Apps
| API endpoint | granular scope |
|---|---|
| Add a meeting app | meeting:write:open_app meeting:write:open_app:admin |
| Delete a meeting app | meeting:delete:open_app meeting:delete:open_app:admin |
In-Meeting Features
| API endpoint | granular scope |
|---|---|
| Get a meeting's join token for local recording | meeting:read:local_recording_token meeting:read:local_recording_token:admin |
| Get meeting's token | meeting:read:token meeting:read:token:admin |
| Get meeting's token | meeting:read:token:master |
| Delete a live meeting message | meeting:delete:live_meeting_chat_message meeting:delete:live_meeting_chat_message:admin |
| In-meeting controls | meeting:update:in_meeting_controls meeting:update:in_meeting_controls:admin |
| In-meeting controls | meeting:update:in_meeting_controls:master |
| Update a live meeting message | meeting:update:live_meeting_chat_message meeting:update:live_meeting_chat_message:admin |
Invitation & Registration
| API endpoint | granular scope |
|---|---|
| Delete a meeting registrant | meeting:delete:registrant meeting:delete:registrant:admin |
| Delete a meeting registrant | meeting:delete:registrant:master |
| Perform batch registration | meeting:write:batch_registrants meeting:write:batch_registrants:admin |
| Perform batch registration | meeting:write:batch_registrants:master |
| Get meeting invitation | meeting:read:invitation meeting:read:invitation:admin |
| Get meeting invitation | meeting:read:invitation:master |
| Add a meeting registrant | meeting:write:registrant meeting:write:registrant:admin |
| Add a meeting registrant | meeting:write:registrant:master |
| Update registration questions | meeting:update:registration_question meeting:update:registration_question:admin |
| Update registration questions | meeting:update:registration_question:master |
| Update registrant's status | meeting:update:registrant_status meeting:update:registrant_status:admin |
| Update registrant's status | meeting:update:registrant_status:master |
| Create a meeting's invite links | meeting:write:invite_links meeting:write:invite_links:admin |
| Create a meeting's invite links | meeting:write:invite_links:master |
| List meeting registrants | meeting:read:list_registrants meeting:read:list_registrants:admin |
| List meeting registrants | meeting:read:list_registrants:master |
| List registration questions | meeting:read:list_registration_questions meeting:read:list_registration_questions:admin |
| Get a meeting registrant | meeting:read:registrant meeting:read:registrant:admin |
| Get a meeting registrant | meeting:read:registrant:master |
Live streaming
| API endpoint | granular scope |
|---|---|
| Update a livestream | meeting:update:livestream meeting:update:livestream:admin |
| Update a livestream | meeting:update:livestream:master |
| Update livestream status | meeting:update:livestream_status meeting:update:livestream_status:admin |
| Update livestream status | meeting:update:livestream_status:master |
| Get livestream details | meeting:read:livestream meeting:read:livestream:admin |
| Get livestream details | meeting:read:livestream:master |
| Get a meeting's join token for live streaming | meeting:read:live_streaming_token meeting:read:live_streaming_token:admin |
Meeting Transcript
| API endpoint | granular scope |
|---|---|
| Get a meeting transcript | cloud_recording:read:meeting_transcript cloud_recording:read:meeting_transcript:admin |
| Delete a meeting or webinar transcript | cloud_recording:delete:meeting_transcript cloud_recording:delete:meeting_transcript:admin |
Meetings
| API endpoint | granular scope |
|---|---|
| Get a meeting SIP URI with passcode | meeting:write:sip_dialing meeting:write:sip_dialing:admin |
| Update meeting status | meeting:update:status meeting:update:status:admin |
| Update meeting status | meeting:update:status:master |
| Get past meeting details | meeting:read:past_meeting meeting:read:past_meeting:admin |
| Get a meeting | meeting:read:meeting meeting:read:meeting:admin |
| Get a meeting | meeting:read:meeting:master |
| Update a meeting | meeting:update:meeting:admin meeting:update:meeting |
| Update a meeting | meeting:update:meeting:master |
| Delete a meeting | meeting:delete:meeting meeting:delete:meeting:admin |
| Delete a meeting | meeting:delete:meeting:master |
| List meetings | meeting:read:list_meetings meeting:read:list_meetings:admin |
| List meetings | meeting:read:list_meetings:master |
| Update participant Real-Time Media Streams (RTMS) app status | meeting:update:participant_rtms_app_status meeting:update:participant_rtms_app_status:admin |
| Get past meeting participants | meeting:read:list_past_participants meeting:read:list_past_participants:admin |
| Create a meeting | meeting:write:meeting meeting:write:meeting:admin |
| Create a meeting | meeting:write:meeting:master |
| List upcoming meetings | meeting:read:list_upcoming_meetings meeting:read:list_upcoming_meetings:admin |
| List past meetings' Q&A | meeting:read:past_qa meeting:read:past_qa:admin |
| List past meeting instances | meeting:read:list_past_instances meeting:read:list_past_instances:admin |
| List past meeting instances | meeting:read:list_past_instances:master |
PAC
| API endpoint | granular scope |
|---|---|
| List a user's PAC accounts | pac:read:list_pac_accounts pac:read:list_pac_accounts:admin |
| List a user's PAC accounts | pac:read:list_pac_accounts:master |
Polls
| API endpoint | granular scope |
|---|---|
| Delete a meeting poll | meeting:delete:poll meeting:delete:poll:admin |
| Delete a meeting poll | meeting:delete:poll:master |
| List meeting polls | meeting:read:list_polls meeting:read:list_polls:admin |
| List meeting polls | meeting:read:list_polls:master |
| List past meeting's poll results | meeting:read:list_poll_results meeting:read:list_poll_results:admin |
| Perform batch poll creation | meeting:write:batch_polls meeting:write:batch_polls:admin |
| Perform batch poll creation | meeting:write:batch_polls:master |
| Create a meeting poll | meeting:write:poll meeting:write:poll:admin |
| Create a meeting poll | meeting:write:poll:master |
| Get a meeting poll | meeting:read:poll meeting:read:poll:admin |
| Get a meeting poll | meeting:read:poll:master |
| Update a meeting poll | meeting:update:poll meeting:update:poll:admin |
| Update a meeting poll | meeting:update:poll:master |
Reports
| API endpoint | granular scope |
|---|---|
| Get disclaimer report | report:read:disclaimer:admin |
| Get disclaimer report | report:read:disclaimer:master |
| Get a meeting activities report | report:read:meeting_activity_log:admin |
| Get a meeting activities report | report:read:meeting_activity_log:master |
| Get telephone reports | report:read:telephone:admin |
| Get telephone reports | report:read:telephone:master |
| Get meeting detail reports | report:read:meeting:admin |
| Get meeting detail reports | report:read:meeting:master |
| Get operation logs report | report:read:operation_logs:admin |
| Get operation logs report | report:read:operation_logs:master |
| Get meeting Q&A report | report:read:meeting_qna:admin |
| Get meeting Q&A report | report:read:meeting_qna:master |
| Get history meeting and webinar list | report:read:list_history_meetings:admin |
| Get history meeting and webinar list | report:read:list_history_meetings:master |
| Get remote support report | report:read:remote_support:admin |
| Get remote support report | report:read:remote_support:master |
| Get webinar poll reports | report:read:list_webinar_polls:admin |
| Get webinar poll reports | report:read:list_webinar_polls:master |
| Get webinar Q&A report | report:read:webinar_qna:admin |
| Get webinar Q&A report | report:read:webinar_qna:master |
| Get sign In / sign out activity report | report:read:user_activities:admin |
| Get sign In / sign out activity report | report:read:user_activities:master |
| Get meeting poll reports | report:read:list_meeting_polls:admin |
| Get meeting poll reports | report:read:list_meeting_polls:master |
| Get meeting reports | report:read:user:admin |
| Get meeting reports | report:read:user:master |
| Get active or inactive host reports | report:read:list_users:admin |
| Get active or inactive host reports | report:read:list_users:master |
| Get webinar participant reports | report:read:list_webinar_participants:admin |
| Get webinar participant reports | report:read:list_webinar_participants:master |
| Get upcoming events reports | report:read:upcoming_meetings_webinars:admin |
| Get upcoming events reports | report:read:upcoming_meetings_webinars:master |
| Get webinar survey report | report:read:webinar_survey:admin |
| Get webinar survey report | report:read:webinar_survey:master |
| Get meeting participant reports | report:read:list_meeting_participants:admin |
| Get meeting participant reports | report:read:list_meeting_participants:master |
| Get billing reports | report:read:billing:admin |
| Get billing reports | report:read:billing:master |
| Get webinar detail reports | report:read:webinar:admin |
| Get webinar detail reports | report:read:webinar:master |
| Get billing invoice reports | report:read:billing_invoice:admin |
| Get billing invoice reports | report:read:billing_invoice:master |
| Get meeting survey report | report:read:meeting_survey:admin |
| Get meeting survey report | report:read:meeting_survey:master |
SIP Connected Audio
| API endpoint | granular scope |
|---|---|
| List internal call-out countries | sip_connected_audio:read:callout_countries:master sip_connected_audio:read:callout_countries:admin |
| List internal numbers | sip_connected_audio:read:internal_numbers:master sip_connected_audio:read:internal_numbers:admin |
| Add internal call-out countries | sip_connected_audio:write:callout_countries:admin sip_connected_audio:write:callout_countries:master |
| Assign SIP trunk configuration | sip_connected_audio:update:settings:master sip_connected_audio:update:settings:admin |
| Add internal numbers | sip_connected_audio:write:internal_numbers:admin sip_connected_audio:write:internal_numbers:master |
| Get SIP trunk configuration | sip_connected_audio:read:settings:master sip_connected_audio:read:settings:admin |
| List SIP trunks | sip_connected_audio:read:trunks:master sip_connected_audio:read:trunks:admin |
| Assign SIP trunks | sip_connected_audio:write:trunks:master |
| Delete a SIP trunk | sip_connected_audio:delete:trunks:master |
| Delete all numbers | sip_connected_audio:delete:numbers:master |
| Assign numbers | sip_connected_audio:write:numbers:master |
| Delete an internal number | sip_connected_audio:delete:internal_numbers:admin sip_connected_audio:delete:internal_numbers:master |
| List SIP trunk numbers | sip_connected_audio:read:numbers:master |
| Update an internal number | sip_connected_audio:update:internal_numbers:master sip_connected_audio:update:internal_numbers:admin |
| Delete internal call-out country | sip_connected_audio:delete:callout_countries:master sip_connected_audio:delete:callout_countries:admin |
SIP Phone
| API endpoint | granular scope |
|---|---|
| Enable SIP phone | sip_phone:write:sip_phone:admin |
| Enable SIP phone | sip_phone:write:sip_phone:master |
| Update SIP phone | sip_phone:update:sip_phone:admin |
| Update SIP phone | sip_phone:update:sip_phone:master |
| List SIP phones | sip_phone:read:list_sip_phones:admin |
| List SIP phones | sip_phone:read:list_sip_phones:master |
| Delete SIP phone | sip_phone:delete:sip_phone:admin |
| Delete SIP phone | sip_phone:delete:sip_phone:master |
Summaries
| API endpoint | granular scope |
|---|---|
| List an account's meeting or webinar summaries | meeting:read:list_summaries:admin |
| List an account's meeting or webinar summaries | meeting:read:list_summaries:master |
| Delete a meeting or webinar summary | meeting:delete:summary meeting:delete:summary:admin |
| Delete a meeting or webinar summary | meeting:delete:summary:master |
| Get a meeting or webinar summary | meeting:read:summary meeting:read:summary:admin |
| Get a meeting or webinar summary | meeting:read:summary:master |
| List a user's meeting or webinar summaries | meeting:read:list_summaries meeting:read:list_summaries:admin |
| List a user's meeting or webinar summaries | meeting:read:list_summaries:master |
Surveys
| API endpoint | granular scope |
|---|---|
| Update a meeting survey | meeting:update:survey meeting:update:survey:admin |
| Update a meeting survey | meeting:update:survey:master |
| Get a meeting survey | meeting:read:survey meeting:read:survey:admin |
| Get a meeting survey | meeting:read:survey:master |
| Delete a meeting survey | meeting:delete:survey meeting:delete:survey:admin |
| Delete a meeting survey | meeting:delete:survey:master |
TSP
| API endpoint | granular scope |
|---|---|
| Add a user's TSP account | tsp:write:tsp_account tsp:write:tsp_account:admin |
| Add a user's TSP account | tsp:write:tsp_account:master |
| Get account's TSP information | tsp:read:tsp:admin |
| Get account's TSP information | tsp:read:tsp:master |
| Update a TSP account | tsp:update:tsp_account tsp:update:tsp_account:admin |
| Update a TSP account | tsp:update:tsp_account:master |
| Delete a user's TSP account | tsp:delete:tsp_account tsp:delete:tsp_account:admin |
| Delete a user's TSP account | tsp:delete:tsp_account:master |
| Set global dial-in URL for a TSP user | tsp:update:tsp_settings tsp:update:tsp_settings:admin |
| Set global dial-in URL for a TSP user | tsp:update:tsp_settings:master |
| Get a user's TSP account | tsp:read:tsp_account tsp:read:tsp_account:admin |
| Get a user's TSP account | tsp:read:tsp_account:master |
| Update an account's TSP information | tsp:update:tsp:admin |
| Update an account's TSP information | tsp:update:tsp:master |
| List user's TSP accounts | tsp:read:list_tsp_accounts tsp:read:list_tsp_accounts:admin |
| List user's TSP accounts | tsp:read:list_tsp_accounts:master |
Templates
| API endpoint | granular scope |
|---|---|
| List meeting templates | meeting:read:list_templates meeting:read:list_templates:admin |
| List meeting templates | meeting:read:list_templates:master |
| Create a meeting template from an existing meeting | meeting:write:template meeting:write:template:admin |
| Create a meeting template from an existing meeting | meeting:write:template:master |
Tracking Field
| API endpoint | granular scope |
|---|---|
| Get a tracking field | tracking_field:read:tracking_field:admin |
| Get a tracking field | tracking_field:read:tracking_field:master |
| Delete a tracking field | tracking_field:delete:tracking_field:admin |
| Delete a tracking field | tracking_field:delete:tracking_field:master |
| List tracking fields | tracking_field:read:list_tracking_fields:admin |
| List tracking fields | tracking_field:read:list_tracking_fields:master |
| Create a tracking field | tracking_field:write:tracking_field:admin |
| Create a tracking field | tracking_field:write:tracking_field:master |
| Update a tracking field | tracking_field:update:tracking_field:admin |
| Update a tracking field | tracking_field:update:tracking_field:master |
Webinars
| API endpoint | granular scope |
|---|---|
| Delete a webinar | webinar:delete:webinar webinar:delete:webinar:admin |
| Delete a webinar | webinar:delete:webinar:master |
| List registration questions | webinar:read:list_registration_questions webinar:read:list_registration_questions:admin |
| List registration questions | webinar:read:list_registration_questions:master |
| Get a webinar's join token for local recording | webinar:read:local_recording_token webinar:read:local_recording_token:admin |
| Create a webinar's poll | webinar:write:poll webinar:write:poll:admin |
| Create a webinar's poll | webinar:write:poll:master |
| Upload a webinar's branding virtual background | webinar:write:branding_virtual_background webinar:write:branding_virtual_background:admin |
| Upload a webinar's branding virtual background | webinar:write:branding_virtual_background:master |
| List a webinar's polls | webinar:read:list_polls webinar:read:list_polls:admin |
| List a webinar's polls | webinar:read:list_polls:master |
| Update registrant's status | webinar:update:registrant_status webinar:update:registrant_status:admin |
| Update registrant's status | webinar:update:registrant_status:master |
| Update a live stream | webinar:update:livestream webinar:update:livestream:admin |
| Update a live stream | webinar:update:livestream:master |
| Remove all panelists | webinar:delete:panelist webinar:delete:panelist:admin |
| Remove all panelists | webinar:delete:panelist:master |
| Update registration questions | webinar:update:registration_question webinar:update:registration_question:admin |
| Update registration questions | webinar:update:registration_question:master |
| Delete a webinar survey | webinar:delete:survey webinar:delete:survey:admin |
| Delete a webinar survey | webinar:delete:survey:master |
| Create a webinar template | webinar:write:template webinar:write:template:admin |
| Create a webinar template | webinar:write:template:master |
| List webinar templates | webinar:read:list_templates webinar:read:list_templates:admin |
| List webinar templates | webinar:read:list_templates:master |
| Get a webinar | webinar:read:webinar webinar:read:webinar:admin |
| Get a webinar | webinar:read:webinar:master |
| Get live stream details | webinar:read:livestream webinar:read:livestream:admin |
| Get live stream details | webinar:read:livestream:master |
| List past webinar instances | webinar:read:list_past_instances webinar:read:list_past_instances:admin |
| List past webinar instances | webinar:read:list_past_instances:master |
| Upload a webinar's branding wallpaper | webinar:write:branding_wallpaper webinar:write:branding_wallpaper:admin |
| Upload a webinar's branding wallpaper | webinar:write:branding_wallpaper:master |
| Get a webinar poll | webinar:read:poll webinar:read:poll:admin |
| Get a webinar poll | webinar:read:poll:master |
| Get a webinar survey | webinar:read:survey webinar:read:survey:admin |
| Get a webinar survey | webinar:read:survey:master |
| Update a webinar poll | webinar:update:poll webinar:update:poll:admin |
| Update a webinar poll | webinar:update:poll:master |
| List past webinar poll results | webinar:read:list_past_polls webinar:read:list_past_polls:admin |
| Get a webinar's archive token for local archiving | webinar:read:local_archiving_token:admin |
| Create a webinar | webinar:write:webinar webinar:write:webinar:admin |
| Create a webinar | webinar:write:webinar:master |
| List webinars | webinar:read:list_webinars webinar:read:list_webinars:admin |
| List webinars | webinar:read:list_webinars:master |
| Set webinar's default branding virtual background | webinar:update:branding_virtual_background webinar:update:branding_virtual_background:admin |
| Set webinar's default branding virtual background | webinar:update:branding_virtual_background:master |
| Get webinar's session branding | webinar:read:branding webinar:read:branding:admin |
| Get webinar's session branding | webinar:read:branding:master |
| Get a webinar's join token for live streaming | webinar:read:live_streaming_token webinar:read:live_streaming_token:admin |
| Delete a webinar's branding wallpaper | webinar:delete:branding_wallpaper webinar:delete:branding_wallpaper:admin |
| Delete a webinar's branding wallpaper | webinar:delete:branding_wallpaper:master |
| Get a webinar SIP URI with passcode | webinar:write:sip_dialing webinar:write:sip_dialing:admin |
| Perform batch registration | webinar:write:batch_registrants webinar:write:batch_registrants:admin |
| Perform batch registration | webinar:write:batch_registrants:master |
| Update a webinar | webinar:update:webinar webinar:update:webinar:admin |
| Update a webinar | webinar:update:webinar:master |
| Update webinar status | webinar:update:status webinar:update:status:admin |
| Update webinar status | webinar:update:status:master |
| Delete a webinar's branding virtual backgrounds | webinar:delete:branding_virtual_background webinar:delete:branding_virtual_background:admin |
| Delete a webinar's branding virtual backgrounds | webinar:delete:branding_virtual_background:master |
| List panelists | webinar:read:list_panelists webinar:read:list_panelists:admin |
| List panelists | webinar:read:list_panelists:master |
| Get webinar absentees | webinar:read:list_absentees webinar:read:list_absentees:admin |
| Get webinar absentees | webinar:read:list_absentees:master |
| Get webinar tracking sources | webinar:read:list_tracking_sources webinar:read:list_tracking_sources:admin |
| Get webinar tracking sources | webinar:read:list_tracking_sources:master |
| Delete a webinar poll | webinar:delete:poll webinar:delete:poll:admin |
| Delete a webinar poll | webinar:delete:poll:master |
| Get webinar's token | webinar:read:token webinar:read:token:admin |
| Get webinar's token | webinar:read:token:master |
| Remove a panelist | webinar:delete:panelist webinar:delete:panelist:admin |
| Remove a panelist | webinar:delete:panelist:master |
| Delete a webinar's branding name tag | webinar:delete:branding_name_tag webinar:delete:branding_name_tag:admin |
| Delete a webinar's branding name tag | webinar:delete:branding_name_tag:master |
| Update a webinar's branding name tag | webinar:update:branding_name_tag webinar:update:branding_name_tag:admin |
| Update a webinar's branding name tag | webinar:update:branding_name_tag:master |
| Get a webinar registrant | webinar:read:registrant webinar:read:registrant:admin |
| Get a webinar registrant | webinar:read:registrant:master |
| List Q&As of a past webinar | webinar:read:past_qa webinar:read:past_qa:admin |
| Add panelists | webinar:write:panelist webinar:write:panelist:admin |
| Add panelists | webinar:write:panelist:master |
| Create webinar's invite links | webinar:write:invite_links webinar:write:invite_links:admin |
| Create webinar's invite links | webinar:write:invite_links:master |
| Update live stream status | webinar:update:livestream_status webinar:update:livestream_status:admin |
| Update live stream status | webinar:update:livestream_status:master |
| Update a webinar survey | webinar:update:survey webinar:update:survey:admin |
| Update a webinar survey | webinar:update:survey:master |
| Delete a webinar registrant | webinar:delete:registrant webinar:delete:registrant:admin |
| Delete a webinar registrant | webinar:delete:registrant:master |
| List webinar participants | webinar:read:list_past_participants:admin webinar:read:list_past_participants |
| Create a webinar's branding name tag | webinar:write:branding_name_tag webinar:write:branding_name_tag:admin |
| Create a webinar's branding name tag | webinar:write:branding_name_tag:master |
| List webinar registrants | webinar:read:list_registrants webinar:read:list_registrants:admin |
| List webinar registrants | webinar:read:list_registrants:master |
| Delete a live webinar message | webinar:delete:live_webinar_chat_message webinar:delete:live_webinar_chat_message:admin |
| Add a webinar registrant | webinar:write:registrant webinar:write:registrant:admin |
| Add a webinar registrant | webinar:write:registrant:master |
Zoom Mail
The following are the available Zoom Mail APIs and their associated granular scopes.
Drafts
| API endpoint | granular scope |
|---|---|
| Send out a draft email | email:write:send_draft email:write:send_draft:admin |
| List emails from draft folder | email:read:list_drafts email:read:list_drafts:admin |
| Get the specified draft email | email:read:draft email:read:draft:admin |
| Create a new draft email | email:write:draft email:write:draft:admin |
| Delete an existing draft email | email:delete:draft email:delete:draft:admin |
| Update the specified draft email | email:update:draft email:update:draft:admin |
History
| API endpoint | granular scope |
|---|---|
| List history of events for mailbox | email:read:history email:read:history:admin |
Labels
| API endpoint | granular scope |
|---|---|
| Get the specified label in mailbox | email:read:label email:read:label:admin |
| Update the specified label in mailbox | email:update:label email:update:label:admin |
| List labels in the mailbox | email:read:list_labels email:read:list_labels:admin |
| Create a new label in mailbox | email:write:label email:write:label:admin |
| Delete an existing label from mailbox | email:delete:label email:delete:label:admin |
| Patch the specified label in mailbox | email:update:label email:update:label:admin |
Mailbox
| API endpoint | granular scope |
|---|---|
| Get the mailbox profile | email:read:profile email:read:profile:admin |
Messages
| API endpoint | granular scope |
|---|---|
| Batch delete the specified emails | email:write:batch_delete_msgs email:write:batch_delete_msgs:admin |
| Delete an existing email | email:delete:msg email:delete:msg:admin |
| Move the specified email to TRASH folder | email:write:trash_msg email:write:trash_msg:admin |
| Update the specified email | email:write:modify_msg email:write:modify_msg:admin |
| Send out an email | email:write:send_msg email:write:send_msg:admin |
| List emails from the mailbox | email:read:list_msgs email:read:list_msgs:admin |
| Move the specified email out of TRASH folder | email:write:untrash_msg email:write:untrash_msg:admin |
| Create a new email | email:write:msg email:write:msg:admin |
| Batch modify the specified emails | email:write:batch_modify_msgs email:write:batch_modify_msgs:admin |
| Get the specified email | email:read:msg email:read:msg:admin |
Messages.Attachments
| API endpoint | granular scope |
|---|---|
| Get the specified attachment for an email | email:read:attachment email:read:attachment:admin |
Settings
| API endpoint | granular scope |
|---|---|
| Update mailbox vacation response setting | email:update:setting_vacation email:update:setting_vacation:admin |
| Get mailbox vacation response setting | email:read:setting_vacation email:read:setting_vacation:admin |
Settings.Delegates
| API endpoint | granular scope |
|---|---|
| Revoke an existing delegate access from the mailbox | email:delete:setting_delegate email:delete:setting_delegate:admin |
| List delegates on the mailbox | email:read:list_setting_delegates email:read:list_setting_delegates:admin |
| Grant a new delegate access on the mailbox | email:write:setting_delegate email:write:setting_delegate:admin |
| Get the specified delegate on the mailbox | email:read:setting_delegate email:read:setting_delegate:admin |
Settings.Filters
| API endpoint | granular scope |
|---|---|
| Get the specified email filter | email:read:setting_filter email:read:setting_filter:admin |
| Delete the specified email filter | email:delete:setting_filter email:delete:setting_filter:admin |
| List email filters | email:read:list_setting_filters email:read:list_setting_filters:admin |
| Create an email filter | email:write:setting_filter email:write:setting_filter:admin |
Threads
| API endpoint | granular scope |
|---|---|
| Update the specified thread | email:write:thread email:write:thread:admin |
| Delete an existing email thread | email:delete:thread email:delete:thread:admin |
| Move the specified thread out of TRASH folder | email:write:untrash_thread email:write:untrash_thread:admin |
| Move the specified thread to TRASH folder | email:write:trash_thread email:write:trash_thread:admin |
| Get the specified email thread | email:read:thread email:read:thread:admin |
| List email threads from the mailbox | email:read:list_threads email:read:list_threads:admin |
Whiteboard
The following are the available Whiteboard APIs and their associated granular scopes.
Archiving
| API endpoint | granular scope |
|---|---|
| List whiteboards sessions | whiteboard:read:list_sessions whiteboard:read:list_sessions:admin |
| Download Whiteboards activity file | whiteboard:read:archived_file whiteboard:read:archived_file:admin |
| List whiteboard sessions activities | whiteboard:read:session whiteboard:read:session:admin |
Classification Labels
| API endpoint | granular scope |
|---|---|
| Delete classification label | whiteboard:delete:classification_labels:admin |
| Remove classification from whiteboard | whiteboard:delete:whiteboard_classification whiteboard:delete:whiteboard_classification:admin |
| Apply classification to whiteboard | whiteboard:update:whiteboard_classification whiteboard:update:whiteboard_classification:admin |
| Create a classification label | whiteboard:write:classification_labels:admin |
| Update a classification label | whiteboard:update:classification_labels:admin |
| Get classification label | whiteboard:read:classification_labels:admin |
| List classification labels | whiteboard:read:list_classification_labels:admin whiteboard:read:list_classification_labels |
Collaborator
| API endpoint | granular scope |
|---|---|
| Remove the collaborator from a whiteboard | whiteboard:delete:collaborator:admin whiteboard:delete:collaborator |
| Get collaborators of a whiteboard | whiteboard:read:list_collaborators:admin whiteboard:read:list_collaborators |
| Share a whiteboard to new users or team chat channels. | whiteboard:write:collaborator:admin whiteboard:write:collaborator |
| Update whiteboard collaborators | whiteboard:update:collaborator:admin whiteboard:update:collaborator |
Content
| API endpoint | granular scope |
|---|---|
| Delete Whiteboard Content | whiteboard:delete:content |
| Get Whiteboard Content | whiteboard:read:content |
| Save Whiteboard Content | whiteboard:write:content |
Document
| API endpoint | granular scope |
|---|---|
| Get a whiteboard | whiteboard:read:whiteboard:admin whiteboard:read:whiteboard |
| Update whiteboard basic information | whiteboard:update:whiteboard:admin |
| Create a new whiteboard | whiteboard:write:whiteboard |
| Delete a whiteboard | whiteboard:delete:whiteboard:admin whiteboard:delete:whiteboard |
| List all whiteboards | whiteboard:read:list_whiteboards:admin whiteboard:read:list_whiteboards |
Export
| API endpoint | granular scope |
|---|---|
| Download whiteboard export | whiteboard:read:export whiteboard:read:export:admin |
| Get whiteboard export generation status | whiteboard:read:export whiteboard:read:export:admin |
| Create whiteboard export | whiteboard:write:export whiteboard:write:export:admin |
File
| API endpoint | granular scope |
|---|---|
| Download Imported Whiteboard File | whiteboard:read:file whiteboard:read:file:admin |
| Upload file for whiteboard import | whiteboard:write:file whiteboard:write:file:admin |
Import
| API endpoint | granular scope |
|---|---|
| Get whiteboard import status | whiteboard:read:import:admin whiteboard:read:import |
| Create a new whiteboard by import | whiteboard:write:import whiteboard:write:import:admin |
Project
| API endpoint | granular scope |
|---|---|
| Share a project to new users | whiteboard:write:project_collaborator whiteboard:write:project_collaborator:admin |
| Move whiteboards to a project | whiteboard:write:project_whiteboard whiteboard:write:project_whiteboard:admin |
| Remove whiteboards from a project | whiteboard:delete:project_whiteboard whiteboard:delete:project_whiteboard:admin |
| Remove the collaborator from a project | whiteboard:delete:project_collaborator:admin whiteboard:delete:project_collaborator |
| Delete a project | whiteboard:delete:project whiteboard:delete:project:admin |
| Update project basic information | whiteboard:update:project:admin whiteboard:update:project |
| Get collaborators of a project | whiteboard:read:project_collaborator whiteboard:read:project_collaborator:admin |
| List subprojects | whiteboard:read:subproject whiteboard:read:subproject:admin |
| Get a project | whiteboard:read:project whiteboard:read:project:admin |
| Update project collaborators | whiteboard:update:project_collaborator whiteboard:update:project_collaborator:admin |
| Create a new project | whiteboard:write:project whiteboard:write:project:admin |
| List all projects | whiteboard:read:list_projects:admin whiteboard:read:list_projects |
| Create a subproject | whiteboard:write:subproject whiteboard:write:subproject:admin |
Settings
| API endpoint | granular scope |
|---|---|
| Update whiteboard share setting | whiteboard:update:share_setting:admin whiteboard:update:share_setting |
Zoom Clips
The following are the available Zoom Clips APIs and their associated granular scopes.
Clips
| API endpoint | granular scope |
|---|---|
| List all clips | clips:read:list_user_clips clips:read:list_user_clips:admin |
| List all clips | clips:read:list_user_clips:master |
| Batch star clips | clips:write:star_clips clips:write:star_clips:admin |
Collaborator
| API endpoint | granular scope |
|---|---|
| Remove the collaborator from a clip | clips:delete:collaborators clips:delete:collaborators:admin |
| Get collaborators of a clip | clips:read:list_collaborator clips:read:list_collaborator:admin |
| Share a clip with new users | clips:write:collaborators clips:write:collaborators:admin |
Comment
| API endpoint | granular scope |
|---|---|
| List clip comments | clips:read:list_comments clips:read:list_comments:admin |
| Delete a comment | clips:delete:comment clips:delete:comment:admin |
Download
| API endpoint | granular scope |
|---|---|
| Download a clip | clips:read:download_clip clips:read:download_clip:admin |
Single
| API endpoint | granular scope |
|---|---|
| Delete a clip(soft delete) | clips:delete:clip clips:delete:clip:admin |
| Get Clip Chapters | clips:read:chapters clips:read:chapters:admin |
| Create Clip Chapters | clips:write:chapters clips:write:chapters:admin |
| Duplicate Clips | clips:write:duplicate |
| Update a clip's basic info | clips:update:clip clips:update:clip:admin |
| Get a clip | clips:read:clip clips:read:clip:admin |
| Update clips share setting | clips:update:share_setting clips:update:share_setting:admin |
Transfer
| API endpoint | granular scope |
|---|---|
| Transfer task status check | clips:read:transfer_task_status:admin |
| Transfer clips owner | clips:write:transfer_owner:admin |
Upload
| API endpoint | granular scope |
|---|---|
| Temporary file upload API for Clips | clips:write:uploadTempFile clips:write:uploadTempFile:admin |
Zoom Account
The following are the available Zoom Account APIs and their associated granular scopes.
Accounts
| API endpoint | granular scope |
|---|---|
| Upload virtual background files | account:write:virtual_background_files:master account:write:virtual_background_files:admin |
| Upload virtual background files | account:write:virtual_background_files:master |
| Update an account's webinar registration settings | account:update:registration_settings:master |
| Update an account's webinar registration settings | account:update:registration_settings:master |
| Get sub account details | account:read:sub_account:master account:read:sub_account:admin |
| Update webinar Waiting Room branding | account:write:waiting_room_branding:master account:write:waiting_room_branding:admin |
| Update webinar Waiting Room branding | account:write:waiting_room_branding:master |
| Update meeting Waiting Room branding | account:write:waiting_room_branding:admin account:write:waiting_room_branding:master |
| Update meeting Waiting Room branding | account:write:waiting_room_branding:master |
| Delete virtual background files | account:delete:virtual_background_files:master account:delete:virtual_background_files:admin |
| Delete virtual background files | account:delete:virtual_background_files:master |
| Update account settings | account:update:settings:admin account:update:settings:master |
| Update account settings | account:update:settings:master |
| Update locked settings | account:update:lock_settings:master account:update:lock_settings:admin |
| Update locked settings | account:update:lock_settings:master |
| Get an account's webinar registration settings | account:read:registration_settings:master |
| Get an account's webinar registration settings | account:read:registration_settings:master |
| Create a sub account | account:write:sub_account:master |
| Update the account owner | account:update:owner:master account:update:owner:admin |
| Update the account owner | account:update:owner:master |
| Update options | account:update:options:master |
| Get locked settings | account:read:lock_settings:master |
| Get locked settings | account:read:lock_settings:master |
| Get account's managed domains | account:read:managed_domains:master |
| Get account's managed domains | account:read:managed_domains:master |
| Get account's trusted domains | account:read:trusted_domains:master |
| Get account's trusted domains | account:read:trusted_domains:master |
| Disassociate a sub account | account:delete:sub_account:master |
| List sub accounts | account:read:list_sub_accounts:master |
| Get account settings | account:read:settings:admin account:read:settings:master |
| Get account settings | account:read:settings:master |
Dashboards
| API endpoint | granular scope |
|---|---|
| List meeting participants | dashboard:read:list_meeting_participants:admin |
| List meeting participants | dashboard:read:list_meeting_participants:master |
| Get top 25 issues of Zoom Rooms | dashboard:read:issues_zoomroom:admin |
| Get top 25 issues of Zoom Rooms | dashboard:read:issues_zoomroom:master |
| List client meeting satisfaction | dashboard:read:meeting_survey:admin |
| List client meeting satisfaction | dashboard:read:meeting_survey:master |
| Get webinar participants | dashboard:read:list_webinar_participants:admin |
| Get webinar participants | dashboard:read:list_webinar_participants:master |
| Get meeting participant QoS | dashboard:read:meeting_participant_qos:admin |
| Get meeting participant QoS | dashboard:read:meeting_participant_qos:master |
| Get issues of Zoom Rooms | dashboard:read:issues_zoomroom:admin |
| Get issues of Zoom Rooms | dashboard:read:issues_zoomroom:master |
| List webinars | dashboard:read:list_webinars:admin |
| List webinars | dashboard:read:list_webinars:master |
| Get webinar details | dashboard:read:webinar:admin |
| Get webinar details | dashboard:read:webinar:master |
| List webinar participant QoS | dashboard:read:list_webinar_participants_qos:admin |
| List webinar participant QoS | dashboard:read:list_webinar_participants_qos:master |
| Get zoom meetings client feedback | dashboard:read:meeting_feedback:admin |
| Get zoom meetings client feedback | dashboard:read:meeting_feedback:master |
| Get AI usage trend | dashboard:read:ai_usage_trend:admin |
| Get AI usage trend | dashboard:read:ai_usage_trend:master |
| Get Zoom Rooms details | dashboard:read:zoomroom:admin |
| Get Zoom Rooms details | dashboard:read:zoomroom:master |
| Get post meeting feedback | dashboard:read:post_meeting_feedback:admin |
| Get post meeting feedback | dashboard:read:post_meeting_feedback:master |
| Get AI adoption | dashboard:read:ai_adoption:admin |
| Get AI adoption | dashboard:read:ai_adoption:master |
| Get top 25 Zoom Rooms with issues | dashboard:read:list_zoomrooms:admin |
| Get top 25 Zoom Rooms with issues | dashboard:read:list_zoomrooms:master |
| Get AI usage details | dashboard:read:ai_usage_details:admin |
| Get AI usage details | dashboard:read:ai_usage_details:master |
| Get AI KPIs | dashboard:read:ai_kpi:admin |
| Get AI KPIs | dashboard:read:ai_kpi:master |
| List Zoom Rooms | dashboard:read:list_zoomrooms:admin |
| List Zoom Rooms | dashboard:read:list_zoomrooms:master |
| Get webinar participant QoS | dashboard:read:webinar_participant_qos:admin |
| Get webinar participant QoS | dashboard:read:webinar_participant_qos:master |
| List meeting participants QoS | dashboard:read:list_meeting_participants_qos:admin |
| List meeting participants QoS | dashboard:read:list_meeting_participants_qos:master |
| Get AIC ROI KPIs | dashboard:read:aic_roi_kpi:admin |
| Get AIC ROI KPIs | dashboard:read:aic_roi_kpi:master |
| List Zoom meetings client feedback | dashboard:read:list_meetings_feedback:admin |
| List Zoom meetings client feedback | dashboard:read:list_meetings_feedback:master |
| Get post webinar feedback | dashboard:read:post_webinar_feedback:admin |
| Get post webinar feedback | dashboard:read:post_webinar_feedback:master |
| Get meeting quality scores | dashboard:read:meeting_quality_score:admin |
| Get meeting quality scores | dashboard:read:meeting_quality_score:master |
| Get CRC port usage | dashboard:read:crc_port_usage:admin |
| Get CRC port usage | dashboard:read:crc_port_usage:master |
| List the client versions | dashboard:read:client_versions:admin |
| List the client versions | dashboard:read:client_versions:master |
| List meetings | dashboard:read:list_meetings:admin |
| List meetings | dashboard:read:list_meetings:master |
| Get meeting details | dashboard:read:meeting:admin |
| Get meeting details | dashboard:read:meeting:master |
| Get webinar sharing/recording details | dashboard:read:webinar_sharing:admin |
| Get webinar sharing/recording details | dashboard:read:webinar_sharing:master |
| Get chat metrics | dashboard:read:chat:admin |
| Get chat metrics | dashboard:read:chat:master |
| Get meeting sharing/recording details | dashboard:read:meeting_sharing:admin |
| Get meeting sharing/recording details | dashboard:read:meeting_sharing:master |
| Get AIC ROI meeting summary usage | dashboard:read:aic_roi_meeting_summary_usage:admin |
| Get AIC ROI meeting summary usage | dashboard:read:aic_roi_meeting_summary_usage:master |
Data Requests
| API endpoint | granular scope |
|---|---|
| Get download link for data access request file | data_request:read:download:admin |
| Cancel data deletion request | data_request:delete:request:admin |
| List downloadable files for export data request | data_request:read:download:admin |
| List data request history | data_request:read:history:admin |
| Create data (export/deletion) request | data_request:write:request:admin |
Information Barriers
| API endpoint | granular scope |
|---|---|
| Remove an Information Barrier policy | information_barrier:delete:policy:admin |
| Remove an Information Barrier policy | information_barrier:delete:policy:master |
| Update an Information Barriers policy | information_barrier:update:policy:admin |
| Update an Information Barriers policy | information_barrier:update:policy:master |
| Get an Information Barrier policy by ID | information_barrier:read:policy:admin |
| Get an Information Barrier policy by ID | information_barrier:read:policy:master |
| List information Barrier policies | information_barrier:read:list_policies:admin |
| List information Barrier policies | information_barrier:read:list_policies:master |
| Create an Information Barrier policy | information_barrier:write:policy:admin |
| Create an Information Barrier policy | information_barrier:write:policy:master |
Roles
| API endpoint | granular scope |
|---|---|
| Unassign a role | role:delete:member role:delete:member:admin |
| Unassign a role | role:delete:member:master |
| Create a role | role:write:role role:write:role:admin |
| Create a role | role:write:role:master |
| List roles | role:read:list_roles role:read:list_roles:admin |
| List roles | role:read:list_roles:master |
| Update role information | role:update:role role:update:role:admin |
| Update role information | role:update:role:master |
| Delete a role | role:delete:role role:delete:role:admin |
| Delete a role | role:delete:role:master |
| Get role information | role:read:role role:read:role:admin |
| Get role information | role:read:role:master |
| List members in a role | role:read:list_members role:read:list_members:admin |
| List members in a role | role:read:list_members:master |
| Assign a role | role:write:member role:write:member:admin |
| Assign a role | role:write:member:master |
Single Sign-On
| API endpoint | granular scope |
|---|---|
| Create an SP certificate | sso:write:certificate:admin |
| Update SSO mapping | sso:update:mapping:admin |
| List SSO login logs | sso:read:list_login_logs:admin |
| List SSO configurations | sso:read:config:admin |
| List SP certificates | sso:read:certificate:admin |
| Enable or disable account SSO | sso:update:status:admin |
| Get SSO login log detail | sso:read:login_log:admin |
| Get account SSO capabilities | sso:read:capabilities:admin |
| Delete an SP certificate | sso:delete:certificate:admin |
| Update account SSO settings | sso:update:settings:admin |
| Update an SP certificate | sso:update:certificate:admin |
| Update an SSO configuration | sso:update:config:admin |
| Update an SSO configuration status | sso:update:config_status:admin |
| Get SSO mappings | sso:read:mapping:admin |
| Delete an SSO configuration | sso:delete:config:admin |
| Get account SSO settings | sso:read:settings:admin |
| Get account SSO status | sso:read:status:admin |
| Create an SSO configuration | sso:write:config:admin |
| Get an SSO configuration | sso:read:config:admin |
Survey Management
| API endpoint | granular scope |
|---|---|
| List channel survey instances | survey_management:read:list_survey_instances:admin |
| Get survey info | survey_management:read:survey:admin |
| Get survey info | survey_management:read:survey:master |
| Get survey instances | survey_management:read:list_survey_instances:admin |
| Get survey instances | survey_management:read:list_survey_instances:master |
| Get survey answers | survey_management:read:list_survey_answers:admin |
| Get survey answers | survey_management:read:list_survey_answers:master |
| Get surveys | survey_management:read:list_surveys:admin |
| Get surveys | survey_management:read:list_surveys:master |
Zoom Phone
The following are the available Zoom Phone APIs and their associated granular scopes.
Accounts
| API endpoint | granular scope |
|---|---|
| Delete phone numbers for an account's customized outbound caller ID | phone:delete:customized_number:admin |
| Delete phone numbers for an account's customized outbound caller ID | phone:delete:customized_number:master |
| Add phone numbers for an account's customized outbound caller ID | phone:write:customized_number:admin |
| Add phone numbers for an account's customized outbound caller ID | phone:write:customized_number:master |
| List an account's Zoom Phone settings | phone:read:list_account_settings:admin |
| List an account's Zoom Phone settings | phone:read:list_account_settings:master |
| List an account's customized outbound caller ID phone numbers | phone:read:list_customized_number:admin |
| List an account's customized outbound caller ID phone numbers | phone:read:list_customized_number:master |
Alerts
| API endpoint | granular scope |
|---|---|
| Delete an alert setting | phone:delete:alert_setting:admin |
| Delete an alert setting | phone:delete:alert_setting:master |
| Get alert setting details | phone:read:alert_setting:admin |
| Get alert setting details | phone:read:alert_setting:master |
| List alert settings with paging query | phone:read:list_alert_settings:admin |
| List alert settings with paging query | phone:read:list_alert_settings:master |
| Add an alert setting | phone:write:alert_setting:admin |
| Add an alert setting | phone:write:alert_setting:master |
| Update an alert setting | phone:patch:alert_setting:admin |
| Update an alert setting | phone:patch:alert_setting:master |
Audio Library
| API endpoint | granular scope |
|---|---|
| Delete an audio item | phone:delete:audio phone:delete:audio:admin |
| Delete an audio item | phone:delete:audio:master |
| Add audio items | phone:write:batch_audios phone:write:batch_audios:admin |
| Add audio items | phone:write:batch_audios:master |
| Update an audio item | phone:update:audio phone:update:audio:admin |
| Update an audio item | phone:update:audio:master |
| Add an audio item for text-to-speech conversion | phone:write:audio phone:write:audio:admin |
| Add an audio item for text-to-speech conversion | phone:write:audio:master |
| Get an audio item | phone:read:audio phone:read:audio:admin |
| Get an audio item | phone:read:audio:master |
| List audio items | phone:read:list_audios phone:read:list_audios:admin |
| List audio items | phone:read:list_audios:master |
Auto Receptionists
| API endpoint | granular scope |
|---|---|
| Add auto receptionist setting | phone:write:auto_receptionist_setting:admin |
| Add auto receptionist setting | phone:write:auto_receptionist_setting:master |
| Update an auto receptionist policy | phone:update:auto_receptionist_policy:admin |
| Update an auto receptionist policy | phone:update:auto_receptionist_policy:master |
| Unassign all phone numbers | phone:delete:auto_receptionist_number:admin |
| Unassign all phone numbers | phone:delete:auto_receptionist_number:master |
| Get auto receptionist settings | phone:read:auto_receptionist_setting:admin |
| Get auto receptionist settings | phone:read:auto_receptionist_setting:master |
| Update auto receptionist setting | phone:update:auto_receptionist_setting:admin |
| Update auto receptionist setting | phone:update:auto_receptionist_setting:master |
| Update an auto receptionist | phone:update:auto_receptionist:admin |
| Update an auto receptionist | phone:update:auto_receptionist:master |
| Get auto receptionist call handling setting | phone:read:auto_receptionist_call_handling_setting:admin |
| Get auto receptionist call handling setting | phone:read:auto_receptionist_call_handling_setting:master |
| Add a policy subsetting | phone:write:auto_receptionist_policy:admin |
| Add a policy subsetting | phone:write:auto_receptionist_policy:master |
| Delete auto receptionist setting | phone:delete:auto_receptionist_setting:admin |
| Delete auto receptionist setting | phone:delete:auto_receptionist_setting:master |
| Update auto receptionist call handling setting | phone:update:auto_receptionist_call_handling_setting:admin |
| Update auto receptionist call handling setting | phone:update:auto_receptionist_call_handling_setting:master |
| Update a policy subsetting | phone:update:auto_receptionist_policy:admin |
| Update a policy subsetting | phone:update:auto_receptionist_policy:master |
| Delete a non-primary auto receptionist | phone:delete:auto_receptionist:admin |
| Delete a non-primary auto receptionist | phone:delete:auto_receptionist:master |
| Get an auto receptionist policy | phone:read:auto_receptionist_policy:admin |
| Get an auto receptionist policy | phone:read:auto_receptionist_policy:master |
| Unassign a phone number | phone:delete:auto_receptionist_number:admin |
| Unassign a phone number | phone:delete:auto_receptionist_number:master |
| Get an auto receptionist | phone:read:auto_receptionist:admin |
| Get an auto receptionist | phone:read:auto_receptionist:master |
| List auto receptionists | phone:read:list_auto_receptionists:admin |
| List auto receptionists | phone:read:list_auto_receptionists:master |
| Add an auto receptionist | phone:write:auto_receptionist:admin |
| Add an auto receptionist | phone:write:auto_receptionist:master |
| Delete a policy subsetting | phone:delete:auto_receptionist_policy:admin |
| Delete a policy subsetting | phone:delete:auto_receptionist_policy:master |
| Assign phone numbers | phone:write:auto_receptionist_number:admin |
| Assign phone numbers | phone:write:auto_receptionist_number:master |
Billing Account
| API endpoint | granular scope |
|---|---|
| Get billing account details | phone:read:billing_account:admin |
| Get billing account details | phone:read:billing_account:master |
| List billing accounts | phone:read:list_billing_accounts:admin |
| List billing accounts | phone:read:list_billing_accounts:master |
Blocked List
| API endpoint | granular scope |
|---|---|
| Update a blocked list | phone:update:blocked_list:admin |
| Update a blocked list | phone:update:blocked_list:master |
| List blocked lists | phone:read:list_blocked_lists:admin |
| List blocked lists | phone:read:list_blocked_lists:master |
| Create a blocked list | phone:write:blocked_list:admin |
| Create a blocked list | phone:write:blocked_list:master |
| Get blocked list details | phone:read:blocked_list:admin |
| Get blocked list details | phone:read:blocked_list:master |
| Delete a blocked list | phone:delete:blocked_list:admin |
| Delete a blocked list | phone:delete:blocked_list:master |
Call Handling
| API endpoint | granular scope |
|---|---|
| Update a call handling setting | phone:update:call_handling_setting:admin |
| Update a call handling setting | phone:update:call_handling_setting:master |
| Add a call handling setting | phone:write:call_handling_setting:admin |
| Add a call handling setting | phone:write:call_handling_setting:master |
| Get call handling settings | phone:read:list_call_handling_settings:admin |
| Get call handling settings | phone:read:list_call_handling_settings:master |
| Delete a call handling setting | phone:delete:call_handling_setting:admin |
| Delete a call handling setting | phone:delete:call_handling_setting:master |
Call Logs
| API endpoint | granular scope |
|---|---|
| Get call log details | phone:read:call_log:admin |
| Get call log details | phone:read:call_log:master |
| Add a client code to a call history | phone:update:call_log:admin |
| Add a client code to a call history | phone:update:call_log:master |
| Get call element | phone:read:call_log:admin |
| Get call element | phone:read:call_log:master |
| Get call history detail | phone:read:call_log:admin |
| Get call history detail | phone:read:call_log:master |
| Delete a user's call history | phone:delete:call_log phone:delete:call_log:admin |
| Delete a user's call history | phone:delete:call_log:master |
| Delete a user's call log | phone:delete:call_log phone:delete:call_log:admin |
| Delete a user's call log | phone:delete:call_log:master |
| Get User AI Call Summary Detail | phone:read:ai_call_summary phone:read:ai_call_summary:admin |
| Get User AI Call Summary Detail | phone:read:ai_call_summary:master |
| Get user's call history | phone:read:list_call_logs:admin phone:read:list_call_logs |
| Get user's call history | phone:read:list_call_logs:master |
| Get account's call logs | phone:read:list_call_logs:admin |
| Get account's call logs | phone:read:list_call_logs:master |
| Get account's call history | phone:read:list_call_logs:admin |
| Get account's call history | phone:read:list_call_logs:master |
| Get call history | phone:read:call_log:admin |
| Get call history | phone:read:call_log:master |
| Sync user's call logs | phone:read:list_call_logs phone:read:list_call_logs:admin |
| Sync user's call logs | phone:read:list_call_logs:master |
| Get user's call logs | phone:read:list_call_logs phone:read:list_call_logs:admin |
| Get user's call logs | phone:read:list_call_logs:master |
| Sync user's call history | phone:read:list_call_logs phone:read:list_call_logs:admin |
| Sync user's call history | phone:read:list_call_logs:master |
| Add a client code to a call log | phone:update:call_log:admin |
| Add a client code to a call log | phone:update:call_log:master |
Call Queues
| API endpoint | granular scope |
|---|---|
| Update call queue details | phone:update:call_queue:admin |
| Update a call queue's policy subsetting | phone:update:call_queue_policy:admin |
| Update a call queue's policy subsetting | phone:update:call_queue_policy:master |
| List call queues | phone:read:list_call_queues:admin |
| List call queues | phone:read:list_call_queues:master |
| Get call queue recordings | phone:read:list_call_queue_recordings:admin |
| Get call queue recordings | phone:read:list_call_queue_recordings:master |
| List call queue members | phone:read:list_call_queue_members:admin |
| List call queue members | phone:read:list_call_queue_members:master |
| Get call queue policy | phone:read:call_queue_policy:admin |
| Update call queue policy | phone:update:call_queue_policy:admin |
| Add members to a custom group | phone:write:call_queue_custom_group_member:admin |
| Unassign all members | phone:delete:call_queue_member:admin |
| Unassign all members | phone:delete:call_queue_member:master |
| Get call queue custom group detail | phone:read:call_queue_custom_group:admin phone:read:call_queue_custom_group:master |
| Get call queue details | phone:read:call_queue:admin |
| Get call queue details | phone:read:call_queue:master |
| Add a policy subsetting to a call queue | phone:write:call_queue_policy:admin |
| Add a policy subsetting to a call queue | phone:write:call_queue_policy:master |
| Unassign a phone number | phone:delete:call_queue_number:admin |
| Unassign a phone number | phone:delete:call_queue_number:master |
| Add call queue setting | phone:write:call_queue_setting:admin |
| Add call queue setting | phone:write:call_queue_setting:master |
| Remove a member from a custom group | phone:delete:call_queue_custom_group_member:admin |
| Remove a member from a custom group | phone:delete:call_queue_custom_group_member:master |
| Create a custom group in a call queue | phone:write:call_queue_custom_group:admin |
| Create a custom group in a call queue | phone:write:call_queue_custom_group:master |
| Unassign all phone numbers | phone:delete:call_queue_number:admin |
| Unassign all phone numbers | phone:delete:call_queue_number:master |
| Delete a CQ policy setting | phone:delete:call_queue_policy:admin |
| Delete a CQ policy setting | phone:delete:call_queue_policy:master |
| Create a call queue | phone:write:call_queue:admin |
| Create a call queue | phone:write:call_queue:master |
| Update call queue call handling setting | phone:update:call_queue_call_handling_setting:admin |
| Update call queue call handling setting | phone:update:call_queue_call_handling_setting:master |
| Update call queue setting | phone:update:call_queue_setting:admin |
| Update call queue setting | phone:update:call_queue_setting:master |
| Assign numbers to a call queue | phone:write:call_queue_number:admin |
| Assign numbers to a call queue | phone:write:call_queue_number:master |
| Get call queue settings | phone:read:call_queue_setting:admin |
| Get call queue settings | phone:read:call_queue_setting:master |
| Unassign a member | phone:delete:call_queue_member:admin |
| Unassign a member | phone:delete:call_queue_member:master |
| List call queue analytics | phone:read:list_call_queues:admin |
| List call queue analytics | phone:read:list_call_queues:master |
| Add members to a call queue | phone:write:call_queue_member:admin |
| Add members to a call queue | phone:write:call_queue_member:master |
| Delete a call queue | phone:delete:call_queue:admin |
| Delete a call queue | phone:delete:call_queue:master |
| Update a custom group | phone:update:call_queue_custom_group:admin |
| Update a custom group | phone:update:call_queue_custom_group:master |
| Get call queue call handling setting | phone:read:call_queue_call_handling_setting:admin |
| Get call queue call handling setting | phone:read:call_queue_call_handling_setting:master |
| Delete call queue setting | phone:delete:call_queue_setting:admin |
| Delete call queue setting | phone:delete:call_queue_setting:master |
| List custom groups of a call queue | phone:read:call_queue_custom_group:admin |
| List custom groups of a call queue | phone:read:call_queue_custom_group:master |
| Delete a custom group | phone:delete:call_queue_custom_group:admin phone:delete:call_queue_custom_group:master |
| Delete a custom group | phone:delete:call_queue_custom_group:master |
Carrier Reseller
| API endpoint | granular scope |
|---|---|
| List phone numbers | phone:read:list_carrier_numbers:admin |
| List phone numbers | phone:read:list_carrier_numbers:master |
| Activate phone numbers | phone:update:carrier_number:admin |
| Activate phone numbers | phone:update:carrier_number:master |
| Delete a phone number | phone:delete:carrier_number:admin |
| Delete a phone number | phone:delete:carrier_number:master |
| Create phone numbers | phone:write:carrier_number:admin |
| Create phone numbers | phone:write:carrier_number:master phone:write:carrier_number:master |
Common Areas
| API endpoint | granular scope |
|---|---|
| Get common area settings | phone:read:list_common_area_settings:admin |
| Get common area settings | phone:read:list_common_area_settings:master |
| Assign calling plans to a common area | phone:write:common_area_calling_plan:admin |
| Assign calling plans to a common area | phone:write:common_area_calling_plan:master |
| Add a common area | phone:write:common_area:admin |
| Add a common area | phone:write:common_area:master |
| Update common area call handling setting | phone:update:common_area_call_handling_setting:admin |
| Update common area call handling setting | phone:update:common_area_call_handling_setting:master |
| Update common area setting | phone:update:common_area_setting:admin |
| Update common area setting | phone:update:common_area_setting:master |
| Apply template to common areas | phone:write:apply_template_to_common_areas:admin |
| Apply template to common areas | phone:write:apply_template_to_common_areas:master |
| Delete a common area | phone:delete:common_area:admin |
| Delete a common area | phone:delete:common_area:master |
| Get common area details | phone:read:common_area:admin |
| Get common area details | phone:read:common_area:master |
| Delete common area setting | phone:delete:common_area_setting:admin |
| Delete common area setting | phone:delete:common_area_setting:master |
| Get common area call handling setting | phone:read:common_area_call_handling_setting:admin |
| Get common area call handling setting | phone:read:common_area_call_handling_setting:master |
| Add common area setting | phone:write:common_area_setting:admin |
| Add common area setting | phone:write:common_area_setting:master |
| Unassign a calling plan from the common area | phone:delete:common_area_calling_plan:admin |
| Unassign a calling plan from the common area | phone:delete:common_area_calling_plan:master |
| Assign phone numbers to a common area | phone:write:common_area_number:admin |
| Assign phone numbers to a common area | phone:write:common_area_number:master |
| Update common area | phone:update:common_area:admin |
| Update common area | phone:update:common_area:master |
| List activation codes | phone:read:list_common_area_activation_codes:admin |
| List activation codes | phone:read:list_common_area_activation_codes:master |
| List common areas | phone:read:common_area:admin |
| List common areas | phone:read:common_area:master |
| Generate activation codes for common areas | phone:write:common_area:admin |
| Generate activation codes for common areas | phone:write:common_area:master |
| Unassign phone numbers from common area | phone:delete:common_area_number:admin |
| Unassign phone numbers from common area | phone:delete:common_area_number:master |
| Update common area pin code | phone:update:common_area:admin |
| Update common area pin code | phone:update:common_area:master |
Dashboard
| API endpoint | granular scope |
|---|---|
| List detectable personal location users | phone:read:detectable_personal_location:admin |
| List detectable personal location users | phone:read:detectable_personal_location:master |
| List real time location for users | phone:read:realtime_location_users:admin |
| List real time location for users | phone:read:realtime_location_users:master |
| List real time location for IP phones | phone:read:realtime_location_devices:admin |
| List real time location for IP phones | phone:read:realtime_location_devices:master |
| List default emergency address users | phone:read:default_emergency_address:admin |
| List default emergency address users | phone:read:default_emergency_address:master |
| List users permission for location sharing | phone:read:location_sharing_permission:admin |
| List users permission for location sharing | phone:read:location_sharing_permission:master |
| List nomadic emergency services users | phone:read:nomadic_emergency_services:admin |
| List nomadic emergency services users | phone:read:nomadic_emergency_services:master |
| Get call QoS | phone:read:call_qos:admin |
| Get call QoS | phone:read:call_qos:master |
| Get call details from call log | phone:read:call_log:admin |
| Get call details from call log | phone:read:call_log:master |
| List past call metrics | phone:read:list_call_logs:admin |
| List past call metrics | phone:read:list_call_logs:master |
| List call logs | phone:read:list_call_logs:admin |
| List call logs | phone:read:list_call_logs:master |
| List tracked locations | phone:read:list_tracked_locations:admin |
| List tracked locations | phone:read:list_tracked_locations:master |
Device Line Keys
| API endpoint | granular scope |
|---|---|
| Get device line keys information | phone:read:device_line_keys phone:read:device_line_keys:admin |
| Get device line keys information | phone:read:device_line_keys:master |
| Batch update device line key position | phone:update:device_line_keys phone:update:device_line_keys:admin |
| Batch update device line key position | phone:update:device_line_keys:master |
Dial by Name Directory
| API endpoint | granular scope |
|---|---|
| Delete users from a directory | phone:delete:directory:admin |
| Delete users from a directory | phone:delete:directory:master |
| Delete users from a directory of a site | phone:delete:directory:admin |
| Delete users from a directory of a site | phone:delete:directory:master |
| List users in directory | phone:read:directory:admin |
| List users in directory | phone:read:directory:master |
| List users in a directory by site | phone:read:directory:admin |
| List users in a directory by site | phone:read:directory:master |
| Add users to a directory | phone:write:directory:admin |
| Add users to a directory | phone:write:directory:master |
| Add users to a directory of a site | phone:write:directory:admin |
| Add users to a directory of a site | phone:write:directory:master |
Emergency Addresses
| API endpoint | granular scope |
|---|---|
| Delete an emergency address | phone:delete:emergency_address:admin |
| Delete an emergency address | phone:delete:emergency_address:master |
| Get emergency address details | phone:read:emergency_address:admin |
| Get emergency address details | phone:read:emergency_address:master |
| Update an emergency address | phone:update:emergency_address:admin |
| Update an emergency address | phone:update:emergency_address:master |
| List emergency addresses | phone:read:list_emergency_addresses:admin |
| List emergency addresses | phone:read:list_emergency_addresses:master |
| Add an emergency address | phone:write:emergency_address:admin |
| Add an emergency address | phone:write:emergency_address:master |
Emergency Service Locations
| API endpoint | granular scope |
|---|---|
| Delete an emergency location | phone:delete:emergency_location:admin |
| Delete an emergency location | phone:delete:emergency_location:master |
| Get emergency service location details | phone:read:emergency_location:admin |
| Get emergency service location details | phone:read:emergency_location:master |
| Update emergency service location | phone:update:emergency_location:admin |
| Update emergency service location | phone:update:emergency_location:master |
| List emergency service locations | phone:read:list_emergency_locations:admin |
| List emergency service locations | phone:read:list_emergency_locations:master |
| Add an emergency service location | phone:write:emergency_location:admin |
| Add an emergency service location | phone:write:emergency_location:master |
| Batch add emergency service locations | phone:write:batch_emergency_locations:admin |
| Batch add emergency service locations | phone:write:batch_emergency_locations:master |
Emergency Service Routing
| API endpoint | granular scope |
|---|---|
| List an account's emergency routing rules | phone:read:list_emergency_services_routing_rules:admin |
| List an account's emergency routing rules | phone:read:list_emergency_services_routing_rules:master |
| List a site's emergency routing rules | phone:read:list_site_emergency_service_routing_rules:admin |
| List a site's emergency routing rules | phone:read:list_site_emergency_service_routing_rules:master |
| Add an account's emergency routing rule | phone:write:emergency_services_routing_rule:admin |
| Add an account's emergency routing rule | phone:write:emergency_services_routing_rule:master |
| Add a site's emergency routing rule | phone:write:site_emergency_service_routing_rule:admin |
| Add a site's emergency routing rule | phone:write:site_emergency_service_routing_rule:master |
| Delete an account's emergency routing rule | phone:delete:emergency_services_routing_rule:admin |
| Delete an account's emergency routing rule | phone:delete:emergency_services_routing_rule:master |
| Update a site emergency routing rule | phone:update:site_emergency_service_routing_rule:admin |
| Update a site emergency routing rule | phone:update:site_emergency_service_routing_rule:master |
| Update an account's emergency routing rule | phone:update:emergency_services_routing_rule:admin |
| Update an account's emergency routing rule | phone:update:emergency_services_routing_rule:master |
| Delete a site's emergency routing rule | phone:delete:site_emergency_service_routing_rule:admin |
| Delete a site's emergency routing rule | phone:delete:site_emergency_service_routing_rule:master |
Emergency Services
| API endpoint | granular scope |
|---|---|
| Update emergency service settings | phone:update:emergency_service_setting:admin |
| Update emergency service settings | phone:update:emergency_service_setting:master |
| Get emergency service settings | phone:read:emergency_service_setting:admin |
| Get emergency service settings | phone:read:emergency_service_setting:master |
External Contacts
| API endpoint | granular scope |
|---|---|
| Update external contact | phone:update:external_contact:admin |
| Update external contact | phone:update:external_contact:master |
| List external contacts | phone:read:list_external_contacts:admin |
| List external contacts | phone:read:list_external_contacts:master |
| Delete an external contact | phone:delete:external_contact:admin |
| Delete an external contact | phone:delete:external_contact:master |
| Get external contact details | phone:read:external_contact:admin |
| Get external contact details | phone:read:external_contact:master |
| Add an external contact | phone:write:external_contact:admin |
| Add an external contact | phone:write:external_contact:master |
Fax
| API endpoint | granular scope |
|---|---|
| Get fax log details | phone:read:list_fax_log:admin |
| Get fax log details | phone:read:list_fax_log:master |
| Download fax cover page preview image | phone:read:fax_cover_page phone:read:fax_cover_page:admin |
| Download fax cover page preview image | phone:read:fax_cover_page:master |
| Download fax file | phone:read:fax_log phone:read:fax_log:admin |
| Download fax file | phone:read:fax_log:master |
| Get account's fax logs | phone:read:list_fax_log:admin |
| Get account's fax logs | phone:read:list_fax_log:master |
| Delete fax log | phone:delete:fax_log phone:delete:fax_log:admin |
| Upload fax file | phone:write:send_fax phone:write:send_fax:admin |
| Upload fax file | phone:write:send_fax:master |
| Send fax | phone:write:send_fax phone:write:send_fax:admin |
| Send fax | phone:write:send_fax:master |
| Get fax cover pages | phone:read:fax_cover_page phone:read:fax_cover_page:admin |
| Get fax cover pages | phone:read:fax_cover_page:master |
| Get extension's fax logs | phone:read:list_fax_log phone:read:list_fax_log:admin |
| Get extension's fax logs | phone:read:list_fax_log:master |
| Update fax log read status | phone:read:fax_log:admin phone:read:fax_log |
| Update fax log read status | phone:read:fax_log:master |
Firmware Update Rules
| API endpoint | granular scope |
|---|---|
| Get firmware update rule information | phone:read:firmware_update_rule:admin |
| Get firmware update rule information | phone:read:firmware_update_rule:master |
| Delete firmware update rule | phone:delete:firmware_update_rule:admin |
| Delete firmware update rule | phone:delete:firmware_update_rule:master |
| List firmware update rules | phone:read:list_firmware_update_rules:admin |
| List firmware update rules | phone:read:list_firmware_update_rules:master |
| Update firmware update rule | phone:update:firmware_update_rule:admin |
| Update firmware update rule | phone:update:firmware_update_rule:master |
| Add a firmware update rule | phone:write:firmware_update_rule:admin |
| Add a firmware update rule | phone:write:firmware_update_rule:master |
| List updatable firmwares | phone:read:list_firmwares:admin |
| List updatable firmwares | phone:read:list_firmwares:master |
Group Call Pickup
| API endpoint | granular scope |
|---|---|
| Update the group call pickup information | phone:update:call_pickup_group:admin |
| Update the group call pickup information | phone:update:call_pickup_group:master |
| List call pickup group members | phone:read:call_pickup_group_member:admin |
| List call pickup group members | phone:read:call_pickup_group_member:master |
| Add a group call pickup object | phone:write:call_pickup_group:admin |
| Add a group call pickup object | phone:write:call_pickup_group:master |
| Delete group call pickup objects | phone:delete:call_pickup_group:admin |
| Delete group call pickup objects | phone:delete:call_pickup_group:master |
| Get call pickup group by ID | phone:read:call_pickup_group:admin |
| Get call pickup group by ID | phone:read:call_pickup_group:master |
| List group call pickup objects | phone:read:list_call_pickup_groups:admin |
| List group call pickup objects | phone:read:list_call_pickup_groups:master |
| Add members to a call pickup group | phone:write:call_pickup_group_member:admin |
| Add members to a call pickup group | phone:write:call_pickup_group_member:master |
| Remove members from call pickup group | phone:delete:call_pickup_group_member:admin |
| Remove members from call pickup group | phone:delete:call_pickup_group_member:master |
Groups
| API endpoint | granular scope |
|---|---|
| Get group phone settings | phone:read:group_setting:admin |
| Get group phone settings | phone:read:group_setting:master |
| Get group policy details | phone:read:group_policy:admin |
| Get group policy details | phone:read:group_policy:master |
| Update group policy | phone:update:group_policy:admin |
| Update group policy | phone:update:group_policy:master |
IVR
| API endpoint | granular scope |
|---|---|
| Update auto receptionist IVR | phone:update:auto_receptionist_ivr:admin |
| Update auto receptionist IVR | phone:update:auto_receptionist_ivr:master |
| Get auto receptionist IVR | phone:read:auto_receptionist_ivr:admin |
| Get auto receptionist IVR | phone:read:auto_receptionist_ivr:master |
Inbound Blocked List
| API endpoint | granular scope |
|---|---|
| Delete an extension's inbound block rule | phone:delete:extension_inbound_block_rule:admin phone:delete:extension_inbound_block_rule |
| Delete an extension's inbound block rule | phone:delete:extension_inbound_block_rule:master |
| Delete an account's inbound block rule | phone:delete:inbound_block_rule:admin |
| Delete an account's inbound block rule | phone:delete:inbound_block_rule:master |
| Add an account's inbound block rule | phone:write:inbound_block_rule:admin |
| Add an account's inbound block rule | phone:write:inbound_block_rule:master |
| Mark a phone number as blocked for all extensions | phone:update:inbound_blocked_for_all:admin |
| Mark a phone number as blocked for all extensions | phone:update:inbound_blocked_for_all:master |
| Add an extension's inbound block rule | phone:write:extension_inbound_block_rule:admin phone:write:extension_inbound_block_rule |
| Add an extension's inbound block rule | phone:write:extension_inbound_block_rule:master |
| Update an account's inbound block rule | phone:update:inbound_block_rule:admin |
| Update an account's inbound block rule | phone:update:inbound_block_rule:master |
| List an account's inbound block rules | phone:read:list_inbound_block_rules:admin |
| List an account's inbound block rules | phone:read:list_inbound_block_rules:master |
| List an extension's inbound block rules | phone:read:list_extension_inbound_block_rules:admin phone:read:list_extension_inbound_block_rules |
| List an extension's inbound block rules | phone:read:list_extension_inbound_block_rules:master |
| Delete an account's inbound blocked statistics | phone:delete:extension_inbound_block_rule_stat:admin |
| Delete an account's inbound blocked statistics | phone:delete:extension_inbound_block_rule_stat:master |
| List an account's inbound blocked statistics | phone:read:list_extension_inbound_block_rules_stat:admin |
| List an account's inbound blocked statistics | phone:read:list_extension_inbound_block_rules_stat:master |
Line Keys
| API endpoint | granular scope |
|---|---|
| Get line key position and settings information | phone:read:line_keys phone:read:line_keys:admin |
| Get line key position and settings information | phone:read:line_keys:master |
| Delete a line key setting. | phone:delete:line_keys phone:delete:line_keys:admin |
| Delete a line key setting. | phone:delete:line_keys:master |
| Batch update line key position and settings information | phone:update:line_keys phone:update:line_keys:admin |
| Batch update line key position and settings information | phone:update:line_keys:master |
Monitoring Groups
| API endpoint | granular scope |
|---|---|
| Remove all monitors or monitored members from a monitoring group | phone:delete:monitoring_group_member:admin |
| Remove all monitors or monitored members from a monitoring group | phone:delete:monitoring_group_member:master |
| Get a list of monitoring groups on an account | phone:read:list_monitoring_groups:admin |
| Get a list of monitoring groups on an account | phone:read:list_monitoring_groups:master |
| Get members of a monitoring group | phone:read:list_monitoring_group_members:admin |
| Get members of a monitoring group | phone:read:list_monitoring_group_members:master |
| Add members to a monitoring group | phone:write:monitoring_group_member:admin |
| Add members to a monitoring group | phone:write:monitoring_group_member:master |
| Delete a monitoring group | phone:delete:monitoring_group:admin |
| Delete a monitoring group | phone:delete:monitoring_group:master |
| Create a monitoring group | phone:write:monitoring_group:admin |
| Create a monitoring group | phone:write:monitoring_group:master |
| Remove a member from a monitoring group | phone:delete:monitoring_group_member:admin |
| Remove a member from a monitoring group | phone:delete:monitoring_group_member:master |
| Get monitoring group by ID | phone:read:monitoring_group:admin |
| Get monitoring group by ID | phone:read:monitoring_group:master |
| Update a monitoring group | phone:update:monitoring_group:admin |
| Update a monitoring group | phone:update:monitoring_group:master |
Outbound Calling
Phone Devices
| API endpoint | granular scope |
|---|---|
| Get device details | phone:read:device:admin |
| Get device details | phone:read:device:master |
| List Smartphones | phone:read:list_devices:admin |
| List Smartphones | phone:read:list_devices:master |
| Assign an entity to a device | phone:write:device_extension:admin |
| Assign an entity to a device | phone:write:device_extension:master |
| Reboot a desk phone | phone:write:reboot_device:admin |
| Reboot a desk phone | phone:write:reboot_device:master |
| Delete a device | phone:delete:device:admin |
| Delete a device | phone:delete:device:master |
| Update provision template of a device | phone:update:device_provision_template:admin |
| Update provision template of a device | phone:update:device_provision_template:master |
| Add a device | phone:write:device:admin |
| Add a device | phone:write:device:master |
| Sync deskphones | phone:write:sync_device:admin |
| Sync deskphones | phone:write:sync_device:master |
| Update a device | phone:update:device:admin |
| Update a device | phone:update:device:master |
| Unassign an entity from the device | phone:delete:device_extension:admin |
| Unassign an entity from the device | phone:delete:device_extension:master |
| List devices | phone:read:list_devices:admin |
| List devices | phone:read:list_devices:master |
Phone Numbers
| API endpoint | granular scope |
|---|---|
| List site emergency number pool phone numbers | phone:read:list_sites_emergency_numbers:admin |
| List site emergency number pool phone numbers | phone:read:list_sites_emergency_numbers:master |
| Unassign phone numbers from the emergency number pool | phone:delete:emergency_number:admin |
| Unassign phone numbers from the emergency number pool | phone:delete:emergency_number:master |
| Update a site's unassigned phone numbers | phone:update:site_number:admin |
| Update a site's unassigned phone numbers | phone:update:site_number:master |
| Assign a phone number to a user | phone:write:user_number phone:write:user_number:admin |
| Assign a phone number to a user | phone:write:user_number:master |
| Delete unassigned phone numbers | phone:delete:number:admin |
| Delete unassigned phone numbers | phone:delete:number:master |
| Unassign a phone number | phone:delete:user_number phone:delete:user_number:admin |
| Unassign a phone number | phone:delete:user_number:master |
| Update a phone number | phone:update:number:admin |
| Update a phone number | phone:update:number:master |
| List account emergency number pool phone numbers | phone:read:emergency_number:admin |
| List account emergency number pool phone numbers | phone:read:emergency_number:master |
| Add BYOC phone numbers | phone:write:byo_carrier_number:admin |
| Add BYOC phone numbers | phone:write:byo_carrier_number:master |
| Assign phone numbers to the emergency number pool | phone:write:emergency_number:admin |
| Assign phone numbers to the emergency number pool | phone:write:emergency_number:master |
| Get a phone number | phone:read:numbers:admin |
| Get a phone number | phone:read:numbers:master |
| List phone numbers | phone:read:list_numbers:admin |
| List phone numbers | phone:read:list_numbers:master |
Phone Plans
| API endpoint | granular scope |
|---|---|
| List plan information | phone:read:list_calling_plans:admin |
| List plan information | phone:read:list_calling_plans:master |
| List calling plans | phone:read:list_calling_plans:admin |
| List calling plans | phone:read:list_calling_plans:master |
Phone Roles
| API endpoint | granular scope |
|---|---|
| Update a phone role | phone:update:role:admin |
| Update a phone role | phone:update:role:master |
| List phone roles | phone:read:list_roles:admin |
| List phone roles | phone:read:list_roles:master |
| Add members to roles | phone:write:role_member:admin |
| Add members to roles | phone:write:role_member:master |
| List phone role targets | phone:read:list_roles:admin |
| List phone role targets | phone:read:list_roles:master |
| Delete a phone role | phone:delete:role:admin |
| Delete a phone role | phone:delete:role:master |
| Duplicate a phone role | phone:write:role:admin |
| Duplicate a phone role | phone:write:role:master |
| Delete phone role targets | phone:delete:role:admin |
| Delete phone role targets | phone:delete:role:master |
| Delete members in a role | phone:delete:role_member:admin |
| Delete members in a role | phone:delete:role_member:master |
| List members in a role | phone:read:role_member:admin |
| List members in a role | phone:read:role_member:master |
| Add phone role targets | phone:write:role:admin |
| Add phone role targets | phone:write:role:master |
| Get role information | phone:read:role:admin |
| Get role information | phone:read:role:master |
Private Directory
| API endpoint | granular scope |
|---|---|
| Remove a member from a private directory | phone:delete:private_directory_member:admin |
| Remove a member from a private directory | phone:delete:private_directory_member:master |
| Add members to a private directory | phone:write:private_directory_member:admin |
| Add members to a private directory | phone:write:private_directory_member:master |
| Update a private directory member | phone:update:private_directory_member:admin |
| Update a private directory member | phone:update:private_directory_member:master |
| List private directory members | phone:read:list_private_directory_members:admin |
| List private directory members | phone:read:list_private_directory_members:master |
Provider Exchange
| API endpoint | granular scope |
|---|---|
| List carrier peering phone numbers. | phone:read:list_peering_numbers:admin |
| List carrier peering phone numbers. | phone:read:list_peering_numbers:master |
| Update peering phone numbers | phone:update:peering_number:admin |
| Update peering phone numbers | phone:update:peering_number:master |
| Add peering phone numbers | phone:write:peering_number:admin |
| Add peering phone numbers | phone:write:peering_number:master |
| List peering phone numbers | phone:read:list_peering_numbers:admin |
| List peering phone numbers | phone:read:list_peering_numbers:master |
| Remove peering phone numbers | phone:delete:peering_number:admin |
| Remove peering phone numbers | phone:delete:peering_number:master |
Provision Templates
| API endpoint | granular scope |
|---|---|
| List provision templates | phone:read:list_provision_templates:admin |
| List provision templates | phone:read:list_provision_templates:master |
| Delete a provision template | phone:delete:provision_template:admin |
| Delete a provision template | phone:delete:provision_template:master |
| Update a provision template | phone:update:provision_template:admin |
| Update a provision template | phone:update:provision_template:master |
| Get a provision template | phone:read:provision_template:admin |
| Get a provision template | phone:read:provision_template:master |
| Add a provision template | phone:write:provision_template:admin |
| Add a provision template | phone:write:provision_template:master |
Push To Talk
| API endpoint | granular scope |
|---|---|
| List push to talk channels | phone:read:list_push_to_talk_channels:admin |
| List push to talk channels | phone:read:list_push_to_talk_channels:master |
| List push to talk channel members | phone:read:list_push_to_talk_channel_members:admin |
| List push to talk channel members | phone:read:list_push_to_talk_channel_members:master |
| Remove a member from a push to talk channel | phone:delete:push_to_talk_channel_member:admin |
| Remove a member from a push to talk channel | phone:delete:push_to_talk_channel_member:master |
| Add members to a push to talk (PTT) channel | phone:write:push_to_talk_channel_member:admin |
| Add members to a push to talk (PTT) channel | phone:write:push_to_talk_channel_member:master |
| Create a push to talk channel | phone:write:push_to_talk_channel:admin |
| Create a push to talk channel | phone:write:push_to_talk_channel:master |
| Get push to talk channel details | phone:read:push_to_talk_channel:admin |
| Get push to talk channel details | phone:read:push_to_talk_channel:master |
| Remove a push to talk channel | phone:delete:push_to_talk_channel:admin |
| Remove a push to talk channel | phone:delete:push_to_talk_channel:master |
| Update push to talk channel details | phone:update:push_to_talk_channel:admin |
| Update push to talk channel details | phone:update:push_to_talk_channel:master |
Recordings
| API endpoint | granular scope |
|---|---|
| Get recording by call ID | phone:read:call_recording phone:read:call_recording:admin |
| Get recording by call ID | phone:read:call_recording:master |
| Update Auto Delete Field | phone:update:call_recording phone:update:call_recording:admin |
| Update Auto Delete Field | phone:update:call_recording:master |
| Update Recording Status | phone:update:call_recording phone:update:call_recording:admin |
| Update Recording Status | phone:update:call_recording:master |
| Delete a call recording | phone:delete:call_recording phone:delete:call_recording:admin |
| Delete a call recording | phone:delete:call_recording:master |
| Get user's recordings | phone:read:list_recordings phone:read:list_recordings:admin |
| Get user's recordings | phone:read:list_recordings:master |
| Download a phone recording transcript | phone:read:recording_transcript phone:read:recording_transcript:admin |
| Download a phone recording transcript | phone:read:recording_transcript:master |
| Download a phone recording | phone:read:call_recording phone:read:call_recording:admin |
| Download a phone recording | phone:read:call_recording:master |
| Get a recording by call element ID | phone:read:call_recording phone:read:call_recording:admin |
| Get a recording by call element ID | phone:read:call_recording:master |
| Get call recordings | phone:read:list_call_recordings:admin |
| Get call recordings | phone:read:list_call_recordings:master |
Reports
| API endpoint | granular scope |
|---|---|
| Get fax charges usage report | phone:read:fax_charges:admin |
| Get fax charges usage report | phone:read:fax_charges:master |
| Get operation logs report | phone:read:operation_logs:admin |
| Get operation logs report | phone:read:operation_logs:master |
| Get call charges usage report | phone:read:call_charges:admin |
| Get call charges usage report | phone:read:call_charges:master |
| Get SMS/MMS charges usage report | phone:read:sms_charges:admin |
| Get SMS/MMS charges usage report | phone:read:sms_charges:master |
Routing Rules
| API endpoint | granular scope |
|---|---|
| Update directory backup routing rule | phone:update:routing_rule:admin |
| Update directory backup routing rule | phone:update:routing_rule:master |
| List directory backup routing rules | phone:read:list_routing_rules:admin |
| List directory backup routing rules | phone:read:list_routing_rules:master |
| Add directory backup routing rule | phone:write:routing_rule:admin |
| Add directory backup routing rule | phone:write:routing_rule:master |
| Get directory backup routing rule | phone:read:routing_rule:admin |
| Get directory backup routing rule | phone:read:routing_rule:master |
| Delete directory backup routing rule | phone:delete:routing_rule:admin |
| Delete directory backup routing rule | phone:delete:routing_rule:master |
SMS
| API endpoint | granular scope |
|---|---|
| Get user's SMS sessions | phone:read:list_sms_sessions phone:read:list_sms_sessions:admin |
| Get user's SMS sessions | phone:read:list_sms_sessions:master |
| Sync SMS by session ID | phone:read:sms_session phone:read:sms_session:admin |
| Sync SMS by session ID | phone:read:sms_session:master |
| List user's SMS sessions in descending order | phone:read:sms_session phone:read:sms_session:admin |
| List user's SMS sessions in descending order | phone:read:sms_session:master |
| Get SMS session details | phone:read:sms_session phone:read:sms_session:admin |
| Get SMS session details | phone:read:sms_session:master |
| Get account's SMS sessions | phone:read:list_sms_sessions phone:read:list_sms_sessions:admin |
| Get account's SMS sessions | phone:read:list_sms_sessions:master |
| Get SMS by message ID | phone:read:sms_message phone:read:sms_message:admin |
| Get SMS by message ID | phone:read:sms_message:master |
| Post SMS message | phone:read:sms_message phone:read:sms_message:admin |
SMS Campaign
| API endpoint | granular scope |
|---|---|
| Unassign a phone number | phone:delete:sms_campaign_number:admin |
| Unassign a phone number | phone:delete:sms_campaign_number:master |
| List user's opt statuses of phone numbers | phone:read:sms_campaign_number_opt_status phone:read:sms_campaign_number_opt_status:admin |
| List user's opt statuses of phone numbers | phone:read:sms_campaign_number_opt_status:master |
| List opt statuses of phone numbers assigned to SMS campaign | phone:read:sms_campaign_number_opt_status:admin |
| List opt statuses of phone numbers assigned to SMS campaign | phone:read:sms_campaign_number_opt_status:master |
| Assign a phone number to SMS campaign | phone:write:sms_campaign_number:admin |
| Assign a phone number to SMS campaign | phone:write:sms_campaign_number:master |
| List SMS campaigns | phone:read:list_sms_campaigns:admin |
| List SMS campaigns | phone:read:list_sms_campaigns:master |
| Update opt statuses of phone numbers assigned to SMS campaign | phone:update:sms_campaign_number_opt_status:admin |
| Update opt statuses of phone numbers assigned to SMS campaign | phone:update:sms_campaign_number_opt_status:master |
| Get an SMS campaign | phone:read:sms_campaign:admin |
| Get an SMS campaign | phone:read:sms_campaign:master |
SMS Consent
| API endpoint | granular scope |
|---|---|
| List opt statuses of phone numbers assigned to SMS consent | phone:read:sms_consent_number_opt_status:admin |
| List opt statuses of phone numbers assigned to SMS consent | phone:read:sms_consent_number_opt_status:master |
Setting Templates
| API endpoint | granular scope |
|---|---|
| List setting templates | phone:read:list_setting_templates:admin |
| List setting templates | phone:read:list_setting_templates:master |
| Add a setting template | phone:write:setting_template:admin |
| Add a setting template | phone:write:setting_template:master |
| Get setting template details | phone:read:setting_template:admin |
| Get setting template details | phone:read:setting_template:master |
| Update a setting template | phone:update:setting_template:admin |
| Update a setting template | phone:update:setting_template:master |
Settings
| API endpoint | granular scope |
|---|---|
| List ported numbers | phone:read:list_ported_numbers:admin |
| List ported numbers | phone:read:list_ported_numbers:master |
| Update account policy | phone:update:policy:admin |
| Update account policy | phone:update:policy:master |
| List SIP groups | phone:read:list_sip_groups:admin |
| List SIP groups | phone:read:list_sip_groups:master |
| Get ported numbers details | phone:read:ported_number:admin |
| Get ported numbers details | phone:read:ported_number:master |
| List BYOC SIP trunks | phone:read:list_sip_trunks:admin |
| List BYOC SIP trunks | phone:read:list_sip_trunks:master |
| Get account policy details | phone:read:policy:admin |
| Get account policy details | phone:read:policy:master |
| Get phone account settings | phone:read:settings:admin |
| Get phone account settings | phone:read:settings:master |
| Update phone account settings | phone:update:settings:admin |
| Update phone account settings | phone:update:settings:master |
Shared Line Appearance
| API endpoint | granular scope |
|---|---|
| List shared line appearances | phone:read:list_shared_line_appearances:admin |
| List shared line appearances | phone:read:list_shared_line_appearances:master |
Shared Line Group
| API endpoint | granular scope |
|---|---|
| Update a shared line group policy | phone:update:shared_line_group_policy:admin |
| Update a shared line group policy | phone:update:shared_line_group_policy:master |
| Unassign a member from a shared line group | phone:delete:shared_line_member:admin |
| Unassign a member from a shared line group | phone:delete:shared_line_member:master |
| Get a shared line group policy | phone:read:shared_line_group_policy:admin |
| Get a shared line group policy | phone:read:shared_line_group_policy:master |
| Update shared line group call handling setting | phone:update:shared_line_group_call_handling_setting:admin |
| Update shared line group call handling setting | phone:update:shared_line_group_call_handling_setting:master |
| Unassign members from a shared line group | phone:delete:shared_line_member:admin |
| Unassign members from a shared line group | phone:delete:shared_line_member:master |
| Unassign all phone numbers | phone:delete:shared_line_group_number:admin |
| Unassign all phone numbers | phone:delete:shared_line_group_number:master |
| Update an SLG policy setting | phone:update:shared_line_group_policy:admin |
| Update an SLG policy setting | phone:update:shared_line_group_policy:master |
| Update shared line group setting | phone:update:shared_line_group_setting:admin |
| Update shared line group setting | phone:update:shared_line_group_setting:master |
| Assign phone numbers | phone:write:shared_line_group_number:admin |
| Assign phone numbers | phone:write:shared_line_group_number:master |
| Get shared line group settings | phone:read:shared_line_group_setting:admin |
| Get shared line group settings | phone:read:shared_line_group_setting:master |
| Add members to a shared line group | phone:write:shared_line_member:admin |
| Add members to a shared line group | phone:write:shared_line_member:master |
| Unassign a phone number | phone:delete:shared_line_group_number:admin |
| Unassign a phone number | phone:delete:shared_line_group_number:master |
| Create a shared line group | phone:write:shared_line_group:admin |
| Create a shared line group | phone:write:shared_line_group:master |
| Update a shared line group | phone:update:shared_line_group:admin |
| Update a shared line group | phone:update:shared_line_group:master |
| Add a policy setting to a shared line group | phone:write:shared_line_group_policy:admin |
| Add a policy setting to a shared line group | phone:write:shared_line_group_policy:master |
| Delete a shared line group | phone:delete:shared_line_group:admin |
| Delete a shared line group | phone:delete:shared_line_group:master |
| List shared line groups | phone:read:list_shared_line_groups:admin |
| List shared line groups | phone:read:list_shared_line_groups:master |
| Get a shared line group | phone:read:shared_line_group:admin |
| Get a shared line group | phone:read:shared_line_group:master |
| Delete shared line group setting | phone:delete:shared_line_group_setting:admin |
| Delete shared line group setting | phone:delete:shared_line_group_setting:master |
| Add shared line group setting | phone:write:shared_line_group_setting:admin |
| Add shared line group setting | phone:write:shared_line_group_setting:master |
| Delete an SLG policy setting | phone:delete:shared_line_group_policy:admin |
| Delete an SLG policy setting | phone:delete:shared_line_group_policy:master |
| Get shared line group call handling setting | phone:read:shared_line_group_call_handling_setting:admin |
| Get shared line group call handling setting | phone:read:shared_line_group_call_handling_setting:master |
Sites
| API endpoint | granular scope |
|---|---|
| Get a phone site setting | phone:read:site_setting:admin |
| Get a phone site setting | phone:read:site_setting:master |
| Update the site setting | phone:update:site_setting:admin |
| Update the site setting | phone:update:site_setting:master |
| Add a site setting | phone:write:site_setting:admin |
| Add a site setting | phone:write:site_setting:master |
| Delete a phone site | phone:delete:site:admin |
| Delete a phone site | phone:delete:site:master |
| Get phone site details | phone:read:site:admin |
| Get phone site details | phone:read:site:master |
| Create a phone site | phone:write:site:admin |
| Create a phone site | phone:write:site:master |
| Add customized outbound caller ID phone numbers | phone:write:site_customized_number:admin |
| Add customized outbound caller ID phone numbers | phone:write:site_customized_number:master |
| Remove customized outbound caller ID phone numbers | phone:delete:site_customized_number:admin |
| Remove customized outbound caller ID phone numbers | phone:delete:site_customized_number:master |
| Delete a site setting | phone:delete:site_setting:admin |
| Delete a site setting | phone:delete:site_setting:master |
| List customized outbound caller ID phone numbers | phone:read:list_site_customized_number:admin |
| List customized outbound caller ID phone numbers | phone:read:list_site_customized_number:master |
| Update phone site details | phone:update:site:admin |
| Update phone site details | phone:update:site:master |
| List phone sites | phone:read:list_sites:admin |
| List phone sites | phone:read:list_sites:master |
Users
| API endpoint | granular scope |
|---|---|
| Get a user's profile | phone:read:user phone:read:user:admin |
| Get a user's profile | phone:read:user:master |
| Unassign user's calling plan | phone:delete:users_calling_plan phone:delete:users_calling_plan:admin |
| Unassign user's calling plan | phone:delete:users_calling_plan:master |
| Delete a user's profile setting | phone:delete:user_setting phone:delete:user_setting:admin |
| Delete a user's profile setting | phone:delete:user_setting:master |
| List phone users | phone:read:list_users:admin |
| List phone users | phone:read:list_users:master |
| Update user's calling plan | phone:update:calling_plan phone:update:calling_plan:admin |
| Update user's calling plan | phone:update:calling_plan:master |
| Update multiple users' properties in batch | phone:update:batch_users:admin |
| Update multiple users' properties in batch | phone:update:batch_users:master |
| Assign calling plan to a user | phone:write:calling_plan phone:write:calling_plan:admin |
| Assign calling plan to a user | phone:write:calling_plan:master |
| Get user policy details | phone:read:user_policy:admin |
| Get user policy details | phone:read:user_policy:master |
| List users' phone numbers for a customized outbound caller ID | phone:read:list_user_customized_number phone:read:list_user_customized_number:admin |
| List users' phone numbers for a customized outbound caller ID | phone:read:list_user_customized_number:master |
| Update user policy | phone:update:user_policy:admin |
| Update user policy | phone:update:user_policy:master |
| Remove users' customized outbound caller ID phone numbers | phone:delete:user_customized_number phone:delete:user_customized_number:admin |
| Remove users' customized outbound caller ID phone numbers | phone:delete:user_customized_number:master |
| Update a user's shared access setting | phone:update:shared_setting phone:update:shared_setting:admin |
| Update a user's shared access setting | phone:update:shared_setting:master |
| Update user call handling setting | phone:update:user_call_handling_setting:admin phone:update:user_call_handling_setting |
| Update user call handling setting | phone:update:user_call_handling_setting:master |
| Add user call forward setting | phone:write:user_call_handling_setting phone:write:user_call_handling_setting:admin |
| Add user call forward setting | phone:write:user_call_handling_setting:master |
| Get a user's profile settings | phone:read:user_setting:admin phone:read:user_setting |
| Get a user's profile settings | phone:read:user_setting:master |
| Add a user's shared access setting | phone:write:shared_setting phone:write:shared_setting:admin |
| Add a user's shared access setting | phone:write:shared_setting:master |
| Batch add users | phone:write:batch_users:admin |
| Batch add users | phone:write:batch_users:master |
| Delete user call forward setting | phone:delete:user_call_handling_setting phone:delete:user_call_handling_setting:admin |
| Delete user call forward setting | phone:delete:user_call_handling_setting:master |
| Add a user's profile setting | phone:write:user_setting:admin phone:write:user_setting |
| Add a user's profile setting | phone:write:user_setting:master |
| Delete a user's shared access setting | phone:delete:shared_setting phone:delete:shared_setting:admin |
| Delete a user's shared access setting | phone:delete:shared_setting:master |
| Get user call handling setting | phone:read:user_call_handling_setting:admin phone:read:user_call_handling_setting |
| Get user call handling setting | phone:read:user_call_handling_setting:master |
| Update a user's profile settings | phone:update:user_setting phone:update:user_setting:admin |
| Update a user's profile settings | phone:update:user_setting:master |
| Add phone numbers for users' customized outbound caller ID | phone:write:user_customized_number phone:write:user_customized_number:admin |
| Add phone numbers for users' customized outbound caller ID | phone:write:user_customized_number:master |
| Update a user's profile | phone:update:user phone:update:user:admin |
| Update a user's profile | phone:update:user:master |
Voicemails
| API endpoint | granular scope |
|---|---|
| Get user's voicemails | phone:read:list_voicemails phone:read:list_voicemails:admin |
| Get user's voicemails | phone:read:list_voicemails:master |
| Update Voicemail Read Status | phone:update:voicemail phone:update:voicemail:admin |
| Update Voicemail Read Status | phone:update:voicemail:master |
| Get account voicemails | phone:read:list_voicemails:admin |
| Get account voicemails | phone:read:list_voicemails:master |
| Get voicemail details | phone:read:voicemail phone:read:voicemail:admin |
| Get voicemail details | phone:read:voicemail:master |
| Download a phone voicemail | phone:read:voicemail:admin phone:read:voicemail |
| Download a phone voicemail | phone:read:voicemail:master |
| Get user voicemail details from a call log | phone:read:voicemail phone:read:voicemail:admin |
| Get user voicemail details from a call log | phone:read:voicemail:master |
| Delete a voicemail | phone:delete:voicemail phone:delete:voicemail:admin |
| Delete a voicemail | phone:delete:voicemail:master |
| Get a voicemail by call element ID | phone:read:voicemail phone:read:voicemail:admin |
| Get a voicemail by call element ID | phone:read:voicemail:master |
WhatsApp Messages
| API endpoint | granular scope |
|---|---|
| Get user's WhatsApp sessions | phone:read:list_whatsapp_sessions phone:read:list_whatsapp_sessions:admin |
| Get user's WhatsApp sessions | phone:read:list_whatsapp_sessions:master |
| Get WhatsApp session details | phone:read:whatsapp_session phone:read:whatsapp_session:admin |
| Get WhatsApp session details | phone:read:whatsapp_session:master |
| Send WhatsApp message | phone:write:whatsapp_message phone:write:whatsapp_message:admin |
| Send WhatsApp message | phone:write:whatsapp_message:master |
| Get WhatsApp message by message ID | phone:read:whatsapp_message phone:read:whatsapp_message:admin |
| Get WhatsApp message by message ID | phone:read:whatsapp_message:master |
| Get account's WhatsApp sessions | phone:read:list_whatsapp_sessions phone:read:list_whatsapp_sessions:admin |
| Get account's WhatsApp sessions | phone:read:list_whatsapp_sessions:master |
Zoom Rooms
Tasks
The following are the available Tasks APIs and their associated granular scopes.
Assignee
| API endpoint | granular scope |
|---|---|
| Add assignees to a task | tasks:write:assignees tasks:write:assignees:admin |
| Get assignees of a task | tasks:read:assignees tasks:read:assignees:admin |
| Remove Assignee from task | tasks:delete:assignees tasks:delete:assignees:admin |
Collaborator
| API endpoint | granular scope |
|---|---|
| Add collaborators to a task | tasks:write:collaborators tasks:write:collaborators:admin |
| Remove collaborator from task | tasks:delete:collaborator:admin tasks:delete:collaborator |
| Get collaborators of a task | tasks:read:list_collaborators tasks:read:list_collaborators:admin |
Comment
| API endpoint | granular scope |
|---|---|
| Add a comment to a task | tasks:write:comment:admin tasks:write:comment |
| Get a task's comments | tasks:read:comments tasks:read:comments:admin |
| Delete a task's comment | tasks:delete:comment:admin tasks:delete:comment |
File
| API endpoint | granular scope |
|---|---|
| Upload a file in tasks | tasks:write:file tasks:write:file:admin |
Import
| API endpoint | granular scope |
|---|---|
| Submit a task import job | tasks:write:import tasks:write:import:admin |
| Get import job status | tasks:read:import tasks:read:import:admin |
Tasks
| API endpoint | granular scope |
|---|---|
| Update task fields | tasks:update:task tasks:update:task:admin |
| Delete a task | tasks:delete:task:admin tasks:delete:task |
| Create a new task | tasks:write:task |
| Get task details | tasks:read:task tasks:read:task:admin |
| List tasks | tasks:read:list_tasks:admin tasks:read:list_tasks |
Zoom Chat
The following are the available Zoom Chat APIs and their associated granular scopes.
Chat Channel Mention Group
| API endpoint | granular scope |
|---|---|
| List the members of a mention group | team_chat:read:mention_group team_chat:read:mention_group:admin |
| Add channel members to a mention group | team_chat:update:mention_group team_chat:update:mention_group:admin |
| List channel mention groups | team_chat:read:mention_group team_chat:read:mention_group:admin |
| Remove channel mention group members | team_chat:update:mention_group team_chat:update:mention_group:admin |
| Update a channel mention group information | team_chat:update:mention_group team_chat:update:mention_group:admin |
| Create a channel mention group | team_chat:write:mention_group:admin team_chat:write:mention_group |
| Delete a channel mention group | team_chat:delete:mention_group team_chat:delete:mention_group:admin |
Chat Channels
| API endpoint | granular scope |
|---|---|
| List channel members | team_chat:read:list_members team_chat:read:list_members:admin |
| List channel members (Groups) | team_chat:read:list_groups:admin |
| Remove a member (group) | team_chat:delete:group:admin |
| Remove a member | team_chat:delete:member team_chat:delete:member:admin |
| List channel activity logs | team_chat:read:list_channel_activity_logs:admin |
| Leave a channel | team_chat:delete:member team_chat:delete:member:admin |
| Update a chat session content tab | zoom_chat:update:chat_tab |
| Perform operations on channels | team_chat:update:archive_channels team_chat:update:archive_channels:admin |
| List user's channels | team_chat:read:list_user_channels team_chat:read:list_user_channels:admin |
| Invite channel members (Groups) | team_chat:write:groups:admin |
| Join a channel | team_chat:write:member |
| Remove a chat session content tab | zoom_chat:delete:chat_tab |
| Invite channel members | team_chat:write:members team_chat:write:members:admin |
| Get a channel | team_chat:read:channel team_chat:read:channel:admin |
| Delete a channel | team_chat:delete:channel team_chat:delete:channel:admin |
| Create a channel | team_chat:write:user_channel team_chat:write:user_channel:admin |
| Batch remove members from a channel | team_chat:delete:batch_members team_chat:delete:batch_members:admin |
| Update a channel | team_chat:update:channel team_chat:update:channel:admin |
| Add a chat session content tab | zoom_chat:write:chat_tab |
Chat Channels (Account-level)
| API endpoint | granular scope |
|---|---|
| List channel administrators | team_chat:read:list_administrators:admin |
| Get a channel | team_chat:read:user_channel team_chat:read:user_channel:admin |
| Invite channel members | team_chat:write:members team_chat:write:members:admin |
| Batch demote channel administrators | team_chat:delete:batch_administrators:admin |
| Search user's or account's channels | team_chat:write:search_channels team_chat:write:search_channels:admin |
| Promote channel members to administrators | team_chat:write:administrator:admin |
| Remove a member | team_chat:delete:member:admin |
| Batch delete channels | team_chat:delete:channels team_chat:delete:channels:admin |
| List channel members | team_chat:read:list_members team_chat:read:list_members:admin |
| Delete a channel | team_chat:delete:user_channel team_chat:delete:user_channel:admin |
| Update retention policy of a channel | team_chat:update:retention:admin |
| Get retention policy of a channel | team_chat:read:retention:admin |
| List channel activity logs | team_chat:read:list_channel_activity_logs:admin |
| List account's public channels | team_chat:read:list_channels:admin |
| Update a channel | team_chat:update:user_channel team_chat:update:user_channel:admin |
| Assign a new channel owner | team_chat:update:channel_owner:admin |
| Batch remove members from a user's channel | team_chat:delete:member:admin |
Chat Emoji
| API endpoint | granular scope |
|---|---|
| Add a custom emoji | team_chat:write:custom_emoji team_chat:write:custom_emoji:admin |
| Delete a custom emoji | team_chat:delete:custom_emoji team_chat:delete:custom_emoji:admin |
| List custom emojis | team_chat:read:list_custom_emojis team_chat:read:list_custom_emojis:admin |
Chat External Connections
Chat Files
| API endpoint | granular scope |
|---|---|
| Send a chat file | team_chat:write:message_files team_chat:write:message_files:admin |
| Get file info | team_chat:read:file team_chat:read:file:admin |
| Upload a chat file | team_chat:write:files team_chat:write:files:admin |
| Delete a chat file | team_chat:delete:file team_chat:delete:file:admin |
Chat Messages
| API endpoint | granular scope |
|---|---|
| Delete a scheduled message | team_chat:delete:scheduled_message |
| List user's chat messages | team_chat:read:list_user_messages team_chat:read:list_user_messages:admin |
| React to a chat message | team_chat:update:message_emoji team_chat:update:message_emoji:admin |
| Delete a message | team_chat:delete:user_message team_chat:delete:user_message:admin |
| Perform operations on the message of channel | team_chat:update:pin_message |
| Update a message | team_chat:update:user_message team_chat:update:user_message:admin |
| Get a forwarded message | team_chat:read:user_message team_chat:read:user_message:admin |
| Add or remove a bookmark | team_chat:update:bookmark |
| List scheduled messages | team_chat:read:list_scheduled_messages |
| Send a chat message | team_chat:write:user_message team_chat:write:user_message:admin |
| Retrieve a thread | team_chat:read:thread_message team_chat:read:thread_message:admin |
| Get a message | team_chat:read:user_message team_chat:read:user_message:admin |
| List bookmarks | team_chat:read:list_bookmarks |
| Mark message read or unread | team_chat:update:message_status team_chat:update:message_status:admin |
| List pinned history messages of channel | team_chat:read:list_pinned_messages |
Chat Migration
| API endpoint | granular scope |
|---|---|
| Get migrated Zoom channel IDs | team_chat:read:migrated_channels:admin |
| Migrate channel members | team_chat:write:migrate_channel_members:admin |
| Delete a channel tab | team_chat:delete:channel_tab:admin |
| Get migrated Zoom user IDs | team_chat:read:migrated_users:admin |
| Migrate chat messages | team_chat:write:migrate_chat_messages:admin |
| Migrate a shared space | team_chat:write:migrate_shared_spaces:admin |
| Migrate a channel tab | team_chat:write:migrate_channel_tab:admin |
| Migrate a chat channel | team_chat:write:migrate_a_chat_channel:admin |
| Migrate chat message reactions | team_chat:write:migrate_chat_message_reactions:admin |
Chat Reminder
| API endpoint | granular scope |
|---|---|
| List reminders | team_chat:read:list_reminders |
| Create a reminder message | team_chat:write:reminder |
| Delete a reminder for a message | team_chat:delete:reminder |
Chat Sessions
| API endpoint | granular scope |
|---|---|
| Star or unstar a channel or contact user | team_chat:update:chat_control team_chat:update:chat_control:admin |
| List a user's chat sessions | team_chat:read:list_user_sessions team_chat:read:list_user_sessions:admin |
Contacts
| API endpoint | granular scope |
|---|---|
| Update a user-managed contact | zoom_chat:update:personal_contact zoom_chat:update:personal_contact:admin |
| Search company contacts | contact:read:list_contacts contact:read:list_contacts:admin |
| Get user's contact details | team_chat:read:contact |
| Create a user-managed contact | zoom_chat:write:personal_contact zoom_chat:write:personal_contact:admin |
| Delete a user-managed contact | zoom_chat:delete:personal_contact zoom_chat:delete:personal_contact:admin |
| List user's contacts | team_chat:read:list_contacts |
IM Groups
| API endpoint | granular scope |
|---|---|
| Update an IM directory group | contact_group:update:group:admin |
| Update an IM directory group | contact_group:update:group:master |
| Add IM directory group members | contact_group:write:member:admin |
| Add IM directory group members | contact_group:write:member:master |
| List IM directory groups | contact_group:read:list_groups:admin |
| List IM directory groups | contact_group:read:list_groups:master |
| Delete an IM directory group | contact_group:delete:group:admin |
| Delete an IM directory group | contact_group:delete:group:master |
| Retrieve an IM directory group | contact_group:read:group:admin |
| Retrieve an IM directory group | contact_group:read:group:master |
| Delete IM directory group member | contact_group:delete:member:admin |
| Delete IM directory group member | contact_group:delete:member:master |
| Create an IM directory group | contact_group:write:group:admin |
| Create an IM directory group | contact_group:write:group:master |
| List IM directory group members | contact_group:read:list_members:admin |
| List IM directory group members | contact_group:read:list_members:master |
Invitations
| API endpoint | granular scope |
|---|---|
| Send new contact invitation | team_chat:write:contact_information:admin team_chat:write:contact_information |
Legal Hold
| API endpoint | granular scope |
|---|---|
| Add a legal hold matter | team_chat:write:legal_hold_matter:admin |
| Download legal hold files for given matter | team_chat:read:legal_hold_matter_file:admin |
| List legal hold files by given matter | team_chat:read:list_legal_hold_matter_files:admin |
| Update legal hold matter | team_chat:update:legal_hold_matter:admin |
| List legal hold matters | team_chat:read:list_legal_hold_matters:admin |
| Delete legal hold matters | team_chat:delete:legal_hold_matter:admin |
Reports
| API endpoint | granular scope |
|---|---|
| Get chat message reports | report:read:chat_session:admin |
| Get chat sessions reports | report:read:list_chat_sessions:admin |
Shared Spaces
| API endpoint | granular scope |
|---|---|
| Remove members from a shared space | team_chat:delete:shared_space_members team_chat:delete:shared_space_members:admin |
| List shared spaces | team_chat:read:list_shared_spaces team_chat:read:list_shared_spaces:admin |
| List shared space members | team_chat:read:list_shared_space_members team_chat:read:list_shared_space_members:admin |
| Delete a shared space | team_chat:delete:shared_space team_chat:delete:shared_space:admin |
| Get a shared space | team_chat:read:shared_space team_chat:read:shared_space:admin |
| Update shared space settings | team_chat:update:shared_space team_chat:update:shared_space:admin |
| Promote shared space members to administrators | team_chat:write:shared_space_administrators team_chat:write:shared_space_administrators:admin |
| List shared space channels | team_chat:read:list_shared_space_channels team_chat:read:list_shared_space_channels:admin |
| Add members to a shared space | team_chat:write:shared_space_members team_chat:write:shared_space_members:admin |
| Demote shared space administrators to members | team_chat:delete:shared_space_administrators team_chat:delete:shared_space_administrators:admin |
| Create a shared space | team_chat:write:shared_space team_chat:write:shared_space:admin |
| Move shared space channels | team_chat:update:shared_space_channels |
| Transfer shared space ownership | team_chat:update:shared_space_owner team_chat:update:shared_space_owner:admin |
Workforce Management
The following are the available Workforce Management APIs and their associated granular scopes.
Filter groups
| API endpoint | granular scope |
|---|---|
| [List filter groups](/docs/api/rest/reference/Workforce Management/methods/#operation/Listfiltergroups) | workforce_management:read:list_filter_groups:admin |
Forecasts
| API endpoint | granular scope |
|---|---|
| [Get a forecast for a scheduling group](/docs/api/rest/reference/Workforce Management/methods/#operation/Getforecastofschedulinggroup) | workforce_management:read:forecasts:admin |
| [List forecasts](/docs/api/rest/reference/Workforce Management/methods/#operation/Listforecasts) | workforce_management:read:forecasts:admin |
Imports
| API endpoint | granular scope |
|---|---|
| [Upload historical queue metrics](/docs/api/rest/reference/Workforce Management/methods/#operation/Uploadhistoricalqueuemetrics) | workforce_management:write:queue_metrics:admin |
| [Delete historical agent status](/docs/api/rest/reference/Workforce Management/methods/#operation/deleteHistoricalAgentStatus) | workforce_management:delete:agent_status:admin |
| [Upload forecast staffing](/docs/api/rest/reference/Workforce Management/methods/#operation/UploadStaffing) | workforce_management:write:staffing:admin |
| [Upload forecast](/docs/api/rest/reference/Workforce Management/methods/#operation/Uploadforecast) | workforce_management:write:import_forecast:admin |
| [Get historical queue metrics import metadata](/docs/api/rest/reference/Workforce Management/methods/#operation/Viewhistoricalqueuemetricimoprtmeta) | workforce_management:read:queue_metrics:admin |
| [ Upload historical agent status ](/docs/api/rest/reference/Workforce Management/methods/#operation/uploadHistoricalAgentStatus) | workforce_management:write:agent_status:admin |
Organizational Groups
| API endpoint | granular scope |
|---|---|
| [Get multiple organizational groups](/docs/api/rest/reference/Workforce Management/methods/#operation/getMultipleOrganizationalGroups) | workforce_management:read:organizational_groups:admin |
| [Update an organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/updateOrganizationalGroup) | workforce_management:update:organizational_groups:admin |
| [Create an organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/createOrganizationalGroup) | workforce_management:write:organizational_groups:admin |
| [Get a single organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/getOrganizationalGroup) | workforce_management:read:organizational_groups:admin |
| [Delete organizational group](/docs/api/rest/reference/Workforce Management/methods/#operation/deleteOrganizationalGroup) | workforce_management:delete:organizational_groups:admin |
Reports
| API endpoint | granular scope |
|---|---|
| [List all schedule agents](/docs/api/rest/reference/Workforce Management/methods/#operation/listScheduleAgents) | workforce_management:read:list_schedule_agents:admin |
| [List agents' adherence data](/docs/api/rest/reference/Workforce Management/methods/#operation/listAdherenceAgents) | workforce_management:read:list_adherence_agents:admin |
Schedules
| API endpoint | granular scope |
|---|---|
| [List all schedule agents](/docs/api/rest/reference/Workforce Management/methods/#operation/listSchedules) | workforce_management:read:list_schedule_agents:admin |
Scheduling groups
| API endpoint | granular scope |
|---|---|
| [List scheduling groups](/docs/api/rest/reference/Workforce Management/methods/#operation/Listschedulinggroups) | workforce_management:read:list_scheduling_groups:admin |
Users
| API endpoint | granular scope |
|---|---|
| [List users](/docs/api/rest/reference/Workforce Management/methods/#operation/Listallusers) | workforce_management:read:list_users:admin |
Zoom User
The following are the available Zoom User APIs and their associated granular scopes.
Divisions
| API endpoint | granular scope |
|---|---|
| Create a division | division:write:division:admin |
| Get a division | division:read:division:admin |
| List divisions | division:read:list_divisions:admin |
| List division members | division:read:member:admin |
| Delete a division | division:delete:division:admin |
| Update a division | division:update:division:admin |
| Assign a division | division:write:member:admin |
Groups
| API endpoint | granular scope |
|---|---|
| Delete Virtual Background files | group:delete:virtual_background_files:admin |
| Delete Virtual Background files | group:delete:virtual_background_files:master |
| Upload Virtual Background files | group:write:virtual_background_files:admin |
| Upload Virtual Background files | group:write:virtual_background_files:master |
| List group channels | group:read:list_channels:admin |
| List group channels | group:read:list_channels:master |
| Delete a group admin | group:delete:administrator:admin |
| Delete a group admin | group:delete:administrator:master |
| Update a group | group:update:group:admin |
| Update a group | group:update:group:master |
| Create a group | group:write:group:admin |
| Create a group | group:write:group:master |
| Get a group's settings | group:read:settings:admin |
| Get a group's settings | group:read:settings:master |
| Update a group's webinar registration settings | group:update:registration_settings:admin |
| Update a group's webinar registration settings | group:update:registration_settings:master |
| [Update meeting Waiting Room branding](/docs/api/rest/reference/user/methods/#operation/Update meeting Waiting Room branding-copy-1post) | group:write:waiting_room_branding:admin |
| [Update meeting Waiting Room branding](/docs/api/rest/reference/user/ma/#operation/Update meeting Waiting Room branding-copy-1post) | group:write:waiting_room_branding:master |
| List group admins | group:read:administrator:admin |
| List group admins | group:read:administrator:master |
| Delete a group member | group:delete:member:admin |
| Delete a group member | group:delete:member:master |
| Add group members | group:write:member:admin |
| Add group members | group:write:member:master |
| Update locked settings | group:update:lock_settings:admin |
| Update locked settings | group:update:lock_settings:master |
| Update a group's settings | group:update:settings:admin |
| Update a group's settings | group:update:settings:master |
| List groups | group:read:list_groups:admin |
| List groups | group:read:list_groups:master |
| [Update webinar Waiting Room branding](/docs/api/rest/reference/user/methods/#operation/Update webinar Waiting Room branding-copy-1post) | group:write:waiting_room_branding:admin |
| [Update webinar Waiting Room branding](/docs/api/rest/reference/user/ma/#operation/Update webinar Waiting Room branding-copy-1post) | group:write:waiting_room_branding:master |
| Get a group | group:read:group:admin |
| Get a group | group:read:group:master |
| Get locked settings | group:read:lock_settings:admin |
| Get locked settings | group:read:lock_settings:master |
| Add group admins | group:write:administrator:admin |
| List group members | group:read:list_members:admin |
| List group members | group:read:list_members:master |
| Update a group member | group:update:member:admin |
| Update a group member | group:update:member:master |
| Delete a group | group:delete:group:admin |
| Delete a group | group:delete:group:master |
| Get a group's webinar registration settings | group:read:registration_settings:admin |
| Get a group's webinar registration settings | group:read:registration_settings:master |
Users
| API endpoint | granular scope |
|---|---|
| List a user's collaboration devices | user:read:list_collaboration_devices user:read:list_collaboration_devices:admin |
| Get user permissions | user:read:list_permissions user:read:list_permissions:admin |
| Get user permissions | user:read:list_permissions:master |
| Delete a scheduler | user:delete:scheduler user:delete:scheduler:admin |
| Delete a scheduler | user:delete:scheduler:master |
| Create users | user:write:user:admin |
| Create users | user:write:user:master |
| Add assistants | user:write:assistant user:write:assistant:admin |
| Add assistants | user:write:assistant:master |
| Update a user's presence status | user:update:presence_status user:update:presence_status:admin |
| Get a user | user:read:user user:read:user:admin |
| Get a user | user:read:user:master |
| [Update webinar Waiting Room branding](/docs/api/rest/reference/user/methods/#operation/Update webinar Waiting Room branding-copy-0post) | user:write:waiting_room_branding user:write:waiting_room_branding:admin |
| [Update webinar Waiting Room branding](/docs/api/rest/reference/user/ma/#operation/Update webinar Waiting Room branding-copy-0post) | user:write:waiting_room_branding:master |
| Update user settings | user:update:settings user:update:settings:admin |
| Update user settings | user:update:settings:master |
| Upload a user's profile picture | user:write:profile_picture user:write:profile_picture:admin |
| Upload a user's profile picture | user:write:profile_picture:master |
| Get user summary | user:read:summary:admin |
| Get user summary | user:read:summary:master |
| Delete user schedulers | user:delete:scheduler user:delete:scheduler:admin |
| Delete user schedulers | user:delete:scheduler:master |
| Get meeting summary templates | user:read:settings user:read:settings:admin |
| Get a user presence status | user:read:presence_status user:read:presence_status:admin |
| Update a user | user:update:user user:update:user:admin |
| Update a user | user:update:user:master |
| List users | user:read:list_users:admin |
| List users | user:read:list_users:master |
| List user schedulers | user:read:list_schedulers user:read:list_schedulers:admin |
| List user schedulers | user:read:list_schedulers:master |
| Delete a user assistant | user:delete:assistant user:delete:assistant:admin |
| Delete a user assistant | user:delete:assistant:master |
| Delete a user | user:delete:user user:delete:user:admin |
| Delete a user | user:delete:user:master |
| Delete user assistants | user:delete:assistant user:delete:assistant:admin |
| Delete user assistants | user:delete:assistant:master |
| List user assistants | user:read:list_assistants user:read:list_assistants:admin |
| List user assistants | user:read:list_assistants:master |
| Update user status | user:update:status user:update:status:admin |
| Update user status | user:update:status:master |
| Get the user's ZAK | user:read:zak user:read:zak:admin |
| Update a user's email | user:update:email user:update:email:admin |
| Update a user's email | user:update:email:master |
| Revoke a user's SSO token | user:delete:token user:delete:token:admin |
| Revoke a user's SSO token | user:delete:token:master |
| Delete Virtual Background files | user:delete:virtual_background_files user:delete:virtual_background_files:admin |
| Delete Virtual Background files | user:delete:virtual_background_files:master |
| Upload Virtual Background files | user:write:virtual_background_files user:write:virtual_background_files:admin |
| Upload Virtual Background files | user:write:virtual_background_files:master |
| Get a user's token | user:read:token user:read:token:admin |
| Get a user's token | user:read:token:master |
| Bulk update features for users | user:write:feature:admin |
| Bulk update features for users | user:write:feature:master |
| Get user settings | user:read:settings user:read:settings:admin |
| Get user settings | user:read:settings:master |
| Get collaboration device detail | user:read:collaboration_device user:read:collaboration_device:admin |
| Check a user's PM room | user:read:pm_room user:read:pm_room:admin |
| Update a user's password | user:update:password user:update:password:admin |
| Update a user's password | user:update:password:master |
| Check a user email | user:read:email user:read:email:admin |
| [Update meeting Waiting Room branding](/docs/api/rest/reference/user/methods/#operation/Update meeting Waiting Room branding-copy-0post) | user:write:waiting_room_branding:admin user:write:waiting_room_branding |
| [Update meeting Waiting Room branding](/docs/api/rest/reference/user/ma/#operation/Update meeting Waiting Room branding-copy-0post) | user:write:waiting_room_branding:master |
Zoom Billing
The following are the available Zoom Billing APIs and their associated granular scopes.
Billing
| API endpoint | granular scope |
|---|---|
| Cancel a base plan | billing:update:cancel_plan:master |
| Get AI credits limit | billing:read:billing_information billing:read:billing_information:admin billing:read:billing_information:master |
| Download subaccounts' billing invoice reports | billing:read:download_invoice_reports:master |
| Download an invoice file | billing:read:download_invoice_file:master |
| Get account subscriptions information | billing:read:plan_information:admin billing:read:plan_information:master |
| Update billing information | billing:update:billing_information:master |
| Get AI credits balance | billing:read:billing_information billing:read:billing_information:admin billing:read:billing_information:master |
| List upcoming renewal accounts | billing:read:list_upcoming_renewal_accounts:master |
| Update a base plan | billing:update:plan:master |
| Get plan usage | billing:read:plan_usage:master billing:read:plan_usage:admin |
| Get invoice details | billing:read:invoice_details:master billing:read:invoice_details:admin |
| Update an account's additional plan | billing:update:additional_plans:master |
| Get account plan information | billing:read:plan_information:master billing:read:plan_information:admin |
| Get billing information | billing:read:billing_information:master billing:read:billing_information:admin |
| List billing invoices | billing:read:list_invoices:master billing:read:list_invoices:admin |
| Update AI credits limit | billing:update:billing_information billing:update:billing_information:admin billing:update:billing_information:master |
| Subscribe subaccount to an additional plan | billing:write:subscribe_additional_plans:master |
| Get AI credits usage | billing:read:billing_information billing:read:billing_information:admin billing:read:billing_information:master |
| Get account subscriptions usage | billing:read:plan_usage:admin billing:read:plan_usage:master |
| Cancel additional plans | billing:update:cancel_additional_plans:master |
| Download an invoice file (v2) | billing:read:download_invoice_file:master |
| Delete subaccounts' billing invoice report | billing:delete:invoice_report:master |
| Subscribe an account to a plan | billing:write:subscribe_plan:master |
Zoom Scheduler
The following are the available Zoom Scheduler APIs and their associated granular scopes.
Routing Forms
| API endpoint | granular scope |
|---|---|
| get routing response | scheduler:read:routing scheduler:read:routing:admin |
| list account routing response | scheduler:read:routing scheduler:read:routing:admin |
analytics
| API endpoint | granular scope |
|---|---|
| Report analytics | scheduler:read:analytics scheduler:read:analytics:admin |
availability
| API endpoint | granular scope |
|---|---|
| Get availability | scheduler:read:availability scheduler:read:availability:admin |
| Patch availability | scheduler:update:availability scheduler:update:availability:admin |
| Insert availability | scheduler:write:availability scheduler:write:availability:admin |
| Delete availability | scheduler:delete:availability scheduler:delete:availability:admin |
| List availability | scheduler:read:list_availability scheduler:read:list_availability:admin |
scheduled events
| API endpoint | granular scope |
|---|---|
| Patch scheduled events | scheduler:update:scheduled_event scheduler:update:scheduled_event:admin |
| Create a booking for a schedule slot | scheduler:write:scheduled_event scheduler:write:scheduled_event:admin |
| List scheduled events | scheduler:read:list_scheduled_events scheduler:read:list_scheduled_events:admin |
| Get scheduled event attendee | scheduler:read:scheduled_event_attendee scheduler:read:scheduled_event_attendee:admin |
| Get scheduled events | scheduler:read:scheduled_event scheduler:read:scheduled_event:admin |
| Delete scheduled events | scheduler:delete:scheduled_event scheduler:delete:scheduled_event:admin |
schedules
| API endpoint | granular scope |
|---|---|
| List schedules | scheduler:read:list_schedule scheduler:read:list_schedule:admin |
| Patch schedules | scheduler:update:patch_schedule scheduler:update:patch_schedule:admin |
| Insert schedules | scheduler:write:insert_schedule scheduler:write:insert_schedule:admin |
| Get schedules | scheduler:read:get_schedule scheduler:read:get_schedule:admin |
| Delete schedules | scheduler:delete:delete_schedule scheduler:delete:delete_schedule:admin |
| List schedule available times | scheduler:read:get_schedule scheduler:read:get_schedule:admin |
scheduling links
| API endpoint | granular scope |
|---|---|
| Single use link | scheduler:write:single_use_link scheduler:write:single_use_link:admin |
shares
| API endpoint | granular scope |
|---|---|
| Create shares | scheduler:write:share scheduler:write:share:admin |
team
| API endpoint | granular scope |
|---|---|
| List team | scheduler:read:get_schedule scheduler:read:get_schedule:admin |
users
| API endpoint | granular scope |
|---|---|
| Get user | scheduler:read:user scheduler:read:user:admin |
Video SDK
The following are the available Video SDK APIs and their associated granular scopes.
Byos Storage
| API endpoint | granular scope |
|---|---|
| Change storage location detail | video_sdk:update:storage_location_detail:admin |
| Change storage location detail | video_sdk:update:storage_location_detail:master |
| Add storage location | video_sdk:write:storage_location:admin |
| Add storage location | video_sdk:write:storage_location:master |
| Update Bring Your Own Storage settings | video_sdk:update:storage_location_settings:admin |
| Update Bring Your Own Storage settings | video_sdk:update:storage_location_settings:master |
| Delete storage location detail | video_sdk:delete:storage_location_detail:admin |
| Delete storage location detail | video_sdk:delete:storage_location_detail:master |
| Storage location detail | video_sdk:read:storage_location_detail:admin |
| Storage location detail | video_sdk:read:storage_location_detail:master |
| List storage location | video_sdk:read:storage_location:admin |
| List storage location | video_sdk:read:storage_location:master |
Cloud Recording
| API endpoint | granular scope |
|---|---|
| Recover a single recording | video_sdk:update:recover_recording_file:admin |
| Recover a single recording | video_sdk:update:recover_recording_file:master |
| Delete session's recording file | video_sdk:delete:recording_file:admin |
| Delete session's recording file | video_sdk:delete:recording_file:master |
| Delete session's recordings | video_sdk:delete:session_recordings:admin |
| Delete session's recordings | video_sdk:delete:session_recordings:master |
| List recordings of an account | video_sdk:read:list_account_recordings:admin |
| List recordings of an account | video_sdk:read:list_account_recordings:master |
| List session's recordings | video_sdk:read:list_session_recordings:admin |
| List session's recordings | video_sdk:read:list_session_recordings:master |
| Recover session's recordings | video_sdk:update:recover_session_recordings:admin |
| Recover session's recordings | video_sdk:update:recover_session_recordings:master |
Sessions
| API endpoint | granular scope |
|---|---|
| Get a session SIP URI with passcode | video_sdk:write:session_sip_dialing:admin |
| Get session user QoS | video_sdk:read:seesion_user_qos:admin |
| Get session user QoS | video_sdk:read:seesion_user_qos:master |
| List sessions | video_sdk:read:session_list:admin |
| List sessions | video_sdk:read:session_list:master |
| List session users | video_sdk:read:session_users:admin |
| List session users | video_sdk:read:session_users:master |
| Update session status | video_sdk:update:session_status:admin |
| Update session status | video_sdk:update:session_status:master |
| Update a session live stream | video_sdk:update:session_livestream:admin |
| Update a session live stream | video_sdk:update:session_livestream:master |
| Get a stream ingestion | video_sdk:read:stream_ingestion:admin |
| Get a stream ingestion | video_sdk:read:stream_ingestion:master |
| Update session livestream status | video_sdk:update:session_livestream_status:admin |
| Update session livestream status | video_sdk:update:session_livestream_status:master |
| List stream ingestions | video_sdk:read:list_stream_ingestions:admin |
| List stream ingestions | video_sdk:read:list_stream_ingestions:master |
| Get session details | video_sdk:read:session_detail:admin |
| Get session details | video_sdk:read:session_detail:master |
| Get sharing/recording details | video_sdk:read:session_user_sharing:admin |
| Get sharing/recording details | video_sdk:read:session_user_sharing:master |
| List session streaming ingestions | video_sdk:read:list_session_stream_ingestions:admin |
| List session streaming ingestions | video_sdk:read:list_session_stream_ingestions:master |
| Create a session | video_sdk:write:session:admin |
| Create a session | video_sdk:write:session:master |
| Delete a session | video_sdk:delete:session:admin |
| Delete a session | video_sdk:delete:session:master |
| Use in-session events controls | video_sdk:update:in_session_controls:admin |
| Use in-session events controls | video_sdk:update:in_session_controls:master |
| List session users QoS | video_sdk:read:session_users_qos:admin |
| List session users QoS | video_sdk:read:session_users_qos:master |
| Delete a stream ingestion | video_sdk:delete:stream_ingestion:admin |
| Delete a stream ingestion | video_sdk:delete:stream_ingestion:master |
| Create a stream ingestion | video_sdk:write:stream_ingestion:admin |
| Create a stream ingestion | video_sdk:write:stream_ingestion:master |
| Get session live stream details | video_sdk:read:session_livestream:admin |
| Get session live stream details | video_sdk:read:session_livestream:master |
| Update Realtime Media Streams (RTMS) app status | video_sdk:update:session_rtms_app_status:admin |
| Update a stream ingestion | video_sdk:update:stream_ingestion:admin |
| Update a stream ingestion | video_sdk:update:stream_ingestion:master |
Video SDK Reports
| API endpoint | granular scope |
|---|---|
| Get operation logs report | video_sdk:read:operation_log:admin |
| Get operation logs report | video_sdk:read:operation_log:master |
| Get telephone report | video_sdk:read:telephone:admin |
| Get telephone report | video_sdk:read:telephone:master |
| Get daily usage report | video_sdk:read:daily_report:admin |
| Get daily usage report | video_sdk:read:daily_report:master |
Workflow
The following are the available Workflow APIs and their associated granular scopes.
ai
| API endpoint | granular scope |
|---|---|
| Start an ad-hoc agentic workflow asynchronously | workflow:write:definition workflow:write:definition:admin |
| List user-owned agentic workflows | workflow:read:definition workflow:read:definition:admin |
| Get an agentic workflow definition | workflow:read:definition:admin workflow:read:definition |
| Undeploy an agentic workflow | workflow:write:definition workflow:write:definition:admin |
| Get an agentic workflow execution | workflow:read:definition workflow:read:definition:admin |
| Describe an agentic workflow node | workflow:read:definition workflow:read:definition:admin |
| Resume an agentic workflow waiting for human input | workflow:write:definition workflow:write:definition:admin |
| Create or update and deploy an agentic workflow | workflow:write:definition workflow:write:definition:admin |
| List activities for a published agentic workflow | workflow:read:list_definitions workflow:read:list_definitions:admin |
AI Companion
The following are the available AI Companion APIs and their associated granular scopes.
Archived
| API endpoint | granular scope |
|---|---|
| [Get AI Companion conversation archives](/docs/api/rest/reference/AI Companion/methods/#operation/GetAICconversationarchives) | aic:read:conversation_archives:admin |
Zoom Quality Management
The following are the available Zoom Quality Management APIs and their associated granular scopes.
Calibrations
| API endpoint | granular scope |
|---|---|
| [List calibrations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListCalibrations) | zoom_quality_management:read:calibrations zoom_quality_management:read:calibrations:admin |
| [Get calibration detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/GetCalibrationDetail) | zoom_quality_management:read:calibrations zoom_quality_management:read:calibrations:admin |
Cases
| API endpoint | granular scope |
|---|---|
| [Get case details](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/getCaseDetails) | zoom_quality_management:read:cases zoom_quality_management:read:cases:admin |
| [List cases](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/listCases) | zoom_quality_management:read:cases zoom_quality_management:read:cases:admin |
Evaluations
| API endpoint | granular scope |
|---|---|
| [List automated evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListAutomatedEvaluations) | zoom_quality_management:read:evaluations:admin zoom_quality_management:read:evaluations |
| [View evaluation detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/EvaluationDetail) | zoom_quality_management:read:evaluations zoom_quality_management:read:evaluations:admin |
| [List evaluations](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Listevaluations) | zoom_quality_management:read:evaluations zoom_quality_management:read:evaluations:admin |
Interactions
| API endpoint | granular scope |
|---|---|
| [View interaction detail](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/InteractionDetail) | zoom_quality_management:read:interactions zoom_quality_management:read:interactions:admin |
| [Add an interaction](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/Addinteraction) | zoom_quality_management:write:interactions zoom_quality_management:write:interactions:admin |
| [List interactions](/docs/api/rest/reference/Zoom Quality Management/methods/#operation/ListInteractions) | zoom_quality_management:read:interactions zoom_quality_management:read:interactions:admin |
Zoom Revenue Accelerator
The following are the available Zoom Revenue Accelerator APIs and their associated granular scopes.
Accounts
| API endpoint | granular scope |
|---|---|
| Get indicators settings [Deprecated] | zra:read:indicator zra:read:indicator:admin |
| Get indicators settings | zra:read:indicator zra:read:indicator:admin |
Conversations
| API endpoint | granular scope |
|---|---|
| Upload iq multipart file. | zra:write:file zra:write:file:admin |
| Get conversation comments [Deprecated] | zra:read:list_conversation_comments zra:read:list_conversation_comments:admin |
| Delete conversation's comment [Deprecated] | zra:delete:conversation_comment zra:delete:conversation_comment:admin |
| Add new comments to the conversation [Deprecated] | zra:write:conversation_comment zra:write:conversation_comment:admin |
| Add new comments to the conversation | zra:read:list_conversation_comments zra:read:list_conversation_comments:admin |
| Get conversation content analysis [Deprecated] | zra:read:conversation_analysis zra:read:conversation_analysis:admin |
| Get a user's playlist [Deprecated] | zra:read:list_conversation_playlists zra:read:list_conversation_playlists |
| Get conversation comments | zra:read:list_conversation_comments zra:read:list_conversation_comments:admin |
| List conversations [Deprecated] | zra:read:list_conversations zra:read:list_conversations:admin |
| Update conversation host id to new host id by conversation id [Deprecated] | zra:update:conversation_host zra:update:conversation_host:admin |
| Delete conversation by conversation ID [Deprecated] | zra:delete:conversations zra:delete:conversations:admin |
| Get conversation content analysis | zra:read:conversation_analysis zra:read:conversation_analysis:admin |
| Update conversation host id to new host id by conversation id | zra:update:conversation_host zra:update:conversation_host:admin |
| Delete conversation's comment | zra:delete:conversation_comment zra:delete:conversation_comment:admin |
| Upload iq multipart file. [Deprecated] | zra:write:file zra:write:file:admin |
| Get conversation information [Deprecated] | zra:read:conversations:admin zra:read:conversations |
| Add conversation by meeting record url or meeting UUID. | zra:write:conversation zra:write:conversation:admin |
| Upload IQ file | zra:write:file zra:write:file:admin |
| Add conversation by file id or download url. | zra:write:conversation zra:write:conversation:admin |
| Add conversation by file id or download url. [Deprecated] | zra:write:conversation zra:write:conversation:admin |
| Edit conversation comment [Deprecated] | zra:update:conversation_comment zra:update:conversation_comment:admin |
| Get conversation information | zra:read:conversations:admin zra:read:conversations |
| Get conversation scorecards [Deprecated] | zra:read:conversation_scorecards zra:read:conversation_scorecards:admin |
| Upload IQ file [Deprecated] | zra:write:file zra:write:file:admin |
| Initiate and complete a multipart upload. | zra:write:file zra:write:file:admin |
| [Initiate and complete a multipart upload. [Deprecated]](/docs/api/rest/reference/iq/methods/#operation/InitiateAndCompleteAMultipartUpload. [Deprecated]) | zra:write:file zra:write:file:admin |
| Get a user's playlist | zra:read:list_conversation_playlists zra:read:list_conversation_playlists |
| List conversations | zra:read:list_conversations zra:read:list_conversations:admin |
| Get conversation interactions | zra:read:conversation_participants zra:read:conversation_participants:admin |
| Edit conversation comment | zra:update:conversation_comment zra:update:conversation_comment:admin |
| Delete conversation by conversation ID | zra:delete:conversations zra:delete:conversations:admin |
| Get conversation scorecards | zra:read:conversation_scorecards zra:read:conversation_scorecards:admin |
| Get conversation interactions [Deprecated] | zra:read:conversation_participants zra:read:conversation_participants:admin |
| Add conversation by meeting record url or meeting UUID. [Deprecated] | zra:write:conversation zra:write:conversation:admin |
Custom CRM
| API endpoint | granular scope |
|---|---|
| Unregister CRM API connection | zra:delete:crm_registration:admin |
| Get imported CRM leads | zra:read:crm_lead:admin |
| Bulk import CRM leads | zra:write:crm_lead:admin |
| Get imported CRM contacts | zra:read:crm_contact:admin |
| Get current CRM API registration | zra:read:crm_registration:admin |
| Get imported CRM deals | zra:read:crm_deal:admin |
| Register CRM API connection | zra:write:crm_registration:admin |
| Get imported CRM accounts | zra:read:crm_account:admin |
| Bulk import CRM accounts | zra:write:crm_accounts:admin |
| Bulk import CRM contacts | zra:write:crm_contact:admin |
| Bulk import CRM deals | zra:write:crm_deal:admin |
| Poll async task result | zra:read:crm_task:admin |
Deals
| API endpoint | granular scope |
|---|---|
| Delete activity from the deal | zra:delete:deal_activity zra:delete:deal_activity:admin |
| Get deal information [Deprecated] | zra:read:deal zra:read:deal:admin |
| List deals | zra:read:list_deals zra:read:list_deals:admin |
| Get deal activities [Deprecated] | zra:read:list_deal_activities zra:read:list_deal_activities:admin |
| Get deal information | zra:read:deal zra:read:deal:admin |
| Get deal activities | zra:read:list_deal_activities zra:read:list_deal_activities:admin |
| List deals [Deprecated] | zra:read:list_deals zra:read:list_deals:admin |
| Delete activity from the deal [Deprecated] | zra:delete:deal_activity zra:delete:deal_activity:admin |
ScheduleMeetings
| API endpoint | granular scope |
|---|---|
| List scheduled meetings | zra:read:list_conversations zra:read:list_conversations:admin |
Teams
| API endpoint | granular scope |
|---|---|
| Delete Team | zra:delete:team:admin |
| Get Team Detail | zra:read:team:admin |
| Assign Team Managers | zra:write:team_manages:admin |
| Assign Team Members | zra:write:team_members:admin |
| List Account Teams | zra:read:team_list:admin zra:read:team_list |
| List Unassigned Team Users | zra:read:unassigned_team_users:admin |
| List Team Managers | zra:read:team_managers:admin zra:read:team_managers |
| Move team to new parent | zra:update:team:admin |
| List Team Members | zra:read:team_members:admin zra:read:team_members |
| Remove additional access from current team | zra:delete:team:admin |
| Update Team name | zra:update:team:admin |
| Unassign Team Members | zra:delete:team_members:admin |
| Create Team | zra:write:team:admin |
| Grant additional access to current team | zra:write:team:admin |
| Remove additional access from target teams | zra:delete:team:admin |
| Unassign Team Managers | zra:delete:team_managers:admin |
| Grant additional access to target teams | zra:write:team:admin |
Users
| API endpoint | granular scope |
|---|---|
| Get User info | zra:read:user zra:read:user:admin |
Cobrowse SDK
The following are the available Cobrowse SDK APIs and their associated granular scopes.
Sessions
| API endpoint | granular scope |
|---|---|
| [List past sessions](/docs/api/rest/reference/Cobrowse SDK/methods/#operation/Listpastsession) | cobrowse_sdk:read:list_past_sessions:admin |
| [Get session details](/docs/api/rest/reference/Cobrowse SDK/methods/#operation/Getasession) | cobrowse_sdk:read:session_details:admin |
| [List session users](/docs/api/rest/reference/Cobrowse SDK/methods/#operation/Listsessionusers) | cobrowse_sdk:read:list_session_users:admin |
| [List live sessions](/docs/api/rest/reference/Cobrowse SDK/methods/#operation/Listlivesessions) | cobrowse_sdk:read:list_live_sessions:admin |
Integration Healthcare
The following are the available Integration Healthcare APIs and their associated granular scopes.
clinicalnotes
| API endpoint | granular scope |
|---|---|
| [List clinical notes](/docs/api/rest/reference/Integration Healthcare/methods/#operation/GetClinicalNote) | healthcare:read:list_clinical_notes:admin healthcare:read:list_clinical_notes:master |
| [Get a Clinical Note](/docs/api/rest/reference/Integration Healthcare/methods/#operation/GetaClinicalNote) | healthcare:read:clinical_notes:admin healthcare:read:clinical_notes:master |
| [Update a Clinical Note](/docs/api/rest/reference/Integration Healthcare/methods/#operation/UpdateClinicalNote) | healthcare:update:clinical_notes:admin healthcare:update:clinical_notes:master |
Zoom Rooms
The following are the available Zoom Rooms APIs and their associated granular scopes.
Room Apps
| API endpoint | granular scope |
|---|---|
| Config Zoom Room Controller Apps | zoom_rooms:write:zoom_apps:admin |
Visitor Management
| API endpoint | granular scope |
|---|---|
| Get a list of visitors by location | visitor_management:read:list_invitations visitor_management:read:list_invitations:admin |
| Invitation details by invitationID | visitor_management:read:invitation_details visitor_management:read:invitation_details:admin |
| Update an invitation | visitor_management:update:invitation visitor_management:update:invitation:admin |
| Send an invitation | visitor_management:write:invitation visitor_management:write:invitation:admin |
| Check in a visitor | visitor_management:write:check_in visitor_management:write:check_in:admin |
| Delete an Invitation | visitor_management:delete:invitation visitor_management:delete:invitation:admin |
Workspaces
| API endpoint | granular scope |
|---|---|
| Add a workspace photo | workspace:write:workspace:admin |
| Get a floor's reservations | workspace:read:list_floor_workspace_reservations:admin workspace:read:list_floor_workspace_reservations:master |
| Create a reservation | workspace:write:reservation workspace:write:reservation:admin |
| Get a workspace's reservations | workspace:read:list_reservations workspace:read:list_reservations:admin |
| Delete workspace photos | workspace:delete:photo:admin |
| Get a workspace | workspace:read:list_workspaces workspace:read:list_workspaces:admin |
| Get a neighborhood | workspace:read:neighborhood:admin |
| Update a reservation | workspace:update:reservation workspace:update:reservation:admin |
| Edit a workspace asset | workspace:update:asset:admin |
| Delete Workspace floor map | workspace:write:location workspace:write:location:admin |
| Create a workspace | workspace:write:workspace:admin |
| List workspace reservation questionnaires | workspace:read:reservation:admin workspace:read:reservation:master |
| List workspace additional information with time range | workspace:read:list_workspaces workspace:read:list_workspaces:admin |
| List released workspaces by timeout | zoom_rooms:read:list_release_infos:admin |
| Check in/out of a reservation | workspace:write:events workspace:write:events:admin |
| Get all workspace assets | workspace:read:asset:admin |
| Create a workspace asset | workspace:write:asset:admin |
| List workspace reservations by locations | workspace:read:list_reservations:admin workspace:read:list_reservations:master |
| Get a workspace reservation by reservationId | workspace:read:reservation workspace:read:reservation:admin |
| Get Workspace Calendar Free/Busy Event | workspace:read:workspace:admin |
| List workspaces | workspace:read:list_workspaces workspace:read:list_workspaces:admin |
| Delete a workspace | workspace:delete:workspace:admin |
| Get workspace settings | workspace:read:settings:admin |
| List neighborhoods | workspace:read:neighborhood:admin |
| Get a workspace QR code | workspace:read:qr:admin |
| Update workspace settings | workspace:update:setting:admin workspace:update:setting:master |
| Update a workspace | workspace:update:workspace:admin |
| Delete a reservation | workspace:delete:reservation workspace:delete:reservation:admin |
| Delete neighborhoods | workspace:delete:neighborhood:admin |
| Get a workspace location floor map | workspace:read:location workspace:read:location:admin |
| Get questionnaire answer summary | workspace:read:workspace_reservation_questionnaire_response:admin workspace:read:workspace_reservation_questionnaire_response:master |
| Get a location's hot desk usage | workspace:read:usage workspace:read:usage:admin |
| Add or Update a Workspace floor map | workspace:write:location workspace:write:location:admin |
| Get a user's workspace's reservations | workspace:read:list_reservations:admin |
| Get a workspace asset | workspace:read:asset:admin |
| Set Workspace Calendar Free/Busy Event | workspace:write:workspace:admin |
| Delete a workspace asset | workspace:delete:asset:admin |
| Set a desk assignment | workspace:write:assignment:admin |
| Get a desk assignment | workspace:read:assignment workspace:read:assignment:admin |
| Delete a desk assignment | workspace:delete:assignment:admin |
Zoom Rooms
| API endpoint | granular scope |
|---|---|
| Get device information | zoom_rooms:read:device_profile:admin |
| List Zoom Rooms | zoom_rooms:read:list_rooms:admin |
| List Zoom Rooms | zoom_rooms:read:list_rooms:master |
| Delete a device profile | zoom_rooms:delete:device_profile:admin |
| Delete a device profile | zoom_rooms:delete:device_profile:master |
| Apply configuration profile for Zoom Rooms | zoom_rooms:update:room_settings:admin |
| Apply configuration profile for Zoom Rooms | zoom_rooms:update:room_settings:master |
| Use Zoom Room controls | zoom_rooms:update:room_control:admin |
| Use Zoom Room controls | zoom_rooms:update:room_control:master |
| Update E911 digital signage | zoom_rooms:update:room_controls:admin |
| Update E911 digital signage | zoom_rooms:update:room_controls:master |
| Create a device profile | zoom_rooms:write:device_profile:admin |
| Create a device profile | zoom_rooms:write:device_profile:master |
| Update Zoom Room settings | zoom_rooms:update:room_settings:admin |
| Update Zoom Room settings | zoom_rooms:update:room_settings:master |
| List Zoom Room devices | zoom_rooms:read:list_devices:admin |
| List Zoom Room devices | zoom_rooms:read:list_devices:master |
| Get Zoom Room profile | zoom_rooms:read:room:admin |
| Get Zoom Room profile | zoom_rooms:read:room:master |
| Delete a Zoom Room | zoom_rooms:delete:room:admin |
| Delete a Zoom Room | zoom_rooms:delete:room:master |
| Get Zoom Rooms virtual controller URL | zoom_rooms:read:virtual_controller:admin |
| Get Zoom Rooms virtual controller URL | zoom_rooms:read:virtual_controller:admin |
| Update a Zoom Room profile | zoom_rooms:update:room:admin |
| Update a Zoom Room profile | zoom_rooms:update:room:master |
| Change a Zoom Room's location | zoom_rooms:update:room_location:admin |
| Change a Zoom Room's location | zoom_rooms:update:room_location:master |
| List device profiles | zoom_rooms:read:list_device_profiles:admin |
| List device profiles | zoom_rooms:read:list_device_profiles:master |
| Get Zoom Room settings | zoom_rooms:read:room_settings:admin |
| Get Zoom Room settings | zoom_rooms:read:room_settings:master |
| Add a Zoom Room | zoom_rooms:write:room:admin |
| Add a Zoom Room | zoom_rooms:write:room:master |
| Get Zoom Room sensor data | zoom_rooms:read:sensor_data:admin |
| Update a device profile | zoom_rooms:update:device_profile:admin |
| Update a device profile | zoom_rooms:update:device_profile:master |
| Get a device profile | zoom_rooms:read:device_profile:admin |
| Get a device profile | zoom_rooms:read:device_profile:master |
Zoom Rooms Account
| API endpoint | granular scope |
|---|---|
| Get Zoom Room account profile | zoom_rooms:read:account_profile:admin |
| Get Zoom Room account profile | zoom_rooms:read:account_profile:master |
| Update Zoom Room account profile | zoom_rooms:update:account_profile:admin |
| Update Zoom Room account profile | zoom_rooms:update:account_profile:master |
| Get Zoom Room account settings | zoom_rooms:read:account_settings:admin |
| Get Zoom Room account settings | zoom_rooms:read:account_settings:master |
| Update Zoom Room account settings | zoom_rooms:update:account_settings:admin |
| Update Zoom Room account settings | zoom_rooms:update:account_settings:master |
Zoom Rooms Calendar
| API endpoint | granular scope |
|---|---|
| Start calendar service sync process | zoom_rooms:update:calendar_service:admin |
| List calendar services | zoom_rooms:read:list_calendar_services:admin |
| List calendar resources by calendar service | zoom_rooms:read:list_calendar_resources:admin |
| Add a calendar resource to a calendar service | zoom_rooms:write:calendar_resource:admin |
| Delete a calendar resource | zoom_rooms:delete:calendar_resource:admin |
| Get a calendar resource by ID | zoom_rooms:read:calendar_resource:admin |
| Delete a calendar service | zoom_rooms:delete:calendar_service:admin |
Zoom Rooms Content
| API endpoint | granular scope |
|---|---|
| List Digital Signage library playlist published rooms | zoom_rooms:read:digital_signage_library_playlists:admin |
| List Digital Signage library playlist published rooms | zoom_rooms:read:digital_signage_library_playlists:master |
| Add Zoom Rooms background image library content | zoom_rooms:write:background_library_content:admin |
| Update Zoom Rooms Background Image Library Folder | zoom_rooms:update:background_library_folder:admin |
| List default Zoom Rooms background image library contents | zoom_rooms:read:background_library_content:admin |
| Add a digital signage URL | zoom_rooms:write:digital_signage_library_contents:admin |
| Add a digital signage URL | zoom_rooms:write:digital_signage_library_contents:master |
| Update Digital Signage library playlist published rooms | zoom_rooms:write:digital_signage_library_playlists:admin |
| Update Digital Signage library playlist published rooms | zoom_rooms:write:digital_signage_library_playlists:master |
| Add Zoom Rooms Background Image Library Folder | zoom_rooms:write:background_library_folder:admin |
| Delete Zoom Rooms Background Image Library Folder | zoom_rooms:delete:background_library_folder:admin |
| Add a Digital Signage library playlist | zoom_rooms:write:digital_signage_library_playlists:admin |
| Add a Digital Signage library playlist | zoom_rooms:write:digital_signage_library_playlists:master |
| Delete Digital Signage library playlist | zoom_rooms:write:digital_signage_library_playlists:admin |
| Delete Digital Signage library playlist | zoom_rooms:write:digital_signage_library_playlists:master |
| Update Digital Signage library playlist content items | zoom_rooms:write:digital_signage_library_playlists:admin |
| Update Digital Signage library playlist content items | zoom_rooms:write:digital_signage_library_playlists:master |
| Get Zoom Rooms Background Image Library Folder | zoom_rooms:read:background_library_folder:admin |
| List Zoom Rooms Background Image Library Folders | zoom_rooms:read:background_library_folder:admin |
| List Digital Signage library playlists | zoom_rooms:read:digital_signage_library_playlists:admin |
| List Digital Signage library playlists | zoom_rooms:read:digital_signage_library_playlists:master |
| Update a digital signage content folder | zoom_rooms:write:digital_signage_library_contents:admin |
| Update a digital signage content folder | zoom_rooms:write:digital_signage_library_contents:master |
| Add a digital signage content folder | zoom_rooms:write:digital_signage_library_contents:admin |
| Add a digital signage content folder | zoom_rooms:write:digital_signage_library_contents:master |
| Get Digital Signage content folder | zoom_rooms:read:digital_signage_library_contents:admin |
| Get Digital Signage content folder | zoom_rooms:read:digital_signage_library_contents:master |
| Update a Digital Signage content item attributes | zoom_rooms:write:digital_signage_library_contents:admin |
| Update a Digital Signage content item attributes | zoom_rooms:write:digital_signage_library_contents:master |
| Get Digital Signage library playlist content items | zoom_rooms:read:digital_signage_library_playlists:admin |
| Get Digital Signage library playlist content items | zoom_rooms:read:digital_signage_library_playlists:master |
| Get Digital Signage content item | zoom_rooms:read:digital_signage_library_contents:admin |
| Get Digital Signage content item | zoom_rooms:read:digital_signage_library_contents:master |
| Get Zoom Rooms background image library content | zoom_rooms:read:background_library_content:admin |
| List Zoom Rooms background image library contents | zoom_rooms:read:background_library_content:admin |
| Get Digital Signage library playlist | zoom_rooms:read:digital_signage_library_playlists:admin |
| Get Digital Signage library playlist | zoom_rooms:read:digital_signage_library_playlists:master |
| Delete a Digital Signage content item | zoom_rooms:write:digital_signage_library_contents:admin |
| Delete a Digital Signage content item | zoom_rooms:write:digital_signage_library_contents:master |
| Add a digital signage image or video | zoom_rooms:write:digital_signage_library_contents:admin |
| Add a digital signage image or video | zoom_rooms:write:digital_signage_library_contents:master |
| Delete a Digital Signage content folder | zoom_rooms:write:digital_signage_library_contents:admin |
| Delete a Digital Signage content folder | zoom_rooms:write:digital_signage_library_contents:master |
| Update Zoom Rooms background image library content | zoom_rooms:update:background_library_content:admin |
| List Digital Signage content items | zoom_rooms:read:digital_signage_library_contents:admin |
| List Digital Signage content items | zoom_rooms:read:digital_signage_library_contents:master |
| Update a Digital Signage library playlist | zoom_rooms:write:digital_signage_library_playlists:admin |
| Update a Digital Signage library playlist | zoom_rooms:write:digital_signage_library_playlists:master |
| Update a Digital Signage image or video file | zoom_rooms:write:digital_signage_library_contents:admin |
| Update a Digital Signage image or video file | zoom_rooms:write:digital_signage_library_contents:master |
| Delete Zoom Rooms Background Image Library Content | zoom_rooms:delete:background_library_content:admin |
Zoom Rooms Devices
| API endpoint | granular scope |
|---|---|
| Change Zoom Rooms app version | zoom_rooms:update:device_app_version:admin |
| Change Zoom Rooms app version | zoom_rooms:update:device_app_version:master |
| Delete a Zoom Room user device | zoom_rooms:delete:device:admin |
Zoom Rooms Location
| API endpoint | granular scope |
|---|---|
| Add a location | zoom_rooms:write:location:admin |
| Add a location | zoom_rooms:write:location:master |
| Get Zoom Room location structure | zoom_rooms:read:location_hierarchy:admin |
| Get Zoom Room location structure | zoom_rooms:read:location_hierarchy:master |
| Update Zoom Rooms location structure | zoom_rooms:update:location_hierarchy:admin |
| Update Zoom Rooms location structure | zoom_rooms:update:location_hierarchy:master |
| Delete a location | zoom_rooms:write:location:admin |
| Delete a location | zoom_rooms:write:location:master |
| Change the assigned parent location | zoom_rooms:update:location:admin |
| Change the assigned parent location | zoom_rooms:update:location:master |
| List Zoom Room locations | zoom_rooms:read:list_locations:admin |
| List Zoom Room locations | zoom_rooms:read:list_locations:master |
| Update location settings | zoom_rooms:update:location_settings:admin |
| Update location settings | zoom_rooms:update:location_settings:master |
| Get location settings | zoom_rooms:read:location_settings:admin |
| Get location settings | zoom_rooms:read:location_settings:master |
| Update Zoom Room location profile | zoom_rooms:update:location:admin |
| Update Zoom Room location profile | zoom_rooms:update:location:master |
| Get Zoom Room location profile | zoom_rooms:read:location:admin |
| Get Zoom Room location profile | zoom_rooms:read:location:master |
Zoom Rooms Tags
| API endpoint | granular scope |
|---|---|
| Assign Tags to Zoom Rooms By Location ID | zoom_rooms:update:room_tag:admin |
| List all Zoom Room Tags | zoom_rooms:read:list_tags:admin |
| Assign Tags to a Zoom Room | zoom_rooms:update:room_tag:admin |
| Create a new Zoom Rooms Tag | zoom_rooms:write:tag:admin |
| Delete Tag | zoom_rooms:delete:tag:admin |
| Un-assign Tags from a Zoom Room | zoom_rooms:delete:room_tag:admin |
| Edit Tag | zoom_rooms:update:tag:admin |
QSS
The following are the available QSS APIs and their associated granular scopes.
Dashboards
| API endpoint | granular scope |
|---|---|
| List meeting participants QoS Summary | dashboard:read:list_meeting_participants_qos:admin |
| List meeting participants QoS Summary | dashboard:read:list_meeting_participants_qos:master |
| List webinar participants QoS Summary | dashboard:read:list_webinar_participants_qos:admin |
| List webinar participants QoS Summary | dashboard:read:list_webinar_participants_qos:master |
Video SDK Sessions
| API endpoint | granular scope |
|---|---|
| List session users QoS Summary | qss:read:session_users_summary:admin |
| List session users QoS Summary | qss:read:session_users_summary:master |
Conference Room Connector (CRC)
The following are the available Conference Room Connector (CRC) APIs and their associated granular scopes.
Account
| API endpoint | granular scope |
|---|---|
| Get Cisco/Polycom Room Account Setting | crc:read:rooms_account_settings:admin |
| Get Cisco/Polycom Room Account Setting | crc:read:rooms_account_settings:master |
| Update Cisco/Polycom Room Account Setting | crc:update:rooms_account_settings:admin |
| Update Cisco/Polycom Room Account Setting | crc:update:rooms_account_settings:master |
Api Connector
| API endpoint | granular scope |
|---|---|
| Get an API Connector's private key | crc:read:apiconnector_private_key:admin |
| Get an API Connector's private key | crc:read:apiconnector_private_key:master |
| Get an API Connector | crc:read:apiconnector:admin |
| Get an API Connector | crc:read:apiconnector:master |
| List API Connectors | crc:read:list_apiconnectors:admin |
| List API Connectors | crc:read:list_apiconnectors:master |
| Delete an API Connector | crc:delete:apiconnector:admin |
| Delete an API Connector | crc:delete:apiconnector:master |
| Create an API Connector | crc:write:apiconnector:admin |
| Create an API Connector | crc:write:apiconnector:master |
| Update an API Connector's private key | crc:update:apiconnector_private_key:admin |
| Update an API Connector's private key | crc:update:apiconnector_private_key:master |
| Update an API Connector | crc:update:apiconnector:admin |
| Update an API Connector | crc:update:apiconnector:master |
Cisco/Polycom Rooms
| API endpoint | granular scope |
|---|---|
| Get a Managed Room | crc:read:room:admin |
| Get a Managed Room | crc:read:room:master |
| Delete a managed room | crc:delete:room:admin |
| Delete a managed room | crc:delete:room:master |
| List Managed Rooms | crc:read:list_rooms:admin |
| List Managed Rooms | crc:read:list_rooms:master |
| Update a Managed Room | crc:update:room:admin |
| Update a Managed Room | crc:update:room:master |
| Create a Managed Room | crc:write:room:admin |
| Create a Managed Room | crc:write:room:master |
Participant
| API endpoint | granular scope |
|---|---|
| Get participant identifier code | crc:read:participant_identifier_code:admin crc:read:participant_identifier_code:master |
Room Template
| API endpoint | granular scope |
|---|---|
| Delete a room template | crc:delete:rooms_template:admin |
| Delete a room template | crc:delete:rooms_template:master |
| List Room Templates | crc:read:list_rooms_templates:admin |
| List Room Templates | crc:read:list_rooms_templates:master |
| Get a Room Template | crc:read:rooms_template:admin |
| Get a Room Template | crc:read:rooms_template:master |
| Create a Room Template | crc:write:rooms_template:admin |
| Create a Room Template | crc:write:rooms_template:master |
| Update a Room Template | crc:update:rooms_template:admin |
| Update a Room Template | crc:update:rooms_template:master |
Contact Center
The following are the available Contact Center APIs and their associated granular scopes.
Accounts
| API endpoint | granular scope |
|---|---|
| List storage locations | contact_center:read:account_storage_location:admin |
Address Books
| API endpoint | granular scope |
|---|---|
| List address book contacts | contact_center:read:list_address_book_contacts:admin |
| Batch create address book contacts | contact_center:write:address_book_contact:admin |
| Update an address book contact | contact_center:update:address_book_contact:admin |
| List an address book's custom fields | contact_center:read:address_book_custom_field:admin |
| Update an address book unit | contact_center:update:address_book_unit:admin |
| Batch update address book contacts | contact_center:update:address_book_contact:admin |
| Delete an address book custom field | contact_center:delete:address_book_custom_field:admin |
| List address books | contact_center:read:list_address_books:admin |
| Update an address book | contact_center:update:address_book:admin |
| Update an address book custom field | contact_center:update:address_book_custom_field:admin |
| Delete an address book unit | contact_center:delete:address_book_unit:admin |
| Create an address book custom field | contact_center:write:address_book_custom_field:admin |
| Get an address book | contact_center:read:address_book:admin |
| Batch delete address book contacts | contact_center:delete:address_book_contact:admin |
| Get an address book's custom field | contact_center:read:address_book_custom_field:admin |
| Get an address book unit | contact_center:read:address_book_unit:admin |
| List address book units | contact_center:read:list_address_book_units:admin |
| Create an address book unit | contact_center:write:address_book_unit:admin |
| Get an address book contact | contact_center:read:address_book_contact:admin |
| Delete an address book | contact_center:delete:address_book:admin |
| List an address book contact's custom fields | contact_center:read:address_book_custom_field:admin |
| Delete an address book contact | contact_center:delete:address_book_contact:admin |
| Create an address book contact | contact_center:write:address_book_contact:admin |
| Create an address book | contact_center:write:address_book:admin |
Agent Statuses
| API endpoint | granular scope |
|---|---|
| Get a system status | contact_center:read:system_status:admin |
| Delete a system status | contact_center:delete:system_status:admin |
| List system statuses | contact_center:read:list_system_statues:admin |
| Update a system status | contact_center:update:system_status:admin |
| Create a system status | contact_center:write:system_status:admin |
Asset Library
| API endpoint | granular scope |
|---|---|
| List assets | contact_center:read:asset_library:admin |
| Delete an asset category | contact_center:delete:asset_library:admin |
| Create an asset category | contact_center:write:asset_library:admin |
| Update an asset | contact_center:write:asset_library:admin |
| Duplicate an asset | contact_center:write:asset_library:admin |
| Create an asset | contact_center:write:asset_library:admin |
| Get an asset category | contact_center:read:asset_library:admin |
| Delete asset items | contact_center:write:asset_library:admin |
| Batch update asset items | contact_center:update:asset_library:admin |
| List asset categories | contact_center:read:asset_library:admin |
| Update an asset category | contact_center:write:asset_library:admin |
| Get an asset | contact_center:read:asset_library:admin |
| Delete an asset | contact_center:delete:asset_library:admin |
Block List Rules
| API endpoint | granular scope |
|---|---|
| Get a block list rule of IP addresses | contact_center:read:block_list_rules:admin |
| Get a block list rule of phone numbers | contact_center:read:block_list_rules:admin |
| Delete phone numbers' block list rules | contact_center:delete:block_list_rules:admin |
| List block list rules of phone numbers | contact_center:read:block_list_rules:admin |
| Delete IP addresses' block list rules | contact_center:delete:block_list_rules:admin |
| List block list rules for IP addresses | contact_center:read:block_list_rules:admin |
| Create block list rules for IP addresses | contact_center:write:block_list_rules:admin |
| Create block list rules for phone numbers | contact_center:write:block_list_rules:admin |
Call Control
| API endpoint | granular scope |
|---|---|
| Control an engagement's recording | contact_center:update:engagement_recording_control:admin |
| List user's devices | contact_center:read:user_device:admin |
| Command control of a user | contact_center:write:user_control:admin |
Campaigns
| API endpoint | granular scope |
|---|---|
| Delete an outbound campaign | contact_center:delete:outbound_campaign:admin |
| Get a campaign contact list's contact | contact_center:read:outbound_campaign_contacts:admin |
| Remove a campaign contact list | contact_center:delete:outbound_campaign_contactlist:admin |
| List a campaign contact's custom fields | contact_center:read:outbound_campaign_contactlist:admin |
| Update a campaign contact list's custom field | contact_center:update:outbound_campaign_contactlist:admin |
| Insert a batch of contacts into a campaign contact list | contact_center:write:outbound_campaign_contacts:admin |
| Batch create a campaign DNC list's phones | contact_center:write:outbound_campaign_dnc_list_phones:admin |
| Remove campaign contact list's contact | contact_center:delete:outbound_campaign_contacts:admin |
| List campaign contact lists' custom fields | contact_center:read:outbound_campaign_contactlist:admin |
| Get a campaign contact list's custom field | contact_center:read:outbound_campaign_contactlist:admin |
| Get a campaign contact list | contact_center:read:outbound_campaign_contactlist:admin |
| Update an outbound campaign status | contact_center:update:outbound_campaign:admin |
| Update contact on a campaign contact list | contact_center:update:outbound_campaign_contacts:admin |
| Update a campaign contact list | contact_center:update:outbound_campaign_contactlist:admin |
| Batch delete a campaign DNC list's phones | contact_center:delete:outbound_campaign_dnc_list_phones:admin |
| Create an outbound campaign | contact_center:write:outbound_campaign:admin |
| Delete a campaign contact list's custom field | contact_center:delete:outbound_campaign_contactlist:admin |
| Get an outbound campaign | contact_center:read:outbound_campaign:admin |
| List outbound campaigns | contact_center:read:outbound_campaign:admin |
| Batch update campaign contact lists | contact_center:update:outbound_campaign_contactlist:admin |
| Create a campaign contact list's custom field | contact_center:write:outbound_campaign_contactlist:admin |
| Create a campaign contact list's contact | contact_center:write:outbound_campaign_contacts:admin |
| Update an outbound campaign | contact_center:update:outbound_campaign:admin |
| Update outbound campaign contact lists | contact_center:update:outbound_campaign:admin |
| List a campaign contact list's contacts | contact_center:read:outbound_campaign_contacts:admin |
| Create a campaign contact list | contact_center:write:outbound_campaign_contactlist:admin |
| List campaign DNC phone numbers | contact_center:read:outbound_campaign_dnc_list_phones:admin |
| List campaign contact lists | contact_center:read:outbound_campaign_contactlist:admin |
| Update a batch of contacts on a campaign contact list | contact_center:update:outbound_campaign_contacts:admin |
Dispositions
| API endpoint | granular scope |
|---|---|
| Create a disposition set | contact_center:write:disposition_set:admin |
| Delete a disposition | contact_center:delete:disposition:admin |
| Get a disposition | contact_center:read:disposition:admin |
| Delete a disposition set | contact_center:delete:disposition_set:admin |
| Update a disposition set | contact_center:update:disposition_set:admin |
| Create a disposition | contact_center:write:disposition:admin |
| List dispositions | contact_center:read:list_dispositions:admin |
| Update a disposition | contact_center:update:disposition:admin |
| Get a disposition set | contact_center:read:disposition_set:admin |
| List disposition sets | contact_center:read:list_disposition_sets:admin |
Engagements
| API endpoint | granular scope |
|---|---|
| Poll an engagement recording's status | contact_center:read:engagement_recording_status:admin |
| Get an engagement's available transfer flows | contact_center:read:flow:admin |
| Get a historical engagement | contact_center:read:engagement:admin |
| Update an engagement | contact_center:update:engagement:admin |
| Get an engagement's attachments | contact_center:read:attachment:admin |
| [List open engagements](/docs/api/rest/reference/contact-center/methods/#operation/list open engagements) | contact_center:read:list_engagements:admin |
| Get an engagement's survey | contact_center:read:engagement:admin |
| Get an engagement's available transfer queues | contact_center:read:list_queues:admin |
| Get an engagement's available transfer users | contact_center:read:list_users:admin |
| List historical engagements | contact_center:read:list_engagements:admin |
| Start an engagement | contact_center:write:engagement:admin |
| Get an engagement's events | contact_center:read:engagement:admin |
Files
| API endpoint | granular scope |
|---|---|
| Upload a file | contact_center:write:files:admin |
Flows
| API endpoint | granular scope |
|---|---|
| Export a flow | contact_center:read:flow:admin |
| Add flow entry points | contact_center:write:flow:admin |
| Delete a flow | contact_center:delete:flow:admin |
| Get a flow | contact_center:read:flow:admin |
| Import a flow | contact_center:write:flow:admin |
| List entry points | contact_center:read:flow:admin |
| List flows | contact_center:read:list_flows:admin |
| Edit a flow | contact_center:update:flow:admin |
| Publish a flow | contact_center:update:flow:admin |
| List the flow's entry points | contact_center:read:flow:admin |
| Remove flow entry points | contact_center:delete:flow:admin |
Follow-up Tasks
| API endpoint | granular scope |
|---|---|
| List engagement follow-up tasks | contact_center:read:list_follow_up_tasks:admin |
| Update a follow-up task | contact_center:update:follow_up_task |
| Get a follow-up task | contact_center:read:follow_up_task:admin |
Inboxes
| API endpoint | granular scope |
|---|---|
| Update an inbox's email notification setting | contact_center:update:inbox:admin |
| Delete an inbox message | contact_center:delete:inbox_message:admin |
| Get an inbox email notification list | contact_center:read:inbox:admin |
| Assign queues to an inbox | contact_center:write:inbox_queue:admin |
| Create an inbox | contact_center:write:inbox:admin |
| List inbox users | contact_center:read:inbox_user:admin |
| Delete inbox messages | contact_center:delete:inbox_messages:admin |
| Unassign queues from an inbox | contact_center:delete:inbox_queue:admin |
| Assign inbox access users | contact_center:write:inbox_user:admin |
| Get an inbox | contact_center:read:inbox:admin |
| List an account's inbox messages | contact_center:read:inbox_messages:admin |
| List an inbox's messages | contact_center:read:inbox_messages:admin |
| Unassign inbox access users | contact_center:delete:inbox_user:admin |
| Update an inbox | contact_center:update:inbox:admin |
| Delete an inbox's messages | contact_center:delete:inbox_messages:admin |
| List inboxes | contact_center:read:list_inboxes:admin |
| Delete inboxes | contact_center:delete:inbox:admin |
| List queues assigned to an inbox | contact_center:read:list_inbox_queues:admin |
Logs
| API endpoint | granular scope |
|---|---|
| List voice call logs | contact_center:read:voice_call_log:admin |
| List voice call logs | contact_center:read:voice_call_log:master |
| List email message history | contact_center:read:engagement_log:admin |
| List SMS logs | contact_center:read:sms_log:admin |
| List SMS logs | contact_center:read:sms_log:master |
| List operation logs | contact_center:read:operation_logs:admin |
| List work item message history | contact_center:read:engagement_log:admin |
| List message history | contact_center:read:messaging:admin |
Messaging
| API endpoint | granular scope |
|---|---|
| Send a message | contact_center:write:messaging:admin |
Notes
| API endpoint | granular scope |
|---|---|
| List engagement notes | contact_center:read:list_notes:admin |
| List notes | contact_center:read:list_notes:admin |
| Get a note | contact_center:read:note:admin |
| Update a note | contact_center:update:note |
Operating Hours
| API endpoint | granular scope |
|---|---|
| Delete business hours | contact_center:delete:business_hour:admin |
| Get a closure set | contact_center:read:closure_hour:admin |
| List the business hours' flows | contact_center:read:business_hours_flow:admin |
| List the business hours' queues | contact_center:read:business_hours_queue:admin |
| Delete a closure set | contact_center:delete:closure_hour:admin |
| Get business hours | contact_center:read:business_hour:admin |
| Update business hours | contact_center:update:business_hour:admin |
| List the closures' flows | contact_center:read:clousre_hour_flow:admin |
| List business hours | contact_center:read:list_business_hours:admin |
| Create a closure set | contact_center:write:closure_hour:admin |
| Create business hours | contact_center:write:business_hour:admin |
| List closures | contact_center:read:list_closure_hours:admin |
| Update a closure set | contact_center:update:closure_hour:admin |
| List the closures' queues | contact_center:read:closure_hour_queue:admin |
Queue Waiting Experiences
| API endpoint | granular scope |
|---|---|
| Delete a queue waiting experience interrupt menu strategy | contact_center:delete:queue:admin |
| Assign a queue waiting experience interrupt menu strategy | contact_center:update:queue:admin |
Queues
| API endpoint | granular scope |
|---|---|
| Assign queue disposition sets | contact_center:write:queue_disposition_set:admin |
| List queue scheduled callback variables | contact_center:read:queue:admin |
| Get a queue's interrupt settings | contact_center:read:queue:admin |
| Delete queue recordings | contact_center:delete:recording:admin |
| Batch create queues with a template | contact_center:write:queue:admin |
| Update a queue agent's opt-in/opt-out status | contact_center:update:queue_agent:admin |
| Update a queue template | contact_center:update:queue:admin |
| Unassign a queue disposition set | contact_center:delete:queue_disposition_set:admin |
| Assign queue agents | contact_center:write:queue_agent:admin |
| Delete a queue's interrupt menu configuration | contact_center:update:queue:admin |
| Update a queue | contact_center:update:queue:admin |
| List queue disposition sets | contact_center:read:list_disposition_sets:admin |
| Get a queue's operating hours | contact_center:read:queue_operating_hours:admin |
| Delete an attendee from a scheduled callback event | contact_center:write:queue:admin |
| Unassign a queue agent | contact_center:delete:queue_agent:admin |
| List queue dispositions | contact_center:read:list_dispositions:admin |
| List queue recordings | contact_center:read:list_recordings:admin contact_center:read:list_recordings |
| Assign queue dispositions | contact_center:write:queue disposition:admin |
| Update a queue's operating hours | contact_center:patch:queue_operating_hours:admin |
| List a queue's scheduled callbacks availability | contact_center:read:queue:admin |
| Schedule a callback on a queue | contact_center:write:queue:admin |
| Unassign queue teams | contact_center:delete:queue_team:admin |
| Unassign a queue supervisor | contact_center:delete:queue_supervisor:admin |
| List queues | contact_center:read:list_queues:admin |
| List queue supervisors | contact_center:delete:queue_supervisor:admin |
| Create a queue template | contact_center:write:queue:admin |
| List queue templates | contact_center:read:queue:admin |
| Assign queue teams | contact_center:write:queue_team:admin |
| Create a queue | contact_center:write:queue:admin |
| Unassign a queue disposition | contact_center:delete:queue_disposition:admin |
| Delete a queue template | contact_center:delete:queue:admin |
| Delete a queue | contact_center:delete:queue:admin |
| List queue agents | contact_center:read:list_queue_agents:admin |
| Unassign a queue team | contact_center:delete:queue_team:admin |
| Get a queue | contact_center:read:queue:admin |
| Update a queue's interrupt settings | contact_center:update:queue:admin |
| Assign a queue menu based interrupt | contact_center:update:queue:admin |
| Batch delete queue templates | contact_center:delete:queue:admin |
| Get a queue template | contact_center:read:queue:admin |
| Assign queue supervisors | contact_center:delete:queue_supervisor:admin |
| Batch delete queues | contact_center:delete:queue:admin |
RTMS
| API endpoint | granular scope |
|---|---|
| Update engagement Real-Time Media Streams (RTMS) app status | contact_center:update:engagement_rtms_app_status contact_center:update:engagement_rtms_app_status:admin |
Recordings
| API endpoint | granular scope |
|---|---|
| List engagement recordings | contact_center:read:list_recordings:admin |
| Delete a recording | contact_center:delete:recording:admin |
| Delete engagement recordings | contact_center:delete:recording:admin |
| List recordings | contact_center:read:list_recordings:admin |
Regions
| API endpoint | granular scope |
|---|---|
| Create a region | contact_center:write:region:admin |
| List regions | contact_center:read:list_regions:admin |
| Delete a region | contact_center:delete:region:admin |
| Get a region | contact_center:read:region:admin |
| Assign users to a region | contact_center:write:region_user:admin |
| List a region's users | contact_center:read:list_region_users:admin |
| Update a region | contact_center:udpate:region:admin |
Reports V1 (Legacy)
| API endpoint | granular scope |
|---|---|
| List historical agent reports by queue | contact_center:read:agent_report:admin |
| List historical queue's agents reports | contact_center:read:agent_report:admin |
| List historical queue reports | contact_center:read:queue_report:admin |
| List historical detail reports | contact_center:read:engagement_report:admin |
| List agent's status history reports | contact_center:read:agent_status_report:admin |
| List agent's time sheet reports | contact_center:read:agent_report:admin |
| List agent leg reports | contact_center:read:agent_report:admin |
Reports V2 (CX Analytics)
| API endpoint | granular scope |
|---|---|
| List historical queue performance dataset data | contact_center:read:dataset_queue_performance:admin |
| Get historical custom report tabular schema | contact_center:read:custom_report:admin |
| List historical Zoom Phone to Contact Center call journey data | contact_center:read:call_journey_log:admin |
| List historical custom report tabular data | contact_center:read:custom_report:admin |
| List historical agent performance dataset data | contact_center:read:dataset_agent_performance:admin |
| List historical engagement log data | contact_center:read:engagement_log:admin |
| List historical engagement timelines | contact_center:read:engagement_timeline:admin |
| List historical agent timecard dataset data | contact_center:read:dataset_agent_timecard:admin |
| List historical expert assist dataset data | contact_center:read:dataset_expert_assist:admin |
| List historical engagement dataset data | contact_center:read:dataset_engagement:admin |
| List historical flow performance dataset data | contact_center:read:dataset_flow_performance:admin |
| List historical agent work session logs | contact_center:read:list_agent_work_session_logs:admin |
| List historical agent compliance logs | contact_center:read:list_agent_compliance_logs:admin |
| List historical routing log performance dataset data | contact_center:read:dataset_routing_log:admin |
| List historical disposition dataset data | contact_center:read:dataset_disposition:admin |
| List historical agent opt in or out logs | contact_center:read:list_agent_opt_logs:admin |
| List historical outbound dialer performance dataset data | contact_center:read:dataset_outbound_dialer_performance:admin |
| List historical agent load dataset data | contact_center:read:dataset_agent_load:admin |
Roles
| API endpoint | granular scope |
|---|---|
| Delete a role | contact_center:delete:role:admin |
| Update a role | contact_center:update:role:admin |
| Delete role privileges | contact_center:delete:role:admin |
| Get a role | contact_center:read:role:admin |
| List users of a role | contact_center:read:list_role_users:admin |
| Duplicate a role | contact_center:write:role:admin |
| Unassign a user from a role | contact_center:delete:role_user:admin |
| Assign a role | contact_center:write:role_user:admin |
| Create a role | contact_center:write:role:admin |
| List roles | contact_center:read:list_roles:admin |
Routing Profiles
| API endpoint | granular scope |
|---|---|
| Update an agent routing profile's details | contact_center:update:agent_routing_profile:admin |
| Get an agent routing profile | contact_center:read:agent_routing_profile:admin |
| Get a consumer routing profile | contact_center:read:consumer_routing_profile:admin |
| Delete an agent routing profile | contact_center:delete:agent_routing_profile:admin |
| List agent routing profiles | contact_center:read:agent_routing_profile:admin |
| List consumer routing profiles | contact_center:read:consumer_routing_profile:admin |
| Create an agent routing profile | contact_center:write:agent_routing_profile:admin |
| Create a consumer routing profile | contact_center:write:consumer_routing_profile:admin |
| Delete a consumer routing profile | contact_center:delete:consumer_routing_profile:admin |
| Update a consumer routing profile's details | contact_center:update:consumer_routing_profile:admin |
SMS
| API endpoint | granular scope |
|---|---|
| Send an SMS | contact_center:write:sms:admin |
Skills
| API endpoint | granular scope |
|---|---|
| Delete a skill category | contact_center:delete:skill_category:admin |
| Update a skill category | contact_center:update:skill_category:admin |
| List skills | contact_center:read:list_skills:admin |
| Create a skill | contact_center:write:skill:admin |
| Create a skill category | contact_center:write:skill_category:admin |
| List skill categories | contact_center:read:list_skill_categories:admin |
| List skill users | contact_center:read:list_skill_users:admin |
| Get a skill category | contact_center:read:skill_category:admin |
| Update a skill | contact_center:update:skill:admin |
| Get a skill | contact_center:read:skill:admin |
| Delete a skill | contact_center:delete:skill:admin |
Teams
| API endpoint | granular scope |
|---|---|
| Assign team supervisors | contact_center:write:team:admin |
| List team supervisors | contact_center:read:team:admin |
| Move a team | contact_center:update:team:admin |
| List a team's child teams | contact_center:read:team:admin |
| Unassign team supervisors | contact_center:delete:team:admin |
| Delete a team | contact_center:delete:team:admin |
| Assign team agents | contact_center:write:team:admin |
| Create a team | contact_center:write:team:admin |
| List team's parent teams | contact_center:read:team:admin |
| Get a team | contact_center:read:team:admin |
| Update a team | contact_center:update:team:admin |
| List team agents | contact_center:read:team:admin |
| List teams | contact_center:read:team:admin |
| Unassign team agents | contact_center:delete:team:admin |
Users
| API endpoint | granular scope |
|---|---|
| Update a user's profile | contact_center:update:user:admin |
| Create a user's profile | contact_center:write:user:admin |
| Opt-in or opt-out a user's queues | contact_center:update:queue_agent:admin |
| Update a user template | contact_center:update:user_templates:admin |
| List a user's skills | contact_center:read:list_user_skills:admin |
| Batch create user profiles | contact_center:write:batch_users:admin |
| List user profiles | contact_center:read:list_users:admin |
| List user templates | contact_center:read:user_templates:admin |
| Delete a user template | contact_center:delete:user_templates:admin |
| Delete a user's recordings | contact_center:delete:recording:admin |
| Get a user template | contact_center:read:user_templates:admin |
| Batch delete user profiles | contact_center:delete:batch_users:admin |
| Update a user's status | contact_center:update:user:admin |
| List a user's queues | contact_center:read:list_user_queues:admin |
| Assign a user's skills | contact_center:write:user_skill:admin |
| List a user's recordings | contact_center:read:list_recordings:admin contact_center:read:list_recordings |
| Unassign a user's skill | contact_center:delete:user_skill:admin |
| Delete a user's profile | contact_center:delete:user:admin |
| Get a user's profile | contact_center:read:user:admin |
| Create a user template | contact_center:write:user_templates:admin |
| Batch update user profiles | contact_center:update:batch_users:admin |
| Batch update user status | contact_center:update:batch_users:admin |
Variables
| API endpoint | granular scope |
|---|---|
| Update a variable | contact_center:update:variable:admin |
| Get a variable | contact_center:read:variable:admin |
| Create a variable | contact_center:write:variable:admin |
| List variable groups | contact_center:read:list_variable_groups:admin |
| Get a variable log | contact_center:read:variable_log:admin |
| Delete a variable group | contact_center:delete:variable_group:admin |
| Delete a variable | contact_center:delete:variable:admin |
| Get a variable group | contact_center:read:variable_group:admin |
| Update a variable group | contact_center:update:variable_group:admin |
| List variables | contact_center:read:list_variables:admin |
| List variable logs | contact_center:read:list_variable_logs:admin |
| Delete a variable log | contact_center:delete:variable_log:admin |
| Create a variable group | contact_center:write:variable_group:admin |
Zoom Calendar
The following are the available Zoom Calendar APIs and their associated granular scopes.
acl
| API endpoint | granular scope |
|---|---|
| Create a new ACL rule | calendar:write:acl calendar:write:acl:admin |
| Delete an existing ACL rule | calendar:delete:acl calendar:delete:acl:admin |
| Update the specified ACL rule | calendar:update:acl calendar:update:acl:admin |
| List ACL rules of specified calendar | calendar:read:list_acl calendar:read:list_acl:admin |
| Get the specified ACL rule | calendar:read:acl calendar:read:acl:admin |
calendar list
| API endpoint | granular scope |
|---|---|
| Insert an existing calendar to the user's own calendarList | calendar:write:calendar_list |
| Delete an existing calendar from the user's own calendarList | calendar:delete:calendar_list |
| List the calendars in the user's own calendarList | calendar:read:list_calendar_lists |
| Update an existing calendar in the user's own calendarList | calendar:update:calendar_list |
| Get a specified calendar from the user's own calendarList | calendar:read:calendar_list |
calendars
| API endpoint | granular scope |
|---|---|
| Get the specified calendar | calendar:read:calendar calendar:read:calendar:admin |
| Delete a calendar owned by a user | calendar:delete:calendar calendar:delete:calendar:admin |
| Create a new secondary calendar | calendar:write:calendar calendar:write:calendar:admin |
| Update the specified calendar | calendar:update:calendar calendar:update:calendar:admin |
colors
| API endpoint | granular scope |
|---|---|
| Get the color definitions for calendars and events | calendar:read:color calendar:read:color:admin |
events
| API endpoint | granular scope |
|---|---|
| Quick add an event to the specified calendar | calendar:write:quick_add_event calendar:write:quick_add_event:admin |
| Move the specified event from a calendar to another specified calendar | calendar:write:move_event calendar:write:move_event:admin |
| Get the specified event on the specified calendar | calendar:read:event calendar:read:event:admin |
| Update the specified event on the specified calendar | calendar:update:event calendar:update:event:admin |
| Import event to the specified calendar | calendar:write:import_event calendar:write:import_event:admin |
| List events on the specified calendar | calendar:read:list_events calendar:read:list_events:admin |
| Insert a new event to the specified calendar | calendar:write:event calendar:write:event:admin |
| List all instances of the specified recurring event | calendar:read:instance_event calendar:read:instance_event:admin |
| Delete an existing event from the specified calendar | calendar:delete:event calendar:delete:event:admin |
freebusy
| API endpoint | granular scope |
|---|---|
| Query freebusy information for a set of calendars | calendar:read:list_events calendar:read:list_events:admin |
settings
| API endpoint | granular scope |
|---|---|
| Get the specified user calendar settings of the authenticated user | calendar:read:setting |
| List all user calendar settings of the authenticated user | calendar:read:list_settings |
| Patch the specified user calendar settings of the authenticated user | calendar:update:setting calendar:update:setting:admin |
Hub
The following are the available Hub APIs and their associated granular scopes.
Export
| API endpoint | granular scope |
|---|---|
| Get file content | hub:read:content |
File Management
| API endpoint | granular scope |
|---|---|
| Duplicate a file | hub:write:content |
| Get file duplicate task status | hub:read:file_duplicate_task |
| Move a file | hub:write:move hub:write:move:admin |
Import
| API endpoint | granular scope |
|---|---|
| Create a new file from content | hub:write:content |
Shared folder
| API endpoint | granular scope |
|---|---|
| Delete a shared folder | hub:delete:shared_folder hub:delete:shared_folder:admin |
| List shared folders | hub:read:shared_folder hub:read:shared_folder:admin |
| Get metadata of a shared folder | hub:read:shared_folder hub:read:shared_folder:admin |
| Modify metadata of a shared folder | hub:update:shared_folder |
| Create a shared folder | hub:write:shared_folder |
Zoom Virtual Agent
The following are the available Zoom Virtual Agent APIs and their associated granular scopes.
Knowledge Management
| API endpoint | granular scope |
|---|---|
| Get articles | zva:read:list_km_articles zva:read:list_km_articles:admin |
| Get sync | zva:read:km_kb:admin |
| Get article | zva:read:km_article zva:read:km_article:admin |
| Delete article | zva:delete:km_article zva:delete:km_article:admin |
| Create sync request | zva:update:km_kb:admin |
| Update article | zva:update:km_article zva:update:km_article:admin |
| Create article | zva:write:km_article zva:write:km_article:admin |
Logs
| API endpoint | granular scope |
|---|---|
| List AI Management operation logs | zva:read:list_operation_logs:admin |
Report
| API endpoint | granular scope |
|---|---|
| Get Zoom Virtual Agent engagements | zva:read:list_engagements:admin |
| Get ZVA variable details | zva:read:list_variables:admin |
| Get ZVA query details | zva:read:list_queries:admin |
| Get ZVA Surveys | zva:read:list_surveys:admin |
| Get ZVA transcripts | zva:read:list_transcripts:admin |
Number Management
The following are the available Number Management APIs and their associated granular scopes.
Cloud Peering Provider Exchange
| API endpoint | granular scope |
|---|---|
| [Remove peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/deletePeeringPhoneNumbers) | number_management:delete:peering_number:admin |
| [Remove peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/deletePeeringPhoneNumbers) | number_management:delete:peering_number:master |
| [List peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/listPeeringPhoneNumbers) | number_management:read:list_peering_numbers:admin |
| [List peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/listPeeringPhoneNumbers) | number_management:read:list_peering_numbers:master |
| [Update peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/updatePeeringPhoneNumbers) | number_management:update:peering_number:admin |
| [Update peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/updatePeeringPhoneNumbers) | number_management:update:peering_number:master |
| [List peering phone numbers for provider](/docs/api/rest/reference/Number Management/methods/#operation/Listpeeringphonenumbersforprovider) | number_management:read:list_carrier_peering_numbers:admin |
| [List peering phone numbers for provider](/docs/api/rest/reference/Number Management/ma/#operation/Listpeeringphonenumbersforprovider) | number_management:read:list_carrier_peering_numbers:master |
| [Add peering phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/addPeeringPhoneNumbers) | number_management:write:peering_number:admin |
| [Add peering phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/addPeeringPhoneNumbers) | number_management:write:peering_number:master |
Phone Numbers
| API endpoint | granular scope |
|---|---|
| [Add BYOC phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/AddBYOCPhoneNumber) | number_management:write:byoc_numbers:admin |
| [Add BYOC phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/AddBYOCPhoneNumber) | number_management:write:byoc_numbers:master |
| [Delete phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/DeleteNumbers) | number_management:delete:numbers:admin |
| [Delete phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/DeleteNumbers) | number_management:delete:numbers:master |
| [Move Operator Connect Number Microsoft tenant](/docs/api/rest/reference/Number Management/methods/#operation/MoveOperatorConnectNumbertenant) | number_management:update:move_number_ms_tenant:admin |
| [Move Operator Connect Number Microsoft tenant](/docs/api/rest/reference/Number Management/ma/#operation/MoveOperatorConnectNumbertenant) | number_management:update:move_number_ms_tenant:master |
| [Get a phone number](/docs/api/rest/reference/Number Management/methods/#operation/getPhoneNumber) | number_management:read:numbers:admin |
| [Get a phone number](/docs/api/rest/reference/Number Management/ma/#operation/getPhoneNumber) | number_management:read:numbers:master |
| [Update a phone number](/docs/api/rest/reference/Number Management/methods/#operation/updatePhoneNumberDetail) | number_management:update:numbers:admin |
| [Update a phone number](/docs/api/rest/reference/Number Management/ma/#operation/updatePhoneNumberDetail) | number_management:update:numbers:master |
| [List phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/listPhoneNumbers) | number_management:read:list_numbers:admin |
| [List phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/listPhoneNumbers) | number_management:read:list_numbers:master |
| [Allocate/Unallocate phone numbers](/docs/api/rest/reference/Number Management/methods/#operation/AllocateNumber) | number_management:write:numbers:admin |
| [Allocate/Unallocate phone numbers](/docs/api/rest/reference/Number Management/ma/#operation/AllocateNumber) | number_management:write:numbers:master |
Phone Plan
| API endpoint | granular scope |
|---|---|
| [List phone number plan information](/docs/api/rest/reference/Number Management/methods/#operation/Listphonenumberplaninformation) | number_management:read:numbers_plan:admin |
| [List phone number plan information](/docs/api/rest/reference/Number Management/ma/#operation/Listphonenumberplaninformation) | number_management:read:numbers_plan:master |
SMS Campaigns
| API endpoint | granular scope |
|---|---|
| [List SMS campaigns](/docs/api/rest/reference/Number Management/methods/#operation/listAccountSMSCampaigns) | number_management:read:list_sms_campaigns:admin |
| [List SMS campaigns](/docs/api/rest/reference/Number Management/ma/#operation/listAccountSMSCampaigns) | number_management:read:list_sms_campaigns:master |
| [Get an SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/GetSMSCampaign) | number_management:read:sms_campaign:admin |
| [Get an SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/GetSMSCampaign) | number_management:read:sms_campaign:master |
| [Assign a phone number to SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/assignCampaignPhoneNumbers) | number_management:update:numbers:admin |
| [Assign a phone number to SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/assignCampaignPhoneNumbers) | number_management:update:numbers:master |
| [Unassign phone number from SMS campaign](/docs/api/rest/reference/Number Management/methods/#operation/unassignCampaignPhoneNumber) | number_management:update:numbers:admin |
| [Unassign phone number from SMS campaign](/docs/api/rest/reference/Number Management/ma/#operation/unassignCampaignPhoneNumber) | number_management:update:numbers:master |
SMS Consent
| API endpoint | granular scope |
|---|---|
| [Update an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/UpdateSMSConsent) | number_management:update:sms_consent:admin |
| [Update an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/UpdateSMSConsent) | number_management:update:sms_consent:master |
| [Create an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/CreateSMSConsent) | number_management:write:sms_consent:admin |
| [Create an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/CreateSMSConsent) | number_management:write:sms_consent:master |
| [Delete SMS consent policies](/docs/api/rest/reference/Number Management/methods/#operation/DeleteSMSConsents) | number_management:delete:sms_consent:admin |
| [Delete SMS consent policies](/docs/api/rest/reference/Number Management/ma/#operation/DeleteSMSConsents) | number_management:delete:sms_consent:master |
| [Unassign phone numbers from SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/UnassignPhoneNumbersFromConsent) | number_management:delete:numbers:admin |
| [Unassign phone numbers from SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/UnassignPhoneNumbersFromConsent) | number_management:delete:numbers:master |
| [Assign phone numbers to SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/AssignPhoneNumbersToConsent) | number_management:write:numbers:admin |
| [Assign phone numbers to SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/AssignPhoneNumbersToConsent) | number_management:write:numbers:master |
| [Get an SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/GetSMSConsent) | number_management:read:sms_consent:admin |
| [Get an SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/GetSMSConsent) | number_management:read:sms_consent:master |
| [List SMS consent policies](/docs/api/rest/reference/Number Management/methods/#operation/ListSMSConsents) | number_management:read:sms_consent:admin |
| [List SMS consent policies](/docs/api/rest/reference/Number Management/ma/#operation/ListSMSConsents) | number_management:read:sms_consent:master |
| [List phone numbers assigned to SMS consent policy](/docs/api/rest/reference/Number Management/methods/#operation/ListConsentPhoneNumbers) | number_management:read:sms_consent:admin |
| [List phone numbers assigned to SMS consent policy](/docs/api/rest/reference/Number Management/ma/#operation/ListConsentPhoneNumbers) | number_management:read:sms_consent:master |
Setting
| API endpoint | granular scope |
|---|---|
| [List ported numbers](/docs/api/rest/reference/Number Management/methods/#operation/Listportednumbers) | number_management:read:list_ported_numbers:admin |
| [List ported numbers](/docs/api/rest/reference/Number Management/ma/#operation/Listportednumbers) | number_management:read:list_ported_numbers:master |
| [List BYOC SIP trunks](/docs/api/rest/reference/Number Management/methods/#operation/ListBYOCSIPtrunks) | number_management:read:list_sip_trunks:admin |
| [List BYOC SIP trunks](/docs/api/rest/reference/Number Management/ma/#operation/ListBYOCSIPtrunks) | number_management:read:list_sip_trunks:master |
| [Get ported numbers details](/docs/api/rest/reference/Number Management/methods/#operation/Getportednumbersdetails) | number_management:read:ported_number:admin |
| [Get ported numbers details](/docs/api/rest/reference/Number Management/ma/#operation/Getportednumbersdetails) | number_management:read:ported_number:master |
| [List SIP groups](/docs/api/rest/reference/Number Management/methods/#operation/ListSIPgroups) | number_management:read:list_sip_groups:admin |
| [List SIP groups](/docs/api/rest/reference/Number Management/ma/#operation/ListSIPgroups) | number_management:read:list_sip_groups:master |
Zoom Commerce
The following are the available Zoom Commerce APIs and their associated granular scopes.
Account Management
| API endpoint | granular scope |
|---|---|
| Get the account details for a Zoom Partner/Subreseller/End Customer | zoom_commerce:read:account:admin |
| Create an end customer account | zoom_commerce:write:sub_account:admin |
| Get the list of all accounts associated with a Zoom Partner/Sub-Reseller, by the account type | zoom_commerce:read:account:admin |
| Add contacts to an existing end customer or your own account. | zoom_commerce:update:account:admin |
Billing
| API endpoint | granular scope |
|---|---|
| Gets the PDF document for the billing document ID | zoom_commerce:read:billing_documents:admin |
| Gets all billing documents for a distributor or a reseller | zoom_commerce:read:billing_documents:admin |
| Get detailed information about a specific invoice for a distributor or a reseller | zoom_commerce:read:billing_documents:admin |
Deal Registration
| API endpoint | granular scope |
|---|---|
| Get details of a deal registration by registration number | zoom_commerce:read:deal_registration:admin |
| Retrieves all valid Zoom Campaigns which a deal registration can be associated with. | zoom_commerce:read:deal_registration:admin |
| Gets all valid Deal Registrations for a partner | zoom_commerce:read:deal_registration:admin |
| Creates a new deal registration for a partner | zoom_commerce:write:deal_registration:admin |
| Updates an existing deal registration | zoom_commerce:write:deal_registration:admin |
Order
| API endpoint | granular scope |
|---|---|
| Gets all orders for a Zoom partner. | zoom_commerce:read:order:admin |
| Get order details by order reference ID | zoom_commerce:read:order:admin |
| Create a subscription order for a Zoom partner | zoom_commerce:write:order:admin |
| Preview delta order metrics and subscriptions in an order | zoom_commerce:write:order:admin |
Platform
| API endpoint | granular scope |
|---|---|
| Gets details of all files associated with a quote or deal registration | zoom_commerce:read:file:admin |
| Download a file associated with a quote or deal registration. | zoom_commerce:read:file:admin |
| Upload an attachment pdf file in context of a deal registration or quote | zoom_commerce:write:file:admin |
Product Catalog
| API endpoint | granular scope |
|---|---|
| Validate offer compatibility and dependencies | zoom_commerce:read:product_catalog:admin |
| Gets the pricebook in a downloadable file | zoom_commerce:read:product_catalog:admin |
| Gets Zoom Product Catalog for a Zoom Partner | zoom_commerce:read:product_catalog:admin |
| Gets the details for a Zoom product or offer. | zoom_commerce:read:product_catalog:admin |
Quote
| API endpoint | granular scope |
|---|---|
| Gets all quotes for a Zoom partner | zoom_commerce:read:quote:admin |
| Submits a subscription quote for provisioning | zoom_commerce:write:quote:admin |
| Get quote details by quote reference ID | zoom_commerce:read:quote:admin |
| Preview delta quote metrics and subscriptions in a quote | zoom_commerce:write:quote:admin |
| Update a subscription quote for a Zoom Partner | zoom_commerce:write:quote:admin |
| Create a subscription quote for a Zoom Partner | zoom_commerce:write:quote:admin |
Subscription
| API endpoint | granular scope |
|---|---|
| Gets paid subscriptions for a Zoom partner. | zoom_commerce:read:subscription:admin |
| Get trial details for an end customer by their Zoom account number or the trial ID | zoom_commerce:read:subscription:admin |
| Get trial subscriptions for a Zoom partner | zoom_commerce:read:subscription:admin |
| Gets subscription changes/versions for a given subscription number. | zoom_commerce:read:subscription:admin |
| Gets subscription details for a given subscription number | zoom_commerce:read:subscription:admin |
Sheets
The following are the available Sheets APIs and their associated granular scopes.
Cell
| API endpoint | granular scope |
|---|---|
| Edit cells on a sheet | sheets:write:content |
| Read cell values from a sheet | sheets:read:content |
Sheet
| API endpoint | granular scope |
|---|---|
| Add a sheet | sheets:write:content |
| Rename a sheet | sheets:update:content |
| Delete a sheet | sheets:delete:content |
Spreadsheet
| API endpoint | granular scope |
|---|---|
| Create a spreadsheet | sheets:write:content |
| Get spreadsheet metadata and sample data | sheets:read:content |
Canvas
The following are the available Canvas APIs and their associated granular scopes.
Archiving
| API endpoint | granular scope |
|---|---|
| Download archive attachments | docs:read:archive:admin |
| List doc archive data | docs:read:archive:admin |
Collaborator
| API endpoint | granular scope |
|---|---|
| Modify a collaborator’s role on a file | docs:update:collaborator docs:update:collaborator:admin |
| Remove a collaborator from a file | docs:delete:collaborator docs:delete:collaborator:admin |
| Add collaborators for a file | docs:write:collaborator docs:write:collaborator:admin |
| List collaborators of a file | docs:read:list_file_collaborators docs:read:list_file_collaborators:admin |
Comment
| API endpoint | granular scope |
|---|---|
| Update a comment | canvas:update:comment |
| List comments | canvas:read:comment |
| Create a comment | canvas:write:comment |
| Get a comment | canvas:read:comment |
| Delete a comment | canvas:delete:comment |
DataTable Content
| API endpoint | granular scope |
|---|---|
| List columns | canvas:read:data_table |
| Update rows | canvas:update:data_table |
| Search rows | canvas:read:data_table |
| Update table metadata | canvas:update:data_table |
| Create a column | canvas:write:data_table |
| List data tables in a file | canvas:read:data_table |
| Delete a column | canvas:delete:data_table |
| Create table rows | canvas:write:data_table |
| Update a column | canvas:update:data_table |
| Delete rows | canvas:delete:data_table |
| Create data table | canvas:write:data_table |
Doc Content
| API endpoint | granular scope |
|---|---|
| Insert blocks into a document | docs:write:content |
| Delete a specific block | docs:delete:content |
| Replace a range of blocks | docs:update:content |
| Update a specific block | docs:update:content |
Export
| API endpoint | granular scope |
|---|---|
| Get file content | docs:read:export |
| Get file export status | docs:read:export docs:read:export:admin |
| Create a file export | docs:write:export docs:write:export:admin |
File Management
| API endpoint | granular scope |
|---|---|
| Get user My docs info | docs:read:file:admin |
| Get metadata of a file | docs:read:file docs:read:file:admin |
| Modify metadata of a file | docs:update:file docs:update:file:admin |
| Create a new file | docs:write:file docs:write:file:admin |
| List all children of a file | docs:read:list_children docs:read:list_children:admin |
| Transfer ownership of a file | docs:update:file_owner docs:update:file_owner:admin |
| Delete a file | docs:delete:file docs:delete:file:admin |
File Uploads
| API endpoint | granular scope |
|---|---|
| Create file upload for docs import or attachments | docs:write:file_uploads docs:write:file_uploads:admin |
General Access
| API endpoint | granular scope |
|---|---|
| Get the general access setting of a file | docs:read:general_access docs:read:general_access:admin |
| Modify the general access setting of a file | docs:update:general_access docs:update:general_access:admin |
Import
| API endpoint | granular scope |
|---|---|
| Create a new file from content | docs:write:import |
| Create a new file by import | docs:write:import docs:write:import:admin |
| Get file import status | docs:read:import docs:read:import:admin |
Report
| API endpoint | granular scope |
|---|---|
| Get activity report | docs:read:activity_report:admin |
Search
| API endpoint | granular scope |
|---|---|
| Search files | canvas:write:file_search |
My Notes
The following are the available My Notes APIs and their associated granular scopes.
My Notes Management
| API endpoint | granular scope |
|---|---|
| [Get My Notes content and transcript](/docs/api/rest/reference/My Notes/methods/#operation/DocBridgeInternalOpenAPIService_InternalOpenAPIGetMyNotes) | my_notes:read:content |
| [List my notes](/docs/api/rest/reference/My Notes/methods/#operation/ListMyNotesByMeetingId) | my_notes:read:note |
Zoom Video Management
The following are the available Zoom Video Management APIs and their associated granular scopes.
Channels
| API endpoint | granular scope |
|---|---|
| List channels | video_mgmt:read:list_channels video_mgmt:read:list_channels:admin |
| Update channel | video_mgmt:update:channel video_mgmt:update:channel:admin |
| Channel actions | video_mgmt:update:channel video_mgmt:update:channel:admin |
| Get channel details | video_mgmt:read:channel video_mgmt:read:channel:admin |
| Delete channel | video_mgmt:delete:channel video_mgmt:delete:channel:admin |
| Create a channel | video_mgmt:write:channel video_mgmt:write:channel:admin |
Permissions
| API endpoint | granular scope |
|---|---|
| List channel permissions | video_mgmt:read:list_permissions video_mgmt:read:list_permissions:admin |
| Update channel permissions | video_mgmt:update:permissions video_mgmt:update:permissions:admin |
| Create channel permissions | video_mgmt:write:permissions video_mgmt:write:permissions:admin |
| Delete channel permissions | video_mgmt:delete:permissions video_mgmt:delete:permissions:admin |
Playlists
| API endpoint | granular scope |
|---|---|
| Update playlist | video_mgmt:update:playlist video_mgmt:update:playlist:admin |
| Delete playlist | video_mgmt:delete:playlist video_mgmt:delete:playlist:admin |
| List playlists | video_mgmt:read:list_playlists video_mgmt:read:list_playlists:admin |
| Add channel playlists | video_mgmt:write:channel_playlists video_mgmt:write:channel_playlists:admin |
| List channel playlists | video_mgmt:read:list_channel_playlists video_mgmt:read:list_channel_playlists:admin |
| Create a playlist | video_mgmt:write:playlist video_mgmt:write:playlist:admin |
| Delete channel playlists | video_mgmt:delete:channel_playlists video_mgmt:delete:channel_playlists:admin |
Videos
| API endpoint | granular scope |
|---|---|
| Update metadata for a specific video. | video_mgmt:update:video_metadata video_mgmt:update:video_metadata:admin |
| List playlist videos | video_mgmt:read:list_playlist_videos video_mgmt:read:list_playlist_videos:admin |
| Add playlist videos | video_mgmt:write:playlist_videos video_mgmt:write:playlist_videos:admin |
| Delete playlist videos | video_mgmt:delete:playlist_videos video_mgmt:delete:playlist_videos:admin |
| Delete channel videos | video_mgmt:delete:channel_videos video_mgmt:delete:channel_videos:admin |
| Add channel videos | video_mgmt:write:channel_videos video_mgmt:write:channel_videos:admin |
| List all videos | video_mgmt:read:list_videos video_mgmt:read:list_videos:admin |
| List channel videos | video_mgmt:read:list_channel_videos video_mgmt:read:list_channel_videos:admin |
| Get metadata for a specific video | video_mgmt:read:video_metadata video_mgmt:read:video_metadata:admin |
files
| API endpoint | granular scope |
|---|---|
| Upload file for video management | video_mgmt:write:file video_mgmt:write:file:admin |
Zoom Events
The following are the available Zoom Events APIs and their associated granular scopes.
Attendee Actions
| API endpoint | granular scope |
|---|---|
| Update event attendee actions | zoom_events:update:batch_attendee_actions zoom_events:update:batch_attendee_actions:admin |
| List event attendee actions | zoom_events:read:list_attendee_actions zoom_events:read:list_attendee_actions:admin |
| List session attendee actions | zoom_events:read:list_session_attendee_actions zoom_events:read:list_session_attendee_actions:admin |
| Update session attendee actions | zoom_events:update:batch_session_attendee_actions zoom_events:update:batch_session_attendee_actions:admin |
Co Editors
| API endpoint | granular scope |
|---|---|
| Add or remove event co-editors | zoom_events:write:coeditor zoom_events:write:coeditor:admin |
| List coeditors | zoom_events:read:list_coeditors zoom_events:read:list_coeditors:admin |
Emails
| API endpoint | granular scope |
|---|---|
| List event emails sent status | zoom_events:read:list_emails_status zoom_events:read:list_emails_status:admin |
| List event email types | zoom_events:read:list_email_types zoom_events:read:list_email_types:admin |
Event Access
| API endpoint | granular scope |
|---|---|
| List event access links | zoom_events:read:list_access_links zoom_events:read:list_access_links:admin |
| Get event access link | zoom_events:read:access_links zoom_events:read:access_links:admin |
| Update event access | zoom_events:update:access_links zoom_events:update:access_links:admin |
| Delete event access link | zoom_events:delete:access_links zoom_events:delete:access_links:admin |
| Create event access link | zoom_events:write:access_links zoom_events:write:access_links:admin |
Events
| API endpoint | granular scope |
|---|---|
| List events | zoom_events:read:list_events zoom_events:read:list_events:admin |
| Delete an event | zoom_events:delete:event zoom_events:delete:event:admin |
| Event actions | zoom_events:write:event zoom_events:write:event:admin |
| Update an event | zoom_events:update:event zoom_events:update:event:admin |
| Get an event | zoom_events:read:event zoom_events:read:event:admin |
| Create an event | zoom_events:write:event zoom_events:write:event:admin |
Exhibitors
| API endpoint | granular scope |
|---|---|
| Create an exhibitor | zoom_events:write:exhibitor zoom_events:write:exhibitor:admin |
| List exhibitors | zoom_events:read:list_exhibitors zoom_events:read:list_exhibitors:admin |
| Update exhibitor for an event | zoom_events:update:exhibitor zoom_events:update:exhibitor:admin |
| Delete an exhibitor | zoom_events:delete:exhibitor zoom_events:delete:exhibitor:admin |
| List sponsor tiers | zoom_events:read:list_sponsor_tiers zoom_events:read:list_sponsor_tiers:admin |
| Get an exhibitor | zoom_events:read:exhibitor zoom_events:read:exhibitor:admin |
Files
| API endpoint | granular scope |
|---|---|
| Upload events multipart files | zoom_events:write:file_upload zoom_events:write:file_upload:admin |
| Initiate and complete the multipart file upload | zoom_events:write:file_upload zoom_events:write:file_upload:admin |
| Upload events file | zoom_events:write:file_upload zoom_events:write:file_upload:admin |
Hubs
| API endpoint | granular scope |
|---|---|
| Creates a new hub host | zoom_events:write:hub_host zoom_events:write:hub_host:admin |
| List hub Hosts | zoom_events:read:list_hub_hosts zoom_events:read:list_hub_hosts:admin |
| List hub videos | zoom_events:read:list_hub_videos zoom_events:read:list_hub_videos:admin |
| List hubs | zoom_events:read:list_hubs zoom_events:read:list_hubs:admin |
| Remove hub host | zoom_events:delete:hub_host zoom_events:delete:hub_host:admin |
Insights
| API endpoint | granular scope |
|---|---|
| Get attendee engagement data | zoom_events:read:attendee_engagement zoom_events:read:attendee_engagement:admin |
Registrants
| API endpoint | granular scope |
|---|---|
| List registrants | zoom_events:read:list_registrants zoom_events:read:list_registrants:admin |
| List session attendees | zoom_events:read:list_session_attendees zoom_events:read:list_session_attendees:admin |
Reports
| API endpoint | granular scope |
|---|---|
| Get VOD channel registration report | zoom_events:read:vod_registrations zoom_events:read:vod_registrations:admin |
| Get event survey report | zoom_events:read:list_session_surveys zoom_events:read:list_session_surveys:admin |
| Get session attendance report | zoom_events:read:session_attendance zoom_events:read:session_attendance:admin |
| Get chat transcripts report | zoom_events:read:chat_transcripts zoom_events:read:chat_transcripts:admin |
| Get custom report | zoom_events:read:custom_report zoom_events:read:custom_report:admin |
| Get event registrations report | zoom_events:read:event_registration zoom_events:read:event_registration:admin |
| Get event attendance (Live or Lobby) report | zoom_events:read:event_attendance zoom_events:read:event_attendance:admin |
Sessions
| API endpoint | granular scope |
|---|---|
| List sessions | zoom_events:read:list_sessions zoom_events:read:list_sessions:admin |
| List session reservations | zoom_events:read:list_session_reservations zoom_events:read:list_session_reservations:admin |
| Add session reservations | zoom_events:write:session_reservations zoom_events:write:session_reservations:admin |
| Update a session | zoom_events:update:session zoom_events:update:session:admin |
| Get the session information | zoom_events:read:session zoom_events:read:session:admin |
| Create a session | zoom_events:write:session zoom_events:write:session:admin |
| Get session livestream configuration | zoom_events:read:session_livestream_config zoom_events:read:session_livestream_config:admin |
| Delete session reservations | zoom_events:delete:session_reservations zoom_events:delete:session_reservations:admin |
| Update session livestream configuration | zoom_events:update:session_livestream_config zoom_events:update:session_livestream_config:admin |
| List session interpreters | zoom_events:read:list_session_interpreters zoom_events:read:list_session_interpreters:admin |
| Delete a session | zoom_events:delete:session zoom_events:delete:session:admin |
| Create or update session polls | zoom_events:update:session_poll zoom_events:update:session_poll:admin |
| List session polls | zoom_events:read:list_session_polls zoom_events:read:list_session_polls:admin |
| Get ticket session join token by Event ID and Session ID | zoom_events:read:session_token zoom_events:read:session_token:admin |
| Create or update session interpreters | zoom_events:update:session_interpreter zoom_events:update:session_interpreter:admin |
Speakers
| API endpoint | granular scope |
|---|---|
| List speakers | zoom_events:read:list_speakers zoom_events:read:list_speakers:admin |
| Get a speaker | zoom_events:read:speaker zoom_events:read:speaker:admin |
| Create a speaker | zoom_events:write:speaker zoom_events:write:speaker:admin |
| Delete a speaker | zoom_events:delete:speaker zoom_events:delete:speaker:admin |
| Update a speaker | zoom_events:update:speaker zoom_events:update:speaker:admin |
Ticket Types
| API endpoint | granular scope |
|---|---|
| List ticket types | zoom_events:read:list_ticket_types zoom_events:read:list_ticket_types:admin |
| Update registration questions for ticket type | zoom_events:update:registraion_question zoom_events:update:registraion_question:admin |
| Delete a ticket type | zoom_events:delete:ticket_type zoom_events:delete:ticket_type:admin |
| Update ticket type for an event | zoom_events:update:ticket_type zoom_events:update:ticket_type:admin |
| List registration questions for ticket type | zoom_events:read:list_registration_questions zoom_events:read:list_registration_questions:admin |
| Create an event ticket type | zoom_events:write:ticket_type zoom_events:write:ticket_type:admin |
| Update registration questions for an event | zoom_events:update:registraion_question zoom_events:update:registraion_question:admin |
| List registration questions for an event | zoom_events:read:list_registration_questions zoom_events:read:list_registration_questions:admin |
Tickets
| API endpoint | granular scope |
|---|---|
| Get a ticket | zoom_events:read:ticket zoom_events:read:ticket:admin |
| Create tickets | zoom_events:write:ticket zoom_events:write:ticket:admin |
| Delete a ticket | zoom_events:delete:ticket zoom_events:delete:ticket:admin |
| Update ticket | zoom_events:write:ticket zoom_events:write:ticket:admin |
| List tickets | zoom_events:read:list_tickets zoom_events:read:list_tickets:admin |
Video On-Demand
| API endpoint | granular scope |
|---|---|
| VOD channel actions | zoom_events:update:vod_channel zoom_events:update:vod_channel:admin |
| List VOD channel videos | zoom_events:read:list_vod_channel_videos zoom_events:read:list_vod_channel_videos:admin |
| Delete VOD Channel | zoom_events:delete:vod_channel zoom_events:delete:vod_channel:admin |
| Create VOD channel | zoom_events:write:vod_channel zoom_events:write:vod_channel:admin |
| Delete VOD channel video | zoom_events:delete:vod_channel_videos zoom_events:delete:vod_channel_videos:admin |
| Update VOD channel | zoom_events:update:vod_channel zoom_events:update:vod_channel:admin |
| Get VOD channel details | zoom_events:read:vod_channel zoom_events:read:vod_channel:admin |
| List channels | zoom_events:read:list_all_vod_channels zoom_events:read:list_all_vod_channels:admin |
| Add VOD channel videos | zoom_events:write:vod_channel_videos zoom_events:write:vod_channel_videos:admin |
Video On-Demand Registrations
| API endpoint | granular scope |
|---|---|
| List VOD Registration | zoom_events:read:vod_registrations zoom_events:read:vod_registrations:admin |
| Get VOD Registration Questions | zoom_events:read:vod_registration_questions zoom_events:read:vod_registration_questions:admin |
| update VOD channel registration questions | zoom_events:update:vod_registration_questions zoom_events:update:vod_registration_questions:admin |
| VOD channel registration | zoom_events:write:vod_registration zoom_events:write:vod_registration:admin |
Videos
| API endpoint | granular scope |
|---|---|
| Get metadata for a specific video | zoom_events:read:video_metadata zoom_events:read:video_metadata:admin |
| Update metadata for a specific video | zoom_events:update:video_metadata zoom_events:update:video_metadata:admin |
Zoom Mesh
The following are the available Zoom Mesh APIs and their associated granular scopes.
Locations
| API endpoint | granular scope |
|---|---|
| List Mesh locations | zoom_mesh:read:list_locations:admin |
| Create a Mesh location | zoom_mesh:write:location:admin |
| Get a Mesh location | zoom_mesh:read:location:admin |
| Delete a Mesh location | zoom_mesh:delete:location:admin |
| Update a Mesh location | zoom_mesh:update:location:admin |
Marketplace
The following are the available Marketplace APIs and their associated granular scopes.
App
| API endpoint | granular scope |
|---|---|
| List apps | marketplace:read:list_apps:admin |
| Get an app's user requests | marketplace:read:app_request:admin |
| Update app's request status | marketplace:update:app_request:admin |
| Update app pre approval setting | marketplace:write:app_pre_approve:admin |
| Generate Zoom App Deeplink | marketplace:write:app_deeplink:admin |
| Get user's custom field values | marketplace:read:custom_fields:admin marketplace:read:custom_fields |
| Get API call logs | marketplace:read:list_api_logs:admin |
| Send app notifications | marketplace:write:notifications |
| Create apps | marketplace:write:app marketplace:write:app:admin |
| Create apps | marketplace:write:app:master |
| Get app user entitlements | marketplace:read:list_user_entitlements marketplace:read:list_user_entitlements:admin |
| Get a user's entitlements | marketplace:read:list_user_entitlements marketplace:read:list_user_entitlements:admin |
| Get information about an app | marketplace:read:app marketplace:read:app:admin |
| Add app allow requests for users | marketplace:write:app_request:admin |
| Rotate client secret | marketplace:update:client_secret |
| Get a user's app requests | marketplace:read:list_user_app_requests:admin marketplace:read:list_user_app_requests |
| Enable or disable user app subscription | marketplace:write:app:admin |
| Deletes an app | marketplace:write:app marketplace:write:app:admin |
Manifest
| API endpoint | granular scope |
|---|---|
| Export an app manifest from an existing app | marketplace:read:app marketplace:read:app:admin |
| Update an app by manifest | marketplace:write:app marketplace:write:app:admin |
| Validate an app manifest | marketplace:read:app marketplace:read:app:admin |
SCIM
The following are the available SCIM APIs and their associated granular scopes.
Group
| API endpoint | granular scope |
|---|---|
| Create a group | scim2:admin |
| List groups | scim2:admin |
| Delete a group | scim2:admin |
| Get a group | scim2:admin |
| Update a group | scim2:admin |
User
| API endpoint | granular scope |
|---|---|
| Get a user | scim2:admin |
| Delete a user | scim2:admin |
| Update a user | scim2:admin |
| List users | scim2:admin |
| Deactivate a user | scim2:admin |
| Create a user | scim2:admin |
Zoom Auto Dialer
The following are the available Zoom Auto Dialer APIs and their associated granular scopes.
Call History & Reporting
| API endpoint | granular scope |
|---|---|
| [Get Seller Productivity Report](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetSellerProductivityReport) | zoom_auto_dialer:read:user_seller_productivity:admin |
| [Get call history by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallDetailsbyCallID) | zoom_auto_dialer:read:call_history:admin |
| [Get Report Call History](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetReportCallHistory) | zoom_auto_dialer:read:list_seller_productivity:admin |
| [Get Call History](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallHistory) | zoom_auto_dialer:read:call_history:admin |
Call List Management
| API endpoint | granular scope |
|---|---|
| [Create Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateCallList) | zoom_auto_dialer:write:call_lists:admin |
| [Update Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateCallList) | zoom_auto_dialer:update:call_lists:admin |
| [List Call Lists](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/ListCallLists) | zoom_auto_dialer:read:call_lists:admin |
| [Get Call List by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetCallListbyID) | zoom_auto_dialer:read:call_lists:admin |
| [Delete Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/DeleteCallList) | zoom_auto_dialer:delete:call_lists:admin |
Prospect Management
| API endpoint | granular scope |
|---|---|
| [Delete Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/DeleteProspect) | zoom_auto_dialer:delete:prospects:admin |
| [Get Prospect by ID](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/GetProspectbyID) | zoom_auto_dialer:read:prospects:admin |
| [Create Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateProspect) | zoom_auto_dialer:write:prospects:admin |
| [Update Prospect](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateProspect) | zoom_auto_dialer:update:prospects:admin |
| [List All Prospects in Call List](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/ListAllProspectsInCallList) | zoom_auto_dialer:read:prospects:admin |
| [Create Prospects batch](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/CreateProspects) | zoom_auto_dialer:write:prospects:admin |
| [Update Prospects batch](/docs/api/rest/reference/Zoom Auto Dialer/methods/#operation/UpdateProspects) | zoom_auto_dialer:update:prospects:admin |
AIAGW_SDK
The following are the available AIAGW_SDK APIs and their associated granular scopes.
Decisions
| API endpoint | granular scope |
|---|---|
| Evaluate decision questions | aiservices:write:decide:admin |
Scribe
| API endpoint | granular scope |
|---|---|
| Get Batch Job Status | aiservices:read:scribe_batch_job:admin |
| Live Scribe WebSocket | aiservices:write:live_transcribe:admin |
| Get Batch Scribe Job File | aiservices:read:scribe_batch_job_file:admin |
| List Batch Jobs | aiservices:read:list_scribe_batch_jobs:admin |
| Submit Batch Scribe Job | aiservices:write:scribe_batch_job:admin |
| Scribe (Synchronous) | aiservices:write:transcribe:admin |
| Cancel Batch Job | aiservices:delete:scribe_batch_job:admin |
| List Batch Job Files | aiservices:read:list_scribe_batch_job_files:admin |
Speech Summarization
| API endpoint | granular scope |
|---|---|
| Summarize (Synchronous)​ | aiservices:write:transcribe-summarize:admin |
Summarizer
| API endpoint | granular scope |
|---|---|
| List Batch Summarizer Jobs | aiservices:read:list_summarizer_batch_jobs:admin |
| List Batch Summarizer Job Files | aiservices:read:list_summarizer_batch_job_files:admin |
| Get Batch Summarizer Job File | aiservices:read:summarizer_batch_job_file:admin |
| Get Batch Summarizer Job | aiservices:read:summarizer_batch_job:admin |
| Submit Batch Summarizer Job | aiservices:write:summarizer_batch_job:admin |
| Cancel Batch Summarizer Job | aiservices:delete:summarizer_batch_job:admin |
| Summarize (Synchronous) | aiservices:write:summarize:admin |
Translator
| API endpoint | granular scope |
|---|---|
| Get Batch Translator Job File | aiservices:read:translator_batch_job_file:admin |
| Translate (Synchronous) | aiservices:write:translate:admin |
| List Batch Translator Jobs | aiservices:read:list_translator_batch_jobs:admin |
| Submit Batch Translator Job | aiservices:write:translator_batch_job:admin |
| List Batch Translator Job Files | aiservices:read:list_translator_batch_job_files:admin |
| Get Batch Translator Job | aiservices:read:translator_batch_job:admin |
| Cancel Batch Translator Job | aiservices:delete:translator_batch_job:admin |
VoiceAgent
| API endpoint | granular scope |
|---|---|
| Live Voice Agent WebSocket | aiservices:read:voice-agent:admin |