OAuth Scopes

OAuth scopes provide a way to limit the amount of access granted to an app. Zoom has user-level, admin-level, and Master-level scopes:

  • A user-level app can only request scopes that allow access to an individual user's associated data.
  • An account-level app has admin scopes and provides admin capabilities. Note: The user adding the app must be an account admin or owner in order to be granted admin capabilities.
  • Master-level scopes can only be granted to an an account-level app by account owners.

This document provides a complete list of scopes, their descriptions, and the associated API calls that the app with permitted scope has access to.

An application can set one or multiple scopes while registering their OAuth app in the Zoom App Marketplace.

See shared access permissions for important details about your app's access to information.

Scopes list

Account scopes

The following are the available Account scopes and their associated API calls:

account:read:admin

This scope allows an app to view a Master account's account and sub account information. This includes account settings, account lock settings, managed domains, and an account's trusted domains.

Associated APIs

account:write:admin

This scope allows an app to manage sub accounts on behalf of a Master account. This includes creating or disassociating a sub account from a Master account, updating an account's owner or account settings, and updating lock settings.

Associated APIs

account:master

This scope allows an app to view and manage a Master account's sub accounts.

Associated APIs


Back to top.

Billing scopes

The following are the available Billing scopes and their associated API calls:

billing:master

This scope allows an app to view and manage billing details. This includes modifying a sub account, viewing sub accounts' plans, and viewing a sub account's plan data usage.

Associated APIs

billing:read:admin

This scope allows an app to view the billing details of all of an account's users.

Associated APIs

billing_plan:read:admin

This scope allows an app to view and manage billing plan details.

Associated APIs


Back to top.

Chat scopes

The following are the available Chat scopes and their associated API calls:

chat_message:read

This scope allows an app to view user's chat messages and information, such as the date and time of when it was sent and the sender's email address.

Associated APIs

chat_message:read:admin

Sensitive Information

This scope allows an app to view chat messages of all of an account's users. This includes accessing information related to messages, such as the date and time of when it was sent and the sender's email address.

Only users who are assigned a role that includes the View permission for chat messages can add and use apps that request this scope. Users who do not have this permission cannot add any apps that request this scope.

Associated APIs

chat_message:write

This scope allows an app to send chat messages, as well as update and delete a user's previously-sent messages.

Associated APIs

chat_message:write:admin

Sensitive Information

This scope allows an app to send chat messages, as well as update and delete previously-sent messages for an account's users.

Only users who are assigned a role that includes the Edit permission for chat messages can add and use apps that request this scope. Users who do not have this permission cannot add any apps that request this scope.

Associated APIs

imchat:read

Sensitive Information

This scope allows an app to view chat session information and user messages from a specific date.

Associated APIs

imchat:read:admin

Sensitive Information

This scope allows an app to view all users' chat session details and messages.

Associated APIs

imchat:write

This scope allows an app to send chat messages, as well as update and delete previously-sent messages for a user.

Associated APIs

chat_channel:read

This scope allows an app to view chat channel information.

Associated APIs

chat_channel:write

This scope allows an app to view and manage chat channel information and perform actions on user's behalf. This includes creating or updating channels, inviting or removing channels members, and removing a channel.

Associated APIs

chat_channel:read:admin

This scope allows an app to view information about the chat channels joined by an account's users.

Only users who are assigned a role that includes the View permission for chat channels can add and use apps that request this scope. Users who do not have this permission cannot add any apps that request this scope.

Associated APIs

chat_channel:write:admin

This scope allows an app to view and manage information for chat channels joined by an account's users, as well as perform actions on a user's behalf. This includes creating or updating channels, inviting or removing channels members, and removing a channel.

Only users who are assigned a role that includes the Edit permission for chat channels can add and use apps that request this scope. Users who do not have this permission cannot add any apps that request this scope.

Associated APIs


Back to top.

Chatbot scopes

The following are the available Chatbot scopes and their associated API calls:

imchat:bot

This scope allows a chatbot to interact with users by sending messages to users, editing the sent messages, and deleting the sent messages.

Associated APIs


Back to top.

Contacts scopes

The following are the available Contacts scopes and their associated API calls:

contact:read

This scope allows an app to view a user's company contacts.

Associated APIs

contact:read:admin

This scope allows an app to search for users in a Zoom account's company contacts.

Associated APIs

chat_contact:read

This scope allows an app to retrieve a user's chat contacts information.

Associated APIs


Back to top.

Contact center scopes

Contact center scopes and associated API.

contact_center_contact:read:admin

View address book information.

API

contact_center_contact:write:admin

Update address book information.

API

contact_center_disposition:read:admin

View disposition information.

API

contact_center_disposition:write:admin

Update disposition information.

API

contact_center_preference:read:admin

View preference information.

API

contact_center_queue:read:admin

View queue information.

API

contact_center_queue:write:admin

Update queue information.

API

contact_center_recording:read

View your contact center recording information.

API

contact_center_recording:read:admin

View all contact center recording information.

API

contact_center_recording:write:admin

Manage all contact center recording information.

API

contact_center_report:read:admin

View all contact center report information.

API

contact_center_role:read:admin

View role information.

API

contact_center_role:write:admin

Update role information.

API

contact_center_task:read:admin

View task information.

API

contact_center_task:write:admin

Update task information.

API

contact_center_user:read:admin

View user information.

API

contact_center_user:write:admin

Update user information.

API


Back to top.

Dashboard scopes

The following are the available Dashboard scopes and their associated API calls:

dashboard_meetings:read:admin

This scope allows an app to view an account's Meeting Dashboard data. This includes meeting and meeting participant metrics, the meeting's quality score, and the quality of service provided to the participants during meetings.

Associated APIs

dashboard_webinars:read:admin

This scope allows an app to view an account's Webinar Dashboard data. This includes webinar and webinar participant metrics, as well as the quality of service provided to the webinar's participants.

Associated APIs

dashboard:read:admin

Associated APIs

dashboard:home:read

Associated APIs

zms:dashboard:read

Associated APIs

dashboard_zr:read:admin

This scope allows an app to view an account's Zoom Rooms Dashboard data, such as Zoom Room information and issues.

Associated APIs

dashboard_home:read:admin

This scope allows an app to view the Dashboard client satisfaction metrics for Zoom meetings and webinars.

Associated APIs

dashboard_im:read:admin

This scope allows an app to view the Zoom Chat Dashboard metrics for the usage of the Zoom Chat client by an account's users.

Associated APIs

dashboard_crc:read:admin

This scope allows an app to view the Cloud Room Connector (CRC) Dashboard metrics for an account's CRC usage.

Associated APIs


Back to top.

Devices (H323) scopes

The following are the available Devices (H323) scopes and their associated API calls:

h323:read:admin

This scope allows an app to an account's H.323/SIP device information. This includes information such as the device name, ID, protocol, and encryption options.

Associated APIs

h323:write:admin

This scope allows an app to manage an account's H.323/SIP devices.

Associated APIs


Back to top.

Group scopes

The following are the available Group scopes and their associated API calls:

group:read:admin

This scope allows an app to view group information.

Associated APIs

group:write:admin

This scope allows an app to perform actions on behalf of a group administrator. This include managing group members and settings, updating a group name, or deleting groups.

Associated APIs


Back to top.

IM Group scopes

The following are the available IM Group scopes and their associated API calls:

imgroup:read:admin

This scope allows an app to perform actions on behalf of an IM group administrator, such as viewing IM group and member details in a Zoom account.

Associated APIs

imgroup:write:admin

This scope allows an app to perform actions on behalf of an IM group administrator. This includes creating or updating an IM group, deleting an IM group, or updating the IM group's members.

Associated APIs


Back to top.

Meeting scopes

The following are the available Meeting scopes and their associated API calls:

meeting:read

This scope allows an app to view a user's meeting information. This includes meeting reports, participants, polls, and registrant information.

Associated APIs

meeting:read:admin

This scope allows an app to view the meeting information for all users in the Zoom account. This includes meeting reports, participants, polls, and registrants.

Associated APIs

meeting:write

This scope allows an app to view and manage user's meetings. This includes performing actions such as scheduling and updating meetings, g meetings, and updating live streaming options.

Associated APIs

meeting:write:admin

This scope allows an app to view and manage meeting information of all the users that are in the Zoom account. This includes performing actions such as scheduling and updating meetings, deleting meetings, and updating live streaming options.

Associated APIs

meeting:master

This scope allows an app to manage meeting information for a Master account's sub accounts.

Associated APIs


Back to top.

Meeting Token scopes

The following are the available Meeting Token scopes and their associated API calls:

meeting_token:read:local_recording

This scope allows an app to view a user's local recording meeting token information.

Associated APIs

meeting_token:read:admin:local_recording

This scope allows an app to view an account's users' local recording meeting token information.

Associated APIs


Back to top.

PAC scopes

The following are the available Personal Audio Conferencing (PAC) scopes and their associated API calls:

pac:read

This scope allows an app to view PAC details for a user.

Associated APIs

pac:read:admin

This scope allows an app to view PAC details for all users in an account. This includes dedicated and global dial-in numbers, conference IDs, and passwords used to join a conference.

Associated APIs

pac:write:admin

This scope allows an app to view and manage the PAC information for all users in an account.

pac:master

This scope allows an app to view and manage PAC information for all sub accounts associated with a Master account.


Back to top.

Phone scopes

The following are the available Phone scopes and associated API:

phone:read

This scope allows an app to view details about a user's Zoom Phone. This includes phone numbers associated with the user, the user's Zoom Phone profile details and calling plans, site details, voicemails, and recordings of the user's phone calls.

Associated API

phone:read:admin

This scope allows an app to view Zoom Phone details for all users in an account. This includes phone numbers associated with users, users' Zoom Phone profiles and calling plans, site details, voicemails, and recordings of users' phone calls.

Associated API

Audio library

Auto receptionists

Billing accounts

Blocked lists

Call handling

Call logs

Call queues

Common area phones

Common areas

Dashboard

Devices

Device line keys

Dial by name directory

Directory backup routing rules

Firmware update rules

Emergency addresses

Emergency service locations

External contacts

Group call pickup

IVR

Line keys

Monitoring groups

Outbound caller ID

Recordings

Reports

Phone roles

Setting templates

Shared line appearance

Shared line group

Site


Back to scopes list or phone scopes.

phone:write

This scope allows an app to update a user's Zoom Phone profile.

Associated API

phone:write:admin

This scope allows an app with access to Zoom Phone management permissions and the app can perform actions such as updating users' Zoom Phone settings, Zoom Phone profile that includes information related to calling plans enabled for the user, email address of the user, and site details, adding and removing user phone numbers, managing auto-receptionist configurations, blocked lists, call queues, devices, common area phones, and phone sites.

Associated API

Audio library

Auto receptionists

Blocked lists

Call handling

Call logs

Call queues

Common area phones

Common areas

Dashboard

Devices

Device line keys

Dial by name directory

Directory backup routing rules

Firmware update rules

Group call pickup

Emergency addresses

Emergency service locations

External contacts

IVR

Line keys

Monitoring groups

Outbound caller ID

Phone numbers

Recordings

Reports

Phone roles

Setting templates

Shared access

Shared line group

Site


Back to scopes list or phone scopes.

phone_call_log

Call log API.

phone_call_log:read

View call log information.

phone_call_log:read:admin

View all users' call log information.

Associated API

phone_call_log:write

View and manage call logs.

phone_call_log:write:admin

View and manage all user's call log information.

Associated API

Back to scopes list or phone scopes.

phone_recording

Call recording API.

phone_recording:read

View recording information.

phone_recording:read:admin

View all users' recording information.

Associated API

Back to scopes list or phone scopes.

phone_peering

Phone peering API are for use by partners that have completed the MoU to peer with Zoom. To become a peering provider/carrier, please submit your request.

phone_peering:read:admin

View your E164 numbers.

Associated API

phone_peering:write:admin

View and manage your E164 numbers.

Associated API

Back to scopes list or phone scopes.

phone_sms

SMS API.

phone_sms:read

View Zoom Phone SMS information.

Associated API

phone_sms:read:admin

View all users' Zoom Phone SMS information.

Associated API

Back to scopes list or phone scopes.

phone_voicemail

Zoom Phone voicemail API.

phone_voicemail:read

View call voicemails.

phone_voicemail:read:admin

View all users' call voicemail information.

Associated API

phone_voicemail:write

View and manage call voicemail information.

phone_voicemail:write:admin

View and manage all users' call voicemail information.