Zoom API

OpenAPI apis-guru telecom

The Zoom API allows developers to access information from Zoom. You can use this API to build private services or public applications on the . To learn how to get your credentials and create private/public applications, read our . All endpoints are available via https and are located at api.zoom.us/v2/.

For instance you can list all users on an account via https://api.zoom.us/v2/users/.

Homepage: https://api.apis.guru/v2/specs/zoom.us/2.0.0.json
Provider: zoom.us
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/zoom.us/2.0.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/zoom.us/2.0.0/openapi.yaml

Tools (375)

Extracted live via the executor SDK.

accounts.account
Get details of a sub account that is listed under a master account. Your account must be a master account in order to retrieve sub accounts' details. Zoom allows only to use master APIs and create sub accounts. Email the partner programs team at for more details.
Prerequisites:
- Pro or a higher paid account with master account option enabled.
Scope: account:write:admin
: Light
accounts.accountCreate
Create a sub account under a master account. Your account must be a master account in order to create sub accounts.

Zoom allows only to use master APIs and manage sub accounts. Email the partner programs team at . for more details. Please note that the created account user will receive a confirmation email.

Prerequisites:
- Pro or a higher paid account with master account option enabled.
Scope: account:write:admin
: Light
accounts.accountDisassociate
Disassociate a sub account from its master account. This will leave the sub account intact but it will no longer be associated with the master account.
Prerequisites:
- Pro or a higher paid account with master account option enabled.
- The account making this API request must be a .
Scope: account:write:admin
: Light
accounts.accountManagedDomain
Get a sub account's .

Note: This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.

To get managed domains of the master account, provide me as the value for accountId in the path parameter. Provide the sub account's Account ID as the value of accountId path parameter to get managed domains of the sub account.

Prerequisites:
- Pro or a higher paid account with master account option enabled.
Scope: account:read:admin
: Light
accounts.accountOptionsUpdate
Update a sub account's options under the master account.

Your account must be a master account in order to update the options for sub accounts. Zoom only assigns this privilege to trusted partners.
Prerequisites:
- Pro or a higher paid account with master account option enabled.
- The account making this API request must be a .
Scope: account:write:admin
: Light
accounts.accountSettings
Get the settings of an account.
To get the settings of a master account, use me as the value for the accountId path parameter.

Prerequisites:
- The account must be a paid account.
  Scopes: account:read:admin
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
accounts.accountSettingsUpdate
Update the settings of a sub account that is under a master account.
To update the settings of the master account, use me as the value of the accountId path parameter.

Prerequisites:
- The sub account must be a paid account.
  Scopes: account:write:admin
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
accounts.accountTrustedDomain
Get trusted domains of a sub account. To get the trusted domains of a master account, use me as the value for the accountId path parameter.
Prerequisites:
- The sub account must be a paid account.
  Scope: account:read:admin
  : Light
accounts.delVb
Delete existing virtual background file(s) from an account.
Prerequisites:
- Virtual background feature must be on the account.
Scope: account:write:admin

: Light
accounts.getAccountLockSettings
allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to retrieve an account's locked settings.
Note: This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.

Prerequisites:
- Pro or a higher paid account.
Scope: account:read:admin.
: Medium
Scope: account:read:admin
accounts.getOperation
List all the sub accounts that have been created by a master account.

Zoom allows only to use master APIs and manage sub accounts. Email the partner programs team at for more details.

Prerequisites:
- Pro or a higher paid account with master account option enabled.
Scope: account:read:admin
: Medium
accounts.updateAccountLockSettings
allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users. Use this API to update an account's locked settings.
Note: This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.

Prerequisites:
- Pro or a higher paid account.
Scope: account:write:admin
: Medium
accounts.updateAccountOwner
The current account owner can to another user on the same account.
Use this API to change the owner of a sub account.
Prerequisites:
- Account owner or admin permissions of an account.
- The account making this API request must be on a pro or a hiigher plan with privilege.
Scopes: account:write:admin or account:master
: Heavy
accounts.uploadVb
Use this API to for all users on the account to use.
Prerequisites:
- Virtual background feature must be on the account.
Scope: account:write:admin

: Medium
billing.accountBilling
Get of a sub account.

Only master accounts can use this API. Zoom allows only to use master APIs and manage sub accounts' billing information. Email the partner programs team at for more details.
Prerequisites:
- Pro or a higher paid account with master account option enabled.
Scope:billing:master
: Medium
billing.accountBillingInvoices
List of a Zoom account.
To list a regular Zoom account's invoices or a master account's invoices, provide me as the value of the accountId path parameter. To list a sub account's invoices, provide the account ID of the sub account in the accountId path parameter.
Prerequisites:
- Account must be enrolled in Pro or a higher plan.
Scope:billing:master
: Heavy
Additional Rate Limit: You can make one API request per account(accountId) every five minutes until the daily limit is reached. This API has a daily limit of 6 requests per account(accountId).
billing.accountBillingUpdate
Update of a sub account.

This API can only be used by master accounts that pay all billiing charges of their associated sub accounts. Zoom allows only to use master APIs and manage sub accounts' billing information. Email the partner programs team at for more details.

Prerequisites:
- Pro or a higher paid account with master account option enabled.
Scope:billing:master
: Heavy
billing.accountPlanAddonCancel
of a sub account. The cancellation does not provide refund for the current subscription. The service remains active for the current session.
This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at for more details.

: Heavy
Prerequisites:
- Pro or a higher plan with master account option enabled.
- The sub account must be a paid account.
  Scope: billing:master
billing.accountPlanAddonCreate
Subscribe a sub account to a Zoom addon plan. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at for more details.

Prerequisites:
- Pro or a higher plan with master account option enabled.
- The sub account must be a paid account. The billing charges for the sub account must be paid by its master account.
Scopes: billing:master
: Heavy
billing.accountPlanAddonUpdate
Update an additional plan for a sub account.
This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at for more details.

Prerequisites:
- Pro or a higher plan with master account enabled.
- The sub account must be a paid account. The billing charges for the sub account must be paid by the master account.
Scopes: billing:master
: Heavy
billing.accountPlanBaseDelete
for a sub account.
This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at for more details.

Scopes: billing:master
: Heavy
Prerequisites:
- The sub account must have a Pro or a higher plan.
billing.accountPlanBaseUpdate
Update a base plan of a sub account.
This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at for more details.

Scopes: billing:master

: Heavy
Prerequisites:
- The sub account must have a Pro or a higher plan.
billing.accountPlanCreate

Subscribe a sub account to a Zoom plan using your master account. This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' subscriptions. Email the partner programs team at for more details.

Scopes: billing:master
billing.accountPlans

Get plan information of a sub account that is managed by a master account.

This API can only be used by master accounts that pay all billiing charges of their associated Pro or higher sub accounts. Zoom allows only to use master APIs and manage sub accounts' billing information. Email the partner programs team at for more details.

Scopes: billing:master
: Medium
billing.downloadInvoicePdf
Download a invoice file of a Zoom account in PDF format. To download a regular account's invoice or a master account's invoice, provide me as the value of accountId path parameter. To download a sub account's invoice, provide the account ID of the sub account in the accountId path parameter.
Prerequisites:
- Account must be enrolled in Pro or a higher plan.
Scope:billing:master
Rate Limit: You can make one request to this API every thirty minutes until the daily limit is reached. This API has a daily limit of 100 requests per account.
billing.getAccountBillingInvoice
Get detailed information about a specific .
To retrieve a regular Zoom account's invoice details or a master account's invoice details, provide me as the value of accountId path parameter. To list a sub account's invoice details, provide the account ID of the sub account in the accountId path parameter.
Prerequisites:
- Account must be enrolled in Pro or a higher plan.
Scope:billing:master

: Heavy
Additional Rate Limit: You can make one API request every thirty minutes until the daily limit is reached. This API has a daily limit of 100 requests per account.
billing.getPlanUsage

Get information on usage of of an account. This API supports regular accounts as well as master and sub accounts. To get plan usage of a regular account, use the account:read:admin scope and provide “me” as the value of the accountId path parameter.To get plan usage of a master account, provide the keyword "me" as the value of the accountId path parameter and use the billing:master scope. To get plan usage of a sub account, provide the actual account Id of the sub account as the value of the accountId path parameter and use the billing:master scope.
Prerequisite:
Account type: master account on a paid Pro, Business or Enterprise plan.
Scope: billing:master for master and sub accounts. account:read:admin for regular Zoom accounts.
: Heavy
chatbotMessages.deleteAChatbotMessage

Delete a message that was sent by your chatbot app.

Scopes: imchat:bot
: Medium
Authorization Flow: Client Credentials Flow

To get authorized, make a POST request to /oauth/token endpoint with grant type as client_credentials.
Use https://api.zoom.us/oauth/token?grant_type=client_credentials as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. Basic base64Encode({client_id}:{client_sceret})

Next, use the token received (access_token) as a bearer token while making the DELETE /im/chat/messages/{message_id} request to delete a message.

Learn more about how to authotize chatbots in the guide.
chatbotMessages.editChatbotMessage

Edit a message that was by your Chatbot app.
After sending a message using the Send Chatbot Message API, you must store the messageId returned in the response so that you can make edits to the associated message using this API.
Scope: imchat:bot
: Medium
Authorization Flow: Client Credentials Flow

To get authorized, make a POST request to /oauth/token endpoint with grant type as client_credentials.
Use https://api.zoom.us/oauth/token?grant_type=client_credentials as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. Basic base64Encode({client_id}:{client_sceret})

Next, use the token received (access_token) as a bearer token while making the PUT /im/chat/messages/{message_id} request to edit a chatbot message.

Learn more about how to authotize chatbots in the guide.
chatbotMessages.sendchatbot

Send chatbot messages from your marketplace chatbot app.

Scopes: imchat:bot
: Medium
Authorization Flow: Client Credentials Flow

To get authorized, make a POST request to /oauth/token endpoint with grant type as client_credentials.
Use https://api.zoom.us/oauth/token?grant_type=client_credentials as the endpoint for the request. You will need to send your ClientID and Secret as a Basic base64 encoded AUthorization header. Ex. Basic base64Encode({client_id}:{client_sceret})

Next, use the token recieved (access_token) as a bearer token while making the POST /im/chat/messages request to send chatbot messages.

Learn more about how to authorize chatbots in the guide.
chatChannels.createChannel

Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to create a channel for a user.
Scopes:chat_channel:write or chat_channel:write:admin
Note: This API supports both user-managed apps and account-level apps. However, in an account-level , to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a that has Edit permission for the Chat channels feature.

: Medium
chatChannels.deleteUserLevelChannel

Zoom chat allow users to communicate via chat in private or public groups. Use this API to delete a specific channel.
Scope: chat_channel:write
: Medium
Note: This API only supports user-managed .
chatChannels.getChannels

Zoom chat allow users to communicate via chat in private or public groups. Use this API to list a user's chat channels.
Scope: chat_channel:read or chat_channel:read:admin
Note: This API supports both user-managed apps and account-level apps. However, in an account-level , to list channels of another user in the same Zoom account, the user calling this API must have a that has View or Edit permission for the Chat channels feature.

: Medium
chatChannels.getUserLevelChannel

Zoom chat allow users to communicate via chat in private or public groups. Use this API to get information about a specific channel.
Scope: chat_channel:read
: Medium
Note: This API only supports user-managed .
chatChannels.joinChannel

A can have one or multiple members. Use this API to join a channel that is open for anyone in the same organization to join. You cannot use this API to join private channels that only allows invited members to be a part of it.
Note: This API only supports user-managed .

Scope: chat_channel:write
: Medium
chatChannels.leaveChannel

If you're no longer interested in being a member of an existing channel, you can leave the channel at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer access information from that channel.
Note: This API only supports user-managed .

Scope: chat_channel:write
: Medium
chatChannels.removeAUserLevelChannelMember

A can have one or multiple members. Use this API to remove a member from a chat channel.

Scopes: chat_channel:write
: Medium

Note: This API only supports user-managed .
chatChannels.updateUserLevelChannel

Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel that you created.
Scope: chat_channel:write
: Medium
Note: This API only supports user-managed .
chatChannelsAccountLevel.deleteChannel

Zoom chat allow users to communicate via chat in private or public groups. Use this API to delete a specific channel.
Scope: chat_channel:write:admin
: Medium
Note: This API only supports user-managed .
chatChannelsAccountLevel.getChannel

Zoom chat allow users to communicate via chat in private or public groups. Use this API to get information about a specific channel.
Scope: chat_channel:read:admin
: Medium
Note: For an account-level , this API can only be used on behalf of a user who is assigned with a that has View or Edit permission for Chat Channels.
chatChannelsAccountLevel.inviteChannelMembers

A can have one or multiple members. Use this API to invite members that are in a user's contact list to a channel. The maximum number of members that can be added at once with this API is 5.
Scope: chat_channel:write:admin
: Medium
For an account-level , this API can only be used on behalf of a user who is assigned with a that has Edit permission for Chat Channels.
chatChannelsAccountLevel.listChannelMembers

A can have one or multiple members. List all the members of a channel using this API.
For an account-level , this API can only be used on behalf of a user who is assigned with a that has View or Edit permission for Chat Channels.
Scopes: chat_channel:read:admin
: Medium
chatChannelsAccountLevel.removeAChannelMember

A can have one or multiple members. Use this API to remove a member from a chat channel.

Scopes: chat_channel:write:admin
: Medium
Note: For an account-level , this API can only be used on behalf of a user who is assigned with a that has Edit permission for Chat Channels.
chatChannelsAccountLevel.updateChannel

Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel created by a user.

Scope: chat_channel:write:admin
: Medium
Note: For an account-level , this API can only be used on behalf of a user who is assigned with a that has Edit permission for Chat Channel.
chatMessages.deleteChatMessage
Delete a chat message that you previously sent to a contact or a channel. In the query parameter, you must provide either of the following:
- to_contact: The email address of the contact to whom you sent the message. Use this parameter to delete a message sent to an individual contact in Zoom.
- to_channel: The channel ID of the channel where you sent the message. Use this parameter to delete a message sent to a channel in Zoom.
Note: For an account-level , this API can only be used on behalf of a user who is assigned with a that has Edit permission for Chat Messages.
Scope: chat_message:write, chat_message:write:admin
: Medium
chatMessages.editMessage

Each chat message has a unique identifier. Use this API to edit a chat message that you previously sent to either a contact or a channel in Zoom by providing the ID of the message as the value of the messageId parameter. The ID can be retrieved from List User's Chat Messages API. Additionally, as a query parameter, you must provide either the email address of the contact or the Channel ID of the channel where the message was sent.
Scope: chat_message:write,chat_message:write:admin
: Medium
For an account-level , this API can only be used on behalf of a user who is assigned with a that has Edit permission for Chat Messages.
Scope: chat_message:write, chat_message:write:admin
chatMessages.getChatMessages
A Zoom user can have conversations with other Zoom users via chat. Use this API to list the current user's chat messages between the user and an individual contact or a chat channel.
In the query parameter, you must provide either of the following:
- to_contact: The email address of the contact with whom the user conversed by sending/receiving messages.
- to_channel: The channel ID of the channel to/from which the user has sent and/or received messages.
Specify a date in the date query parameter to view messages from that date. If a date is not provided, the default value for the query will be the current date.
Note: For an account-level , this API can only be used on behalf of a user who is assigned with a that has View or Edit permission for Chat Messages.

Scopes: chat_message:read, chat_message:read:admin
: Medium
chatMessages.sendaChatMessage

Send chat messages on Zoom to either an individual user who is in your contact list or to a of which you are a member. To send a message to a contact, provide the contact's email address in the to_contact field. Similary, to send a message to a channel, provide the Channel Id of the Channel in to_channel field.

Scopes: chat_message:write, chat_message:write:admin
: Medium

Note: For an account-level , this API can only be used on behalf of a user who is assigned with a that has Edit permission for Chat Messages.
cloudRecording.getAccountCloudRecording
List available on an Account.

To access a password protected cloud recording, add an "access_token" parameter to the download URL and provide as the value of the "access_token".

Prerequisites:
- A Pro or a higher paid plan with Cloud Recording option enabled.
  Scopes: recording:read:admin or account:read:admin
If the scope recording:read:admin is used, the Account ID of the Account must be provided in the accountId path parameter to list recordings that belong to the Account. This scope only works for sub accounts.
To list recordings of a master account, the scope must be account:read:admin and the value of accountId should be me.
: Medium
cloudRecording.listArchivedFiles
Zoom’s allows account administrators to set up an automated mechanism to record, collect and archive meeting data to a 3rd party platform of their choice and hence, satisfy FINRA and/ or other compliance requirements.

Use this API to retrieve archived meeting or webinar files of an account.
Scope: recording:read:admin
: Medium

Prerequisites:
- Enable cloud recording.
- Follow the to access the archiving feature.
cloudRecording.meetingRecordingRegistrantCreate

Cloud Recordings of past Zoom Meetings can be made . Users should be to view these recordings.
Use this API to register a user to gain access to On-demand Cloud Recordings of a past meeting.
Scopes: recording:write:admin, recording:write.
: Light
cloudRecording.meetingRecordingRegistrants

Cloud Recordings of past Zoom Meetings can be made . Users should be to view these recordings.
Use this API to list registrants of On-demand Cloud Recordings of a past meeting.
Scopes: recording:read:admin, recording:read.
: Medium
cloudRecording.meetingRecordingRegistrantStatus

A registrant can either be approved or denied from viewing the recording. Use this API to update a registrant's status.
Scopes: recording:write:admin, recording:write
: Medium
cloudRecording.recordingDelete
Delete all recording files of a meeting.

Scopes: recording:write:admin recording:write
: Light
Prerequisites:
- Cloud Recording should be enabled on the user's account.
cloudRecording.recordingDeleteOne

Delete a sprecific recording file from a meeting.

Scopes: recording:write:admin recording:write

: Light
cloudRecording.recordingGet

Get all the from a meeting or Webinar instance.

The recording files can be downloaded via the download_url property listed in the response.

To access a password protected cloud recording, add an "access_token" parameter to the download URL and provide OAuth access token or as the value of the "access_token".

Scopes: recording:read:admin recording:read
: Light
cloudRecording.recordingRegistrantQuestionUpdate

For meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.
Use this API to update registration questions that are to be answered by users while registering to view a recording.
Scopes: recording:write:admin, recording:write
: Light
cloudRecording.recordingRegistrantsQuestionsGet

For meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.
Use this API to retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.
Scopes: recording:read:admin, recording:read
: Light
cloudRecording.recordingSettingsUpdate

Update settings applied to a meeting's

Scopes: recording:write:admin recording:write
: Light
cloudRecording.recordingSettingUpdate

Retrieve settings applied to a meeting's .

Scopes: recording:read:admin recording:read
: Light
cloudRecording.recordingsList
When a user records a meeting or a webinar by choosing the Record to the Cloud option, the video, audio, and chat text are recorded in the Zoom cloud.
Use this API to list all of a user.

To access a user's password protected cloud recording, add an "access_token" parameter to the download URL and provide either the or the user's OAuth access token as the value of the "access_token" parameter.

Scopes: recording:read:admin recording:read
: Medium
Prerequisites:
- Pro or a higher plan.
- Cloud Recording must be enabled on the user's account.
cloudRecording.recordingStatusUpdate
Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted of a specific meeting.

Scopes: recording:write:admin recording:write
: Light
Prerequisites:
- A Pro user with Cloud Recording enabled.
cloudRecording.recordingStatusUpdateOne

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover a single recording file from the meeting.
Scopes: recording:write:admin recording:write
: Light
commonAreaPhones.addCommonAreaPhone
A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to .

Prerequisites:
- Pro or a higher account with Zoom Phone license.
- Account owner or admin permissions.
- Scope: phone:write:admin
: Light
commonAreaPhones.deleteCommonAreaPhone
A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to remove the from Zoom Phone System in an account.

Prerequisites:
- Pro or a higher account with Zoom Phone license.
- Account owner or admin permissions.
- Scopes: phone:write:admin
: Light
commonAreaPhones.getACommonAreaPhone
A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to get details on a specific in an account.
For the commonAreaPhoneId, use the unique identifier or the Mac address of the common area phone. The Mac address can be hyphenated (00-04-f2-5e-ec-3c) or not hyphenated (0004f25eec3c).

Prerequisites:
- Pro or a higher account with Zoom Phone license.
- Account owner or admin permissions.
- Scopes: phone:read:admin
: Light
commonAreaPhones.listCommonAreaPhones
A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to in an account.

Prerequisites:
- Pro or a higher account with Zoom Phone license.
- Account owner or admin permissions.
- Scope: phone:read:admin
: Medium
commonAreaPhones.updateCommonAreaPhone
A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to update details on a specific in an account.

Prerequisites:
- Pro or a higher account with Zoom Phone license.
- Account owner or admin permissions.
- Scopes: phone:write:admin
: Light
contacts.getUserContact

A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a . Call this API to get information on a specific contact of the Zoom user.
Note: This API only supports user-managed .

Scope: chat_contact:read
: Medium
contacts.getUserContacts

A user under an organization’s Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a . Call this API to list all the contacts of a Zoom user. Zoom contacts are categorized into "company contacts" and "external contacts". You must specify the contact type in the type query parameter. If you do not specify, by default, the type will be set as company contact.
Note: This API only supports user-managed .

Scope: chat_contact:read
: Medium
contacts.searchCompanyContacts

A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the search_key query parameter, provide either first name, last name or the email address of the user that you would like to search for. Optionally, set query_presence_status to true in order to include the presence status of a contact.

Scopes: contact:read:admin, contact:read
: Medium
dashboards.dashboardClientFeedback
Retrieve survey results from .
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Prerequisites:
- Business or higher account
- enabled.
Scope: account:read:admin
: Heavy
dashboards.dashboardClientFeedbackDetail
Retrieve detailed information on a .
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Prerequisites:
- Business or higher account
- enabled.
Scope: dashboard_home:read:admin
: Heavy
`
dashboards.dashboardCrc
A Cloud Room Connector allows H.323/SIP endpoints to connect to a Zoom meeting.
Use this API to get the hour by hour CRC Port usage for a specified period of time.
We will provide the report for a maximum of one month. For example, if "from" is set to "2017-08-05" and "to" is set to "2017-10-10", we will adjust "from" to "2017-09-10".

Prerequisites:
- Business, Education or API Plan.
- Room Connector must be enabled on the account.
  
  Scopes: dashboard_crc:read:admin
  : Heavy
dashboards.dashboardIm
Get on how users are utilizing the Zoom Chat Client.

You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months. Scope: dashboard_im:read:admin
: Resource-intensive
Prerequisites:
- Business or a higher plan.
dashboards.dashboardIssueDetailZoomRoom
Get information about the issues that occured on the Top 25 Zoom Rooms with issues in an acount.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Scope: dashboard_home:read:admin
: Heavy
Prerequisites:
- Business or a higher plan.
- Zoom Room must be enabled in the account.
dashboards.dashboardIssueZoomRoom
Get information on top 25 Zoom Rooms with issues in a month. The month specified with the "from" and "to" range should fall within the last six months.
Scope: dashboard_home:read:admin
: Heavy
Prerequisites:
- Business or a higher plan.
- Zoom Room must be enabled in the account.
dashboards.dashboardMeetingDetail
Get details on live or past meetings. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Scopes: dashboard_meetings:read:admin
: Heavy
Prerequisites:
- Business or a higher plan.
dashboards.dashboardMeetingParticipantQos

Retrieve the quality of service for participants from live or past meetings. This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.

Scopes: dashboard_meetings:read:admin
: Heavy
dashboards.dashboardMeetingParticipants

Get a list of participants from live or past meetings.

If you do not provide the type query parameter, the default value will be set to live and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for type.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Scopes: dashboard_meetings:read:admin
: Heavy
Prerequisites: Business or a higher plan.
dashboards.dashboardMeetingParticipantShare
Retrieve the sharing and recording details of participants from live or past meetings.
Scopes: dashboard_meetings:read:admin
: Heavy
Prerequisites:
- Business or a higher plan.
dashboards.dashboardMeetingParticipantsQos
Get a list of meeting participants from live or past meetings along with the quality of service they recieve during the meeting such as connection quality for sending/receiving video, audio, and shared content.
If you do not provide the type query parameter, the default value will be set to live and thus, you will only see metrics for participants in a live meeting, if any meeting is currently being conducted. To view metrics on past meeting participants, provide the appropriate value for type.

You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.

Scopes: dashboard_meetings:read:admin
: Heavy
Prerequisites:
- Business or a higher plan.
dashboards.dashboardMeetings
List total live or past meetings that occurred during a specified period of time. This overview will show if features such as audio, video, screen sharing, and recording were being used in the meeting. You can also see the license types of each user on your account.
You can specify a monthly date range for the dashboard data using the from and to query parameters. The month should fall within the last six months.
Scopes: dashboard_meetings:read:admin
: Resource-intensive

Prerequisites:
- Business or a higher plan.
dashboards.dashboardWebinarDetail
Retrieve details from live or past webinars.

Scopes: dashboard_webinars:read:admin
: Heavy
Prerequisites:
- Business, Education or API Plan with Webinar add-on.
dashboards.dashboardWebinarParticipantQos
Retrieve details on the quality of service that participants from live or past webinars recieved.
This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
Scopes: dashboard_webinars:read:admin
: Heavy
Prerequisites:
- Business, Education or API Plan with Zoom Rooms set up.
dashboards.dashboardWebinarParticipants
Retrieve details on participants from live or past webinars.

Scopes: dashboard_webinars:read:admin
: Heavy
Prerequisites:
- Business, Education or API Plan with Webinar add-on.
dashboards.dashboardWebinarParticipantShare
Retrieve the sharing and recording details of participants from live or past webinars.

Scopes: dashboard_webinars:read:admin
: Heavy
Prerequisites:
- Business, Education or API Plan with Webinar add-on.
dashboards.dashboardWebinarParticipantsQos
Retrieve a list of participants from live or past webinars and the quality of service they received.
This data indicates the connection quality for sending/receiving video, audio, and shared content. If nothing is being sent or received at that time, no information will be shown in the fields.
Scopes: dashboard_webinars:read:admin
: Heavy
Prerequisites:
- Business, Education or API Plan with Webinar add-on.
dashboards.dashboardWebinars
List all the live or past webinars from a specified period of time.

Scopes: dashboard_webinars:read:admin
: Resource-intensive
Prerequisites:
- Business, Education or API Plan with Webinar add-on.
dashboards.dashboardZoomRoom
The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room.
Use this API to retrieve information on a specific room.

Scopes: dashboard_zr:read:admin

: HeavyPrerequisites:
- Business, Education or API Plan with Zoom Rooms set up.
dashboards.dashboardZoomRoomIssue
Get top 25 issues of Zoom Rooms.
Scopes: dashboard_zr:read:admin
: Heavy
Prerequisites:
- Business, Education or API Plan with Zoom Rooms set up.
dashboards.dashboardZoomRooms
List information on all Zoom Rooms in an account.

Scopes: dashboard_zr:read:admin
: Resource-intensive
Prerequisites:
- Business, Education or API Plan with Zoom Rooms set up.
dashboards.getCallLogMetricsDetails
Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.
Use this API to list call log details of a specific call.
Prerequisites:
- Business, or Education account
- Zoom Phone license
Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Light
dashboards.getCallQoS
Get call quality of service(QoS) data for a call made or received by a Zoom phone user in the account.
Prerequisites:
- Business, or Education account
- Zoom Phone license
  
  Scopes: phone:read:admin, phone:write:admin
  Rate Limit Label: Light
dashboards.listCallLogsMetrics
Call logs provide a record of all incoming and outgoing calls over Zoom Phone in an account.
Use this API to list monthly call logs metrics. You can use query parameters to filter the response by date, site and MOS(Mean Opinion Score) of the call.
Prerequisites:
- Business, or Education account
- Zoom Phone license
Scopes: phone:read:admin, phone:write:admin
Rate Limit Label: Heavy
dashboards.listMeetingSatisfaction

If the option is enabled, attendees will be prompted with a survey window where they can tap either the Thumbs Up or Thumbs Down button that indicates their Zoom meeting experience. With this API, you can get information on the attendees' meeting satisfaction. Specify a monthly date range for the query using the from and to query parameters. The month should fall within the last six months.
To get information on the survey results with negative experiences (indicated by Thumbs Down), use the .
Scopes: dashboard:read:admin
: Heavy
dashboards.participantFeedback
When a meeting ends, each attendee will be prompted to share their meeting experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific meeting. Note that this API only works for meetings scheduled after December 20, 2020.
Prerequisites:
- setting must be enabled by the participant prior to the meeting.
- The user making the API request must be enrolled in a Business or a higher plan.
Scope: dashboard_meetings:read:admiin
: Heavy
dashboards.participantWebinarFeedback
When a Webinar ends, each attendee will be prompted to share their Webinar experience by clicking either thumbs up or thumbs down. Use this API to retrieve the feedback submitted for a specific webinar. Note that this API only works for meetings scheduled after December 20, 2020.
Prerequisites:
- setting must be enabled by the participant prior to the meeting.
- The user making the API request must be enrolled in a Business or a higher plan.
Scope: dashboard_webinars:read:admin
: Heavy
deprecatedApiEndpoints.listPastMeetingFiles

Note: This API has been deprecated and is no longer supported due to GCM encryption updates for security purposes. To learn about saving the in-meeting chat files via Zoom Client, refer to the guide.
List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time.

Scope: meeting:read, meeting:read:admin
: Medium
deprecatedApiEndpoints.listPastWebinarFiles

Note: This API has been deprecated and is no longer supported due to GCM encryption updates for security purposes.
List files sent via in-meeting chat during a meeting. The in-meeting files are deleted after 24 hours of the meeting completion time.

Scope: webinar:read, webinar:read:admin
: Medium
devices.deviceCreate

A H.323 or SIP device can make a video call to a to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account

Scopes: h323:write:admin
: Light
devices.deviceDelete

A H.323 or SIP device can make a video call to a to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.

Scopes: h323:write:admin
: Light
devices.deviceList

A H.323 or SIP device can make a video call to a to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.

Scopes: h323:read:admin
: Medium
devices.deviceUpdate

A H.323 or SIP device can make a video call to a to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.

Scopes: h323:write:admin

: Light
groups.delGroupVb
Delete existing virtual background file(s) from an account.
Prerequisites:
- Virtual background feature must be on the account.
Scope: group:write:admin

: Light
groups.getGroupLockSettings

Retrieve a locked settings. If you lock a setting, the group members will not be able to modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.
Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin
: Medium
groups.getGroupSettings

Get settings for a . Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin
: Medium
groups.getOperation

List under an account.
Prerequisite: Pro or higher account.
Scopes: group:read:admin
: Medium
groups.group

Get a under an account.
Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin
: Light
groups.groupCreate

Create a under an account.
You can add a maximum of 100 groups in one account per day. If you go over, you will get an error. You can add a maximum of 5000 groups in one account.
Prerequisite: Pro or higher account.
Scopes: group:write:admin
: Light
groups.groupDelete

Delete a .
Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin
: Light
groups.groupLockedSettings

Update a locked settings. If you lock a setting, the group members will not be able to modify it individually.

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.
Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin
: Medium
groups.groupMembers

List the members of a under your account.
Prerequisite: Pro, Business, or Education account
Scopes: group:read:admin
: Medium
groups.groupMembersCreate

Add members to a under your account.
Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin
: Medium
groups.groupMembersDelete

Delete a member from a in a Zoom account.
Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin
: Light
groups.groupUpdate

Update a under your account.
Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin
: Light
groups.updateAGroupMember
If a user is a member in multiple groups, you can for the user. The group member will use the primary group's settings by default. However, if settings are locked in other groups, those settings will continue to be locked for that user. By default, the primary group is the first group that user is added to.

Use this API to perform either of the following tasks:
- Simultaneously remove a member from one group and move the member to a different group.
- Set a primary group for the user
  
  Prerequisites:
- Pro or higher account
  Scopes: group:write:admin
: Medium
groups.updateGroupSettings

Update settings for a .

Note: The force_pmi_jbh_password field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.
Prerequisite: Pro, Business, or Education account
Scopes: group:write:admin
: Medium
groups.uploadGroupVb
Use this API to for all users in a group to use.
Prerequisites:
- Virtual background feature must be on the account.
Scope: group:write:admin

: Medium
`
imChat.imChatMessages

Retrieve IM chat messages for a specified period of time.
Note: This API only supports oauth2.

Scopes: imchat:read
: Medium
Please see our .
imChat.imChatSessions

Retrieve IM Chat sessions for a specified period of time.
Note: This API only supports Oauth2.
Scopes: imchat:read, imchat:read:admin
: Heavy
Please see our .
imChat.listimmessages

Get IM Chat messages for a specified period of time.
Note: This API only supports Oauth2.

Scopes: imchat:read
: Medium
Please see the
imChat.sendimmessages

Send chat message to a user.
Note: This API only supports OAuth 2.0.

Scope: imchat:write
: Medium
imGroups.getImGroups

List .

Scopes: imgroup:read:admin
: Medium
imGroups.imGroup

Retrieve an under your account.

Scopes: imgroup:read:admin
: Light
imGroups.imGroupCreate

Create an under your account.

Scopes: imgroup:write:admin
: Light
imGroups.imGroupDelete

Delete an under your account.

Scopes: imgroup:write:admin
: Light
imGroups.imGroupMembers

List the members of an .

Scope: imgroup:read:admin
: Medium
imGroups.imGroupMembersCreate

Add members to an under an account.

Scope: imgroup:write:admin
: Medium
imGroups.imGroupMembersDelete

Delete a member from an under an account.

Scopes: imgroup:write:admin
: Light
imGroups.imGroupUpdate

Update an under your account.

Scopes: imgroup:write:admin
: Light
meetings.createBatchPolls
Polls allow the meeting host to survey attendees. Use this API to create batch for a meeting.

Scopes: meeting:write:admin meeting:write
: Light
Prerequisites:
- Host user type must be Pro or higher plan.
- Polling feature must be enabled in the host's account.
- Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
meetings.getLiveStreamDetails
Zoom allows users to to a custom platform. Use this API to get a meeting's live stream configuration details such as Stream URL, Stream Key and Page URL.

Prerequisites:
- Meeting host must be a licensed user with a Pro or higher plan.
- Live streaming details must have been for the meeting.
  
  Scopes: meeting:read:admin meeting:read
  : Light
meetings.getUsers

List all the meetings that were scheduled for a user (meeting host). This API only supports scheduled meetings and thus, details on instant meetings are not returned via this API.

Scopes: meeting:read:admin meeting:read
: Medium
meetings.inMeetingRecordingControl
Use this API to control the recording features such as starting a recording, stopping a recording, pausing a recording, and resuming a recording. This API only works for Cloud Recordings and not for local recordings.
Prerequisite:
- The meeting must be a live meeting.
- Cloud Recording must be enabled.
- The user using this API must either be the host or alternative host of the meeting.
Scopes: meeting:write, meeting:write:admin, meeting:master
meetings.listMeetingTemplates

Use this API to list that are available to be used by a user.
Scope: meeting:read or meeting:read:admin
: Medium
meetings.listPastMeetingPolls
allow the meeting host to survey attendees. Use this API to list poll results of a meeting.

Scopes: meeting:read:admin, meeting:read
: Medium
Prerequisites:
- Host user type must be Pro.
- Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
meetings.meeting

Retrieve the details of a meeting.

Scopes: meeting:read:admin meeting:read
: Light
meetings.meetingCreate

for a user.
This API has a daily rate limit of 100 requests per day. Therefore, only 100 Create a Meeting API requests are permitted within a 24 hour window for a user.
The start_url of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the start_url field is two hours for all regular users.
For custCreate meeting hosts( i.e., users created using the custCreate option via the API), the expiration time of the start_url field is 90 days from the generation of the start_url.

For security reasons, the recommended way to retrieve the updated value for the start_url field programmatically (after expiry) is by calling the and referring to the value of the start_url field in the response.

Scopes: meeting:write:admin meeting:write
: Medium
meetings.meetingDelete

Delete a meeting.

Scopes: meeting:write:admin meeting:write
: Light
meetings.meetingInvitation

Retrieve the meeting invite note that was sent for a specific meeting.

Scopes: meeting:read:admin meeting:read
: Light
meetings.meetingLiveStreamStatusUpdate
Zoom allows users to to a custom platform. Use this API to update the status of a meeting's live stream.

Prerequisites:
- Meeting host must have a Pro license.
  Scopes: meeting:write:admin meeting:write
  : Light
meetings.meetingLiveStreamUpdate
Zoom allows users to to a custom platform. Use this API to update a meeting's live stream information.

Prerequisites:
- Meeting host must have a Pro license.
  Scopes: meeting:write:admin meeting:write
  : Light
meetings.meetingPollCreate
Polls allow the meeting host to survey attendees. Use this API to create a for a meeting.

Scopes: meeting:write:admin meeting:write
: Light
Prerequisites:
- Host user type must be Pro or higher plan.
- Polling feature must be enabled in the host's account.
- Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
meetings.meetingPollDelete
Polls allow the meeting host to survey attendees. Use this API to delete a meeting .
Scopes: meeting:write:admin meeting:write
: Light
Prerequisites:
- Host user type must be Pro.
- Polling feature should be enabled in the host's account.
- Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
meetings.meetingPollGet

Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting .

Scopes: meeting:read:admin meeting:read
: Light
meetings.meetingPolls
Polls allow the meeting host to survey attendees. Use this API to list of a meeting.

Scopes: meeting:read:admin meeting:read
: Light
Prerequisites:
- Host user type must be Pro or higher plan.
- Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
meetings.meetingPollUpdate

Polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting

Scopes: meeting:write:admin meeting:write
: Light
meetings.meetingRegistrantCreate
Register a participant for a meeting.

Note that there is a maximum limit of 4999 registrants per meeting and users will see an error if the capacity has reached.
Prerequisite:
- Host user type must be "Licensed".
Scopes: meeting:write:admin meeting:write : Light
meetings.meetingregistrantdelete

Delete a meeting registrant.

Scopes: meeting:write:admin meeting:write

: Light
meetings.meetingRegistrantQuestionUpdate

Update registration questions that will be displayed to users while .

Scopes: meeting:write, meeting:write:admin
: Light
meetings.meetingRegistrants

A host or a user with admin permission can require . Use this API to list users that have registered for a meeting.

Scopes: meeting:read:admin meeting:read
: Medium
meetings.meetingRegistrantsQuestionsGet

List registration questions that will be displayed to users while .
Scopes: meeting:read, meeting:read:admin
: Light
meetings.meetingRegistrantStatus

Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.

Scopes: meeting:write:admin meeting:write : Medium
meetings.meetingStatus

Update the status of a meeting.

Scopes: meeting:write:admin meeting:write : Light
meetings.meetingUpdate

Update the details of a meeting.
This API has a rate limit of 100 requests per day. Therefore, a meeting can only be updated for a maximum of 100 times within a 24 hour window.
Scopes: meeting:write:admin meeting:write
: Light
meetings.pastMeetingDetails

Get details on a past meeting.

Scopes: meeting:read:admin meeting:read
: Light

Note: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.
meetings.pastMeetingParticipants
Retrieve information on participants from a past meeting.

Scopes: meeting:read:admin meeting:read
: Medium Prerequisites:
- Paid account on a Pro or higher plan.
Note: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.
meetings.pastMeetings

Get a list of ended meeting instances

Scopes: meeting:read:admin meeting:read
: Medium
pac.userPaCs
(PAC) allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.
Use this API to list a user's PAC accounts.

Scopes: pac:read:admin pac:read

: Light
Prerequisites:
- A Pro or higher plan with add-on.
- Personal Audio Conference must be enabled in the user's profile.
phone.accountCallLogs
Retrieve for an account.
Scopes: phone:read:admin
: Heavy
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
3. Account Owner and a with Zoom Phone Management
phone.addByocNumber
Use this API to add BYOC phone numbers(provided to you by your carrier) to Zoom.
Scope: phone:write:admin or phone:write or phone:master
Prerequisites:
- The account must hold a business or enterprise plan and Zoom Phone license.
: Light
phone.addSettingTemplate
This API lets you create a Zoom Phone setting template for an account. Template type includes User, Auto Receptionist, or Call Queue. Settings include profile, policy and user settings. After creating a phone template, the settings defined via this request will become the default settings for an account.

Scope:
- phone:write:admin phone:write
Prerequisites:
1. Business or enterprise Zoom account
2. A Zoom Phone license
: Light
phone.addUserSetting

Phone users can access in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to define the voicemail access permissions of a user.
To view these settings in the Zoom web portal, navigate to Admin >Phone System Management> Users & Rooms. Click the Users tab and select User Settings. Scroll down to Voicemail & Call Recordings.
Scope:phone:write:admin

: Light
Prerequisites:
Business or Enterprise Account
phone.assignCallingPlan
Assign to a user.
Scopes: phone:write phone:write:admin
: Light
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.assignPhoneNumber
Assign a to a user who has already enabled Zoom Phone.
Scopes: phone:write phone:write:admin
: Light
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.changeMainCompanyNumber
The can be used by external callers to reach your phone users (by dialing the main company number and the user's extension). It can also be used by phone users in your account as their caller ID while making calls.

Use this API to of an account.

Prerequisites:
- Pro or higher account plan.
- Account owner or admin permissions
  Scopes: phone:write:admin
: Light
phone.deleteCallLog
Delete a user's .
Scopes: phone:write, phone:write:admin
: Light
Prerequisites:
1. User must belong to a Business or an Enterprise account.
2. User must hold a Zoom Phone license.
phone.deleteUserSetting
Remove the shared voicemail access settings that were previously assigned to a user.
To view these settings in your Zoom web portal, navigate to Admin >Phone System Management> Users & Rooms. Click the Users tab and select User Settings. Scroll down to Voicemail & Call Recordings.
Scope: phone:write:admin

Prerequisites:
- Business or enterprise Account
: Light
phone.deleteVoicemail
Delete a from a Zoom account.
Scope: phone:write:admin or phone:write
Prerequisite:
- The account must have activted Zoom Phone license.
: Light
phone.getPhoneNumberDetails
A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to get details on a specific Phone number in a Zoom account.

Prerequisites:
- Pro or higher plan with Zoom phone license
  Scope: phone:read:admin
: Light
phone.getPhoneRecordings
List of an account.
Scopes:
- phone:read:admin phone:write:admin
Prerequisties:
- Pro or higher account with Zoom Phone license.
- Account owner or admin privileges.
phone.getSettingTemplate
This API lets you retrieve a specific account phone template previously created.
Scope:
- phone:write:admin or phone:write
Prerequisites:
1. Business or Enterprise Account
2. A Zoom Phone license
: Light
phone.listAccountPhoneNumbers
A Zoom account owner or admin can purchase phone numbers and assign them to Zoom phone users. Use this API to list all Zoom Phone numbers in a Zoom account. You can filter the response based on your needs by using query parameters.
Prerequisites:
- Pro or higher plan with Zoom phone license
  Scope: phone:read:admin
  : Medium
phone.listByocsipTrunk
List that are assigned to an account.
Scopes:
- phone:write:admin or phone:master
Prerequisites:
- Business or Enterprise Account
: Light
phone.listCallingPlans
List all Zoom Phone that are enabled for a Zoom account.

Prerequisites:
- Pro or a higher account with Zoom phone license.
  Scope: phone:read:admin
  : Medium
phone.listPhoneUsers
List all the users on an account who have been assigned Zoom Phone licenses.

Prerequisites:
- Pro or higher plan with Zoom phone license
  Scope: phone:read:admin
  : Light
phone.listSettingTemplates
This API lets you retrieve a list of all the phone template settings previously created.
Scope:
- phone:read:admin or phone:read
Prerequisites:
1. Business or enterprise Account
2. A Zoom Phone license
: Light
phone.phoneUser
Retrieve a user's profile.
Scopes: phone:read, phone:read:admin
: Light
Prerequisites :
1. Business or Enterprise account
2. A Zoom Phone license
phone.phoneUserCallLogs
Retrieve a user's call logs.
Scopes: phone:read, phone:read:admin
: Heavy
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.phoneUserRecordings
Retrieve a user's zoom . Scopes: phone:read, phone:read:admin
: Medium
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.phoneUserSettings
Retrieve a user's zoom phone profile .
Scopes: phone:read, phone:read:admin
: Light
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.phoneUserVoiceMails
Retrieve a user's Zoom Phone voicemails.
Scopes: phone:read, phone:read:admin
: Medium
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.postPhoneSipTrunk
Using this API, a owner can assign SIP trunk(s) to a sub account.
Scope:
- phone:master
Prerequisites:
- Business or enterprise Account.
: Light
phone.setUpAccount
After assigning a Zoom phone license to an account, an admin or account owner can proceed with the using this API.
Scope:
- phone:write:admin phone:write
Prerequisites:
- Pro or a higher paid account with master account option enabled.
: Light
phone.unassignCallingPlan
Unassign a that was previously assigned to a user.
Scopes: phone:write phone:write:admin
: Light
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.unassignPhoneNumber
Unassign of a Zoom phone user.
After assigning a phone number, you can remove it if you don't want it to be assigned to anyone.
Scopes: phone:write phone:write:admin
: Light
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
3. User must have been previously assigned a Zoom Phone number.
phone.updatePhoneNumberDetails
Update phone number details.
Scopes:
- phone:write phone:write:admin
- phone:master
Prerequisite:
- Paid account
: Light
phone.updatePhoneSettings
Only can use this API to enable BYOC(Bring your own carrier) option for a sub account.
Scope:
- phone:master
Prerequisites:
- Business or enterprise Account.
phone.updatePhoneSipTrunk
Update details of a SIP trunk that is assigned to a sub account.
Scope:
- phone:master
Prerequisites:
Business or Enterprise Account.

: Light
phone.updateSettingTemplate
Use this API to update or modify profile settings for the phone template. Template type includes User, Auto Receptionist, or Call Queue. After you've modified a template, click User Settings to set up settings for Call Handling, Desk Phone, and Others.
Scope:
- phone:write:admin or phone:write
Prerequisites:
1. Business or Enterprise Account
2. A Zoom Phone license
: Light
phone.updateUserProfile
Update a user's profile.
Scopes: phone:write phone:write:admin
: Light
Prerequisite:
1. Business or Enterprise account
2. A Zoom Phone license
phone.updateUserSetting

Phone users can access in the Zoom desktop client, web portal, or provisioned desk phone. Use this API to update the voicemail access permissions of a user.
To view these settings in the Zoom web portal, navigate to Admin >Phone System Management> Users & Rooms. Click the Users tab and select User Settings. Scroll down to Voicemail & Call Recordings.
Scope:
phone:write:admin

: Light
Prerequisites:
Business or Enterprise Account
phoneAutoReceptionists.addAutoReceptionist
Auto receptionists answer calls with a personalized recording and routes calls to a phone user, call queue, common area phone, voicemail or an IVR system. Use this API to add an to a Zoom Phone.
Prerequisites:
- Pro or higher account with Zoom Phone license.
  Scopes: phone:write:admin
  : Light
phoneAutoReceptionists.assignPhoneNumbersAutoReceptionist
Assign available phone numbers to an . The available numbers can be retrieved using the List Phone Numbers API with type query parameter set to "unassigned".
Prerequisites:
- Pro or higher account plan with Zoom Phone License
- Account owner or admin permissions
  Scopes: phone:write:admin
: Light
phoneAutoReceptionists.unassignAllPhoneNumsAutoReceptionist
Unassign all phone numbers that were previously assigned to an .
Prerequisites:
- Pro or higher account plan with Zoom Phone License
- Account owner or admin permissions
  Scopes: phone:write:admin
: Light
phoneAutoReceptionists.unassignAPhoneNumAutoReceptionist
Unassign a specific phone number that was previously assigned to an .
Prerequisites:
- Pro or higher account plan with Zoom Phone License
- Account owner or admin permissions
  Scopes: phone:write:admin
: Light
phoneAutoReceptionists.updateAutoReceptionist
An auto receptionist answers calls with a personalized recording and routes calls to a phone user, call queue, common area phone, or voicemail. An auto receptionist can also be set up so that it routes calls to an interactive voice response (IVR) system to allow callers to select the routing options.
Use this API to such as display name and extension number assigned to the main auto receptionist.

Prerequisites:
- Pro or higher account with Zoom Phone license.
  Scopes: phone:write:admin
: Light
phoneBlockedList.addAnumberToBlockedList
A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to create a blocked list and add a number to that blocked list.
Prerequisites:
- Pro or higher account plan with Zoom phone license
  Scope: phone:write:admin
: Light
phoneBlockedList.deleteABlockedList
A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers).
Use this API to delete a blocked list and therefore removing the associated number from the blocked list. The number will be unblocked after the deletion.
Prerequisites:
- Pro or higher account plan with Zoom phone license
  Scope: phone:write:admin
: Light
phoneBlockedList.getABlockedList
A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to get information about a specific blocked list.
Prerequisites:
- Pro or higher account plan with Zoom phone license
  Scope: phone:read:admin
: Light
phoneBlockedList.listBlockedList
A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to list all the blocked lists in an acccount.
Prerequisites:
- Pro or higher account plan with Zoom phone license
  Scope: phone:read:admin
: Medium
phoneBlockedList.updateBlockedList
A Zoom account owner or a user with admin privilege can block phone numbers for phone users in an account. Blocked numbers can be inbound (numbers will be blocked from calling in) and outbound (phone users in your account won't be able to dial those numbers). Blocked callers will hear a generic message stating that the person they are calling is not available.
Use this API to update information on the blocked list.
Prerequisites:
- Pro or higher account plan with Zoom phone license
  Scope: phone:write:admin
  : Light
phoneCallQueues.addMembersToCallQueue
Add phone users and/or as members to a specific Call Queue.

Prerequisites:
- Pro or higher account plan.
- Zoom Phone license
  Scopes: phone:write:admin
: Light
phoneCallQueues.assignPhoneToCallQueue
After , you can assign it, allowing callers to directly dial a number to reach a .

Prerequisites:
- Pro or higher account plan.
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:write:admin
  : Light
phoneCallQueues.changeCallQueueManager
A call queue manager has the privileges to maanage the call queue's voicemail inbox and recordings, change all call queue settings and call queue policy settings.

Use this API to to set another phone user as the . Prerequisites:
- Pro or higher account plan.
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:write:admin
: Light
phoneCallQueues.createCallQueue
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to .
You can add phone users or common area phones to call queues.
Prerequisites:
- Pro, Business, or Education account
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:write:admin
: Light
phoneCallQueues.deleteACallQueue
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to delete a Call Queue.
Prerequisites:
- Pro, Business, or Education account
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:write:admin
: Light
phoneCallQueues.getACallQueue
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to get information on a specific Call Queue.

Prerequisites:
- Pro, Business, or Education account
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:read:admin
: Light
phoneCallQueues.getCallQueueRecordings
Use this API to view from the call queue.

Prerequisites:
- Pro or higher account with Zoom Phone license.
- must be enabled in the Policy Settings for call queues.
  Scope: phone:read:admin
  : Medium
phoneCallQueues.listCallQueues
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to list Call queues.

Prerequisites:
- Pro, Business, or Education account
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:read:admin
: Medium
phoneCallQueues.unassignAllMembers
Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or . Prerequisites:
- Pro or higher account plan.
- Zoom Phone license
  Scopes: phone:write:admin
: Light
phoneCallQueues.unassignAPhoneNumCallQueue
Use this API to unbind all phone numbers that are assigned to a After successful unbinding, the numbers will appear in the .
If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead.
Prerequisites:
- Pro or higher account palan
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:write:admin
  : Light
phoneCallQueues.unassignMemberFromCallQueue
Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a . A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. Prerequisites:
- Pro or higher account plan.
- Zoom Phone license
  Scopes: phone:write:admin
  : Light
phoneCallQueues.unAssignPhoneNumCallQueue
After assigning a phone number, you can unbind it if you don't want it to be assigned to a . Use this API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear in the .

Prerequisites:
- Pro or higher account palan
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:write:admin
  : Light
phoneCallQueues.updateCallQueue
Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to update information of a specific Call Queue.
Prerequisites:
- Pro, Business, or Education account
- Account owner or admin permissions
- Zoom Phone license
  Scopes: phone:write:admin
: Light
phoneDevices.addPhoneDevice
By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to to a user.
Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
- Scopes: phone:write:admin
: Light
phoneDevices.deleteADevice
Remove a from the Zoom Phone System Management.

Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
- Device must not have been assigned to a user.
  Scopes: phone:write:admin
: Light
phoneDevices.getADevice
Get detailed information about a specific .

Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
  Scopes: phone:write:admin
: Light
phoneDevices.listPhoneDevices
List all the that are configured with Zoom Phone on an account. To view devices that have not yet been assigned to a user, set the value of the type query parameter as unassigned and to view devices that have been assigned, set the value as assigned.

Scopes: phone:read:admin
Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
: Medium
phoneDevices.updateADevice
Update information of a .

Prerequisites:
- Pro or a higher account with Zoom Phone license
- Account owner or admin permissions
  Scopes: phone:write:admin
: Light
phoneReports.getPsOperationLogs
The Phone System operation logs report allows account owners and admins to view monthly Zoom phone related admin operation details.
Use this API to retrieve the Phone System Operation Logs Report. Account owners and admins can also access this information by logging into their Zoom accounts and navigating to .

Scopes: phone:read:admin, phone:write:admin
: Heavy

Prerequisites:
- Account must be enrollled in Pro or a higher plan
- Account must be enrolled in a plan
phoneSharedLineGroups.addMembersToSharedLineGroup
A allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to to a Shared Line Group. Note that a member can only be added to one shared line group.
Prerequisties:
- Pro or higher account with Zoom Phone license.
- A valid Shared Line Group
- Account owner or admin privileges
Scopes: phone:write:admin
: Light
phoneSharedLineGroups.assignPhoneNumbersSlg
Use this API to assign phone numbers to a shared line groups. These direct phone numbers will be shared among members of the . Prerequisties:
- Pro or higher account with Zoom Phone license.
- A valid Shared Line Group
- Account owner or admin privileges
Scopes: phone:write:admin : Light
phoneSharedLineGroups.createASharedLineGroup
A allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to create a shared line group.
Prerequisties:
- Pro or higher account with Zoom Phone license.
- Account owner or admin privileges
Scopes: phone:write:admin
: Light
phoneSharedLineGroups.deleteAMemberSlg
Members of the have access to the group's phone number and voicemail. Use this API to unassign a specific member from a Shared Line Group. Prerequisties:
- Pro or higher account with Zoom Phone license.
- A valid Shared Line Group
- Account owner or admin privileges
Scopes: phone:write:admin
: Light
phoneSharedLineGroups.deleteAPhoneNumberSlg
Use this API to unassign a specific phone number that was assigned to the . Prerequisties:
- Pro or higher account with Zoom Phone license.
- A valid Shared Line Group
- Account owner or admin privileges
Scopes: phone:write:admin : Light
phoneSharedLineGroups.deleteASharedLineGroup
A allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. Use this API to delete a Shared Line Group. Prerequisties:
- Pro or higher account with Zoom Phone license.
- Account owner or admin privileges
Scopes: phone:write:admin
: Light
phoneSharedLineGroups.deleteMembersOfSlg
Members of the have access to the group's phone number and voicemail. Use this API to unassign all the existing members from a Shared Line Group. Prerequisties:
- Pro or higher account with Zoom Phone license.
- A valid Shared Line Group
- Account owner or admin privileges
Scopes: phone:write:admin
: Light
phoneSharedLineGroups.getASharedLineGroup
A allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups.
Prerequisties:
- Pro or higher account with Zoom Phone license.
- Account owner or admin privileges
Scopes: phone:read:admin or phone:write:admin
: Light
phoneSharedLineGroups.listSharedLineGroups
A allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups.
Prerequisties:
- Pro or higher account with Zoom Phone license.
- Account owner or admin privileges
Scopes: phone:read:admin, phone:write:admin
: Medium
phoneSharedLineGroups.updateASharedLineGroup
A allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to update information of a Shared Line Group. Prerequisties:
- Pro or higher account with Zoom Phone license.
- Account owner or admin privileges
Scopes: phone:write:admin
: Light
phoneSite.createPhoneSite
Sites allow you to organize Zoom Phone users in your organization. Use this API to create a .
Prerequisites:
- Multiple Sites must be .
- Pro or a higher account with Zoom Phone enabled. Scope: phone:write:admin
: Light
phoneSite.deletePhoneSite
Sites allow you to organize Zoom Phone users in your organization. Use this API to delete a specific in a Zoom account. To delete a site, in the query parameter, you must provide the Site ID of another site where the assets of current site (users, numbers and phones) can be transferred to. You cannot use this API to delete the main site.
Prerequisites:
- Account must have a Pro or a higher plan with Zoom Phone license.
- must be enabled.
  Scope: phone:write:admin
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
phoneSite.getASite
Sites allow you to organize Zoom Phone users in your organization. Use this API to get information about a specific .
Prerequisites:
- Account must have a Pro or a higher plan with Zoom Phone license.
- Multiple Sites must be .
  Scope: phone:read:admin
  : Light
phoneSite.listPhoneSites
Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the that have been created for an account.
Prerequisites:
- Multiple Sites must be .
- Pro or a higher account with Zoom Phone enabled.
Scope: phone:read:admin
: Medium
phoneSite.updateSiteDetails
Sites allow you to organize Zoom Phone users in your organization. Use this API to update information about a specific .
Prerequisites:
- Account must have a Pro or a higher plan with Zoom Phone license.
- Scope: phone:write:admin
  : Light
reports.reportCloudRecording
Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day ealier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.
Prerequisites
- Pro or higher plan.
  Scopes: report:read:admin
: Heavy
reports.reportDaily
Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes.
Prerequisites
- Pro or higher plan.
  Scopes: report:read:admin
: Heavy
reports.reportMeetingDetails
Get a detailed report for a past meeting.
Scopes: report:read:admin

: Heavy
Prerequisites:
- Pro or a higher plan.
reports.reportMeetingParticipants
Get participant report for a past meeting.

Scopes: report:read:admin

: Heavy
Prerequisites:
- Pro or a higher plan.
reports.reportMeetingPolls
Retrieve a report of results for a past meeting.

Scopes: report:read:admin

: Heavy
Prerequisites:
- Pro or a higher plan.
reports.reportMeetings
Retrieve on a past meeting for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months.
Meetings will only be returned in the response if the meeting has two or more unique participants.

Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or higher plan.
reports.reportOperationLogs
The report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings.
Use this API to retrieve operation logs report for a specified period of time.
Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or higher plan.
reports.reportSignInSignOutActivities
Retrieve a list of sign in / sign out activity logs of users under a Zoom account.
Prerequisites
- Pro or higher plan.
  Scopes: report:read:admin
: Heavy
reports.reportTelephone
The allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time.
Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or higher plan.
reports.reportUsers
A user is considered to be an active host during the month specified in the "from" and "to" range, if the user has hosted at least one meeting during this period. If the user didn't host any meetings during this period, the user is considered to be inactive.
The Active Hosts report displays a list of meetings, participants, and meeting minutes for a specific time range, up to one month. The month should fall within the last six months.
The Inactive Hosts report pulls a list of users who were not active during a specific period of time. Use this API to retrieve an active or inactive host report for a specified period of time. The time range for the report is limited to a month and the month should fall under the past six months.
You can specify the type of report and date range using the query parameters.
Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or higher plan.
reports.reportWebinarDetails
Retrieve a containing past webinar details.

Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or higher plan with Webinar add-on.
reports.reportWebinarParticipants
Get detailed report on each attendee of a webinar.

Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or a higher plan with Webinar add-on enabled.
reports.reportWebinarPolls
Retrieve a report on past .

Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or a higher plan with Webinar add-on enabled.
reports.reportWebinarQa
The Question & Answer (Q&A) feature for webinars allows attendees to ask questions during the webinar and for the panelists, co-hosts and host to answer their questions.
Use this API to retrieve a report on question and answers from past webinars.

Scopes: report:read:admin
: Heavy
Prerequisites:
- Pro or a higher plan with Webinar add-on enabled.
roles.addRoleMembers
User can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to to members.
Scopes: role:write:admin
: Medium
Prerequisites:
- A Pro or a higher plan.
roles.createRole
Each Zoom user automatically has a role which can either be owner, administrator, or a member.
Pre-requisite:
- Pro or higher plan.
- For setting the initial role, you must be the Account Owner.
- For subsequent role management, you must be the Account Owner or user with role management permissions.
  Scopes: role:write:admin
: Light
roles.deleteRole
Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.
Use this API to delete a role.
Pre-requisite:
- A Pro or higher plan.
- For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes: role:write:admin
: Light
roles.getOperation
List on your account
Scopes: role:read:admin
: Medium
Prerequisites :
- Pro or higher plan.
- For setting the initial role, you must be the Account Owner.
- For subsequent role management, you must be the Account Owner or user with role management permissions.
roles.getRoleInformation
Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges.
Use this API to get information including specific privileges assigned to a .
Pre-requisite:
- A Pro or higher plan.
- For role management and updates, you must be the Account Owner or user with role management permissions.
Scopes: role:read:admin
: Light
roles.roleMemberDelete
User can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role.
Scope: role:write:admin
: Light
Prerequisites:
- A Pro or a higher plan.
roles.roleMembers
User can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role.
Scope: role:read:admin
: Medium
Prerequisites:
- A Pro or a higher plan.
roles.updateRole
Each Zoom user automatically has a which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.
Use this API to change the privileges, name and description of a specific role.
Pre-requisite:
- A Pro or higher plan.
- For role management and updates, you must be the Account Owner or user with role management permissions.
  Scopes: role:write:admin
: Light
rooms.addARoom
Use this API to to a Zoom account.

Prerequisites:
- Pro or a higher plan with license.
  Scopes: room:write:admin
  : Medium
rooms.changeZrLocation
An account owner of a Zoom account can establish a to better organize Zoom Rooms spread accress various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. Use this API to assign a new location for a Zoom Room. Note that the Zoom Room can be assigned only to the lowest level location available in the hierarchy. Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
  Scopes: room:write:admin
  : Light
rooms.checkInRooms
The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either check in and confirm that you are utilizing the room reservation or to check out of the room so that the room gets released from the scheduled meeting and will be made available for others to use. Learn more from the guide.
Prerequisites:
- must have been set up for use for the account and must be online.
- You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room.
Scope: room:write:admin
rooms.deleteAZoomRoom
a specific Zoom Room profile from a Zoom account.

Prerequisites:
- Pro or a higher plan with license.
  Scopes: room:write:admin
  : Light
rooms.getZrProfile
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account.
Prerequisites:
- Pro or a higher plan with license.
  Scopes: room:read:admin
  : Medium
rooms.getZrSettings
Get information on meeting or alert settings applied to a specific Zoom Room. By default, only Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
  Scopes: room:read:admin
: Medium
rooms.listDigitalSignageContent
List information about existing content in a Zoom account.
You can also access this information by logging into your Zoom account in the Zoom web portal and visiting the page listed under Room Management.
Prerequisites:
- Pro or a higher account with Zoom Rooms.
- Existing content files or folder in page.
rooms.listZoomRooms
Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing in a Zoom account.

Prerequisites:
- Pro or a higher plan with license.
  Scopes: room:read:admin
  : Medium
rooms.listZrDevices
List information about the devices that are being used for a specific in an account.
Prerequisites:
- Pro or a higher plan with license.
- Account owner or admin permissions. Scopes: room:read:admin
  : Medium
rooms.manageE911signage
Display or hide E911 emergency alert text content from .
Scope: room:write:admin
Prerequisites:
- 5.3.0 or higher
- Zoom Rooms digital signage must be
rooms.updateRoomProfile
Update basic information on a specific Zoom Room in a Zoom account.
Prerequisites:
- Pro or a higher plan with license.
  Scopes: room:write:admin
  : Medium
rooms.updateZrSettings
Update either meeting or alert settings applied to a specific Zoom Room. To update Alert Settings, specify alert as the value of the setting_type query parameter. To update Meeting Settings, specify meeting as the value of the setting_type query parameter.
Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
  Scopes: room:write:admin
  : Medium
roomsAccount.getZrAccountProfile
Get details on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To get information on an individual Room Profile, use instead.
Prerequisites:
- Zoom account owner or Zoom Rooms admin permissions
Scopes: room:read:admin
: Medium
roomsAccount.getZrAccountSettings
Get details on Account Settings of a Zoom Room. With this API, you can view either the Account Meeting Settings or the Alert Settings (Client Alert Settings and Notfication Settings) of the Zoom Rooms account. By default, only Account Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter.

Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
  Scopes: room:read:admin
: Medium
roomsAccount.updateZoomRoomAccSettings
Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the Account Meeting Settings or the Alert Settings (Client Alert Settings and Notfication Settings) of the Zoom Rooms account by specifying the required setting type in the setting_type parameter. To update only Alert Settings, specify alert as the value of the setting_type query parameter and to update only Account Meeting Settings, specify meeting as the value of the setting_type query parameter.

Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
  Scopes: room:write:admin
  
  : Medium
roomsAccount.updateZrAccProfile
Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual Room Profile, use instead.
Prerequisites:
- Zoom account owner or Zoom Rooms admin permissions
Scopes: room:write:admin
: Medium
roomsDevices.changeZoomRoomsAppVersion
or the version of Zoom Rooms App installed in your Mac or Windows device.
Prerequisites:
- Pro or a higher account with Zoom Rooms.
- Zoom Rooms software must be installed either on a Mac or a Windows device. This API does not support other devices.
roomsLocation.addAzrLocation
Add a location to the of Zoom Rooms in an account.
Prerequisites:
- Account owner or admin permissions.
- Zoom Rooms Version 4.0 or higher
  
  Scopes: room:write:admin
: Light
roomsLocation.changeParentLocation
An account owner of a Zoom account can establish a to better organize Zoom Rooms spread accross various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location.

For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of parent_location_id in the request body.

Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
  Scopes: room:write:admin
  
  : Medium
roomsLocation.getZrLocationProfile
Each location type of the has a profile page that includes information such as name of the location, address, support email, etc. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located.
Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
  Scopes: room:read:admin
: Medium
roomsLocation.getZrLocationSettings
Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter.

Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
  Scopes: room:read:admin
  : Medium
roomsLocation.getZrLocationStructure
Get the applied on the Zoom Rooms in an account.

Prerequisites:
- Zoom Rooms version 4.0 or higher
- Account owner or admin permissions
  Scopes: room:read:admin
  : Light
roomsLocation.listZrLocations
A Zoom account owner or a Zoom Room administrator can establish a to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.

Prerequisites:
- Account owner or admin permissions.
- Zoom Rooms Version 4.0 or higher
  
  Scopes: room:read:admin
: Medium
roomsLocation.updateZoomRoomsLocationStructure
Update the applied on the Zoom Rooms in an account.

Prerequisites:
- Zoom Rooms version 4.0 or higher
- Account owner or admin permissions
  Scopes: room:write:admin
  : Medium
roomsLocation.updateZrLocationProfile
Each location type of the has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located.
Prerequisite:
- Account owner or admin permission
- Zoom Rooms version 4.0 or higher
  Scopes: room:write:admin
: Medium
roomsLocation.updateZrLocationSettings
Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update Alert Settings, specify alert as the value of the setting_type query parameter. Similarly, to update Meeting Settings, specify meeting as the value of the setting_type query parameter.

Prerequisites:
- Zoom Room licenses
- Owner or Admin privileges on the Zoom Account.
  Scopes: room:write:admin
  : Medium
sipConnectedAudio.addCalloutCountries
Specify the list of countries for a master account or a sub account. To add call-out enabled countries to a sub account, provide the account ID of the sub account in the accountId path parameter. To add call-out enabled countries to a master account, provide me as the value of the accountId path parameter.
Prerequisites:
- The account making this API request must be a with SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.addInternalNumbers
This API allows a master account with SIP Connected Audio plan to assign internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) to a master account or a sub account.

To add internal numbers to a sub account, provide the account ID of the sub account in the accountId path parameter. To add internal numbers to a master account, provide me as the value of the accountId path parameter.
Prerequisites:
- The account making this API request must be a with SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.assignSipConfig
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

Using this API, a master account owner can copy the SIP Connected Audio configurations applied on the master account and enable those configurations on a sub account. The owner can also disable the configuration in the sub account where it was previously enabled. Prerequisites:
- Pro or a higher account with SIP Connected Audio plan enabled.
- master account Owner
  Scopes: sip_trunk:master
: Light
sipConnectedAudio.assignSipTrunkNumbers
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to assign internal numbers to a sub account.
Prerequisites:
- Pro or a higher account with SIP Connected Audio plan enabled.
- The account must be a master account
  Scopes: sip_trunk:master
  : Light
sipConnectedAudio.assignSipTrunks
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers’ IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to assign SIP trunk(s) that are available on a master account to a sub account.
Prerequisites:
- The account making this API request must be a master account with and SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.deleteAllSipNumbers
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to delete all internal numbers assigned to a sub account. Prerequisites:
- Pro or a higher account with SIP Connected Audio plan enabled.
- The account must be a master account
  Scopes: sip_trunk:master
  : Light
sipConnectedAudio.deleteInternalCallOutCountry
Delete a previously assigned country from a master account or a sub account. To remove call-out country from a sub account, provide the account ID of the sub account in the accountId path parameter. To remove call-out country from a master account, provide me as the value of the accountId path parameter.
Prerequisites:
- The account making this API request must be a with SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.deleteInternalNumber
This API allows a master account with SIP Connected Audio plan to delete a previously assigned internal phone number from a master account or a sub account.

To delete an internal number from a sub account, provide the account ID of the sub account in the accountId path parameter. To delete an internal number from a master account, provide me as the value of the accountId path parameter.
Prerequisites:
- The account making this API request must be a with SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.deleteSipTrunk
Use this API to remove existing SIP trunk of a sub account.

Prerequisites:
- The account making this API request must be a master account with and SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.listInternalCalloutCountries
Retrieve the list of internal countries of a master account or a sub account. To list call-out enabled countries of a sub account, provide the account ID of the sub account in the accountId path parameter. To list call-out enabled countries of a master account, provide me as the value of the accountId path parameter.
Prerequisites:
- The account making this API request must be a with SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.listInternalNumbers
This API allows a master account with SIP Connected Audio plan to list internal phone numbers (i.e., numbers that are not provided by Zoom but are owned by the organization consuming the API) assigned to a master account or a sub account.

To list internal numbers of a sub account, provide the account ID of the sub account in the accountId path parameter. To list internal numbers of a master account, provide me as the value of the accountId path parameter.
Prerequisites:
- The account making this API request must be a with SIP Connected Audio Plan.
  
  Scope: sip_trunk:master
sipConnectedAudio.listSipTrunkNumbers
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to list all the numbers that are configured for SIP Connected Audio in a Zoom Account.
Prerequisites:
- Pro or a higher account with SIP Connected Audio plan enabled.
- The account must be a master account
  Scopes: sip_trunk:master
: Light
sipConnectedAudio.listSipTrunks
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers’ IP telephony network, will be connected over this trunk rather than over the PSTN.

Use this API to list all the SIP trunks assigned to a master account or a sub account of the master account. To retrieve SIP trunks assigned to a sub account, provide the account ID of the sub account in the accountId path parameter. To retrieve SIP trunks of a master account, provide me as the value of the accountId path parameter.

Scope: sip_trunk:read:admin
Prerequisites:
- The account must either be a master account or a sub account with and SIP Connected Audio Plan.
sipPhone.createSipPhone
Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to enable a user to use SIP phone.

Prerequisites:
- Currently only supported on Cisco and Avaya PBX systems.
- The account owner or account admin must first enable SIP Phone Integration by contacting the team.
  Scope: sip_phone:write:admin
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
sipPhone.deleteSipPhone
Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to delete a specific SIP phone on a Zoom account.

Prerequisites:
- Currently only supported on Cisco and Avaya PBX systems.
- User must enable SIP Phone Integration by contacting the team.
  Scope: sip_phone:read:admin
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
sipPhone.listSipPhones
Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account.

Prerequisites:
- Currently only supported on Cisco and Avaya PBX systems.
- User must enable SIP Phone Integration by contacting the team.
  Scope: sip_phone:read:admin
  : Medium
sipPhone.updateSipPhone
Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to update information of a specific SIP Phone on a Zoom account.

Prerequisites:
- Currently only supported on Cisco and Avaya PBX systems.
- The account owner or account admin must first enable SIP Phone Integration by contacting the team.
  Scope: sip_phone:write:admin
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
trackingField.trackingfieldCreate
allow you to analyze usage by various fields within an organization.
Use this API to create a new tracking field.

Scope: trackingfield:write:admin
: Light
Prerequisites:
- Business, Education, API or higher plan
trackingField.trackingfieldDelete
allow you to analyze usage by various fields within an organization.
Use this API to delete a tracking field.

Scope: trackingfield:write:admin
: Light
Prerequisites:
- Business, Education, API or higher plan
trackingField.trackingfieldGet
allow you to analyze usage by various fields within an organization.

When scheduling a meeting, the tracking field will be included in the meeting options.
Use this API to get information on a tracking field.

Scopes: trackingfield:read:admin
: Light
Prerequisites:
- Business, Education, API or higher plan
trackingField.trackingfieldList
allow you to analyze usage by various fields within an organization.
Use this API to list all the tracking fields on your Zoom account.

Scopes: trackingfield:read:admin
: Medium
Prerequisites:
- Business, Education, API or higher plan
trackingField.trackingfieldUpdate
allow you to analyze usage by various fields within an organization.
Use this API to update a tracking field.

Scope: trackingfield:write:admin
: Light
Prerequisites:
- Business, Education, API or higher plan
tsp.getOperation
Get information on Telephony Service Provider on an account level.

Scopes: tsp:read:admin
: Light
Prerequisites:
- A Pro or a higher plan.
tsp.tspUpdate

Update information of the Telephony Service Provider set up on an account.
Prerequisites:
TSP account option should be enabled.
Scopes: tsp:write:admin
: Light
tsp.tspUrlUpdate

A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled.
Scopes:tsp:write:admin tsp:write
: Light
tsp.userTsp

Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.

Scopes: tsp:read:admin tsp:read
: Light
tsp.userTspCreate

Add a user's TSP account.

Scopes: tsp:write:admin tsp:write
: Light
tsp.userTspDelete

Delete a user's TSP account.

Scopes: tsp:write:admin tsp:write
: Light
tsp.userTsPs

A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.

Scopes: tsp:read:admin tsp:read
: Medium
tsp.userTspUpdate

Update a user's TSP account.

Scopes: tsp:write:admin tsp:write
: Light
users.delUserVb
Delete existing virtual background file(s) of a user.
Prerequisites:
- Virtual background feature must be on the account.
Scope: user:write:admin
: Light
users.getOperation

A Zoom account can have one or more users. Use this API to list users on your account.

Scopes: user:read:admin
: Medium
users.switchUserAccount
Disassociate a user from one Account and move the user to another Account under the same master account.
With this API, a user under a master account or a sub account can be moved to another sub account within the same master account. To move a user from a master account to a sub account, use me as the value for accountId. In this scenario, "me" refers to the Account ID of the master account.
To move a user from one sub account to another sub account, provide the sub account's Account ID as the value for accountId.
Prerequisites:
- The account should have Pro or a higher plan with master account option enabled.
- The user whose account needs to be switched should not be an admin or an owner of that account.
- The user should not have the same as the account owner.
Scope: user:master
: Light
users.updatePresenceStatus

Users in the Zoom desktop client and mobile apps are assigned with a . The presence status informs users of their contact's availability. Users can also change their own presence status to be either "Away", "Do not disturb", or "Available".
Use this API to update a user's presence status. A user's status can not be updated more than once per minute, i.e., you can only submit a maximum of 1 update request/minute for a single user.
Note that a user's presence status can not be updated using this API if the user is not logged in to the Zoom client.
Scopes: user:write, user:write:admin
: Medium
users.uploadVBuser
Use this API to for a user.
Prerequisites:
- Virtual background feature must be on the account.
Scope: user:write:admin : Medium
users.user

A Zoom account can have one or more users. Use this API to view information of a specific user on a Zoom account.

Scopes: user:read:admin user:read
: Light
Note: If a user's status is pending, only `id` and `created_at` fields will be returned. The value of `created_at` will be the time at which the API call was made until the user activates their account.
users.userAssistantCreate
Assistants are the users to whom the current user has assigned . These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled on the account.
Use this API to assign assistants to a user.
In the request body, provide either the User ID or the email address of the user.

Prerequisite:
- The user as well as the assistant must have Licensed or an On-prem license.
- Assistants must be under the current user's account.
  Scopes: user:write:admin user:write : Medium
users.userAssistantDelete
Delete a specific assistant of a user. Assistants are the users to whom the current user has assigned . These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled on the account.

Prerequisites:
- The user as well as the assistant must have Licensed or an On-prem license.
- Assistants must be under the current user's account.
  Scopes: user:write:admin user:write : Light
users.userAssistants
List a user's assistants.
Assistants are the users to whom the current user has assigned . These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled on the account.

Prerequisites:
- Current user as well as the assistant must have Licensed or an On-prem license.
- Assistants must be under the current user's account.
  Scopes: user:read:admin user:read
: Medium
users.userAssistantsDelete
Delete all assistants of the current user.
Assistants are the users to whom the current user has assigned . These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled on the account.
Prerequisite:
- The user as well as the assistant must have Licensed or an On-prem license.
- Assistants must be under the current user's account.
  Scopes: user:write:admin user:write : Light
users.userCreate
A Zoom account can have one or more users. Use this API to add a new user to your account.

Prerequisites:
- Pro or higher plan
  
  Scopes: user:write:admin user:write
: Light
users.userDelete

Deleting a user permanently removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user account before deleting.

This API disassociates (unlinks) a user from the associated Zoom account and provides the user their own basic free Zoom account, and the user can purchase their own licenses. You can transfer the user's data (meetings, webinars and cloud recordings) to another user before disassociation.
To permanently delete a user, specify "delete" as the value of the action query parameter. Scopes: user:write:admin user:write
: Light
users.userEmail

Verify if a user's email is registered with Zoom.

Note: You can successfully check if a user is a registered Zoom user only if the user signed up for Zoom via email and is within your account. If you provide an email address of a user who is not in your account, the value of "existed_email" parameter will be "false" irrespective of whether or not the user is registered with Zoom. The response of this API call will not include users who joined Zoom using options such as "Sign in with SSO", "Sign in with Google" or "Sign in with Facebook" even if they are in the same account as yours.
Scopes: user:read:admin user:read
: Light
users.userEmailUpdate
Change a user's on a Zoom account that has managed domain set up.
If the Zoom Account in which the user belongs, has multiple , the email to be updated must match one of the managed domains.
Scopes: user:write:admin user:write
: Light

Note: A user's email address can only be changed for a maximum of 3 times in a day(24 hours). Prerequisite:
- Managed domain must be enabled in the account.
- The new email address should not already exist in Zoom.
users.userPassword
Update the of a user using which the user can login to Zoom.
After this request is processed successfully, an email notification will be sent to the user stating that the password was changed.
Scopes: user:write:admin user:write
: Medium Prerequisites:
- Owner or admin of the Zoom account.
users.userPermission

Users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.
Use this API to get permissions that have been granted to the user.

Scopes: user:read:admin user:read
: Light
users.userPicture

Upload a user's profile picture.

Provide multipart/form-data as the value of the content-type header for this request. This API supports JPEG and PNG file formats.
Scopes: user:write:admin user:write
: Medium
users.userSchedulerDelete

Delete a Scheduler.
Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of this scheduler.
Prerequisite: Current user must be under the same account as the scheduler.
Scopes: user:write:admin user:write
: Light
users.userSchedulers
List all the schedulers of a user. Schedulers in this context are the users for whom the current user can schedule meetings for.
For instance, if the current user (i.e., the user whose userId was passed in the path parameter of this API call) is user A, the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s).
Prerequisites:
- Current user must be under the same account as the scheduler.
  Scopes: user:read:admin user:read : Medium
users.userSchedulersDelete

Delete all of a user's schedulers. Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user.
Prerequisite: Current user (assistant) must be under the same account as the scheduler.
Scopes: user:write:admin user:write
: Light
users.userSettings

Retrieve a user's settings.

Scopes: user:read:admin user:read
: Medium
users.userSettingsUpdate

Update a user's settings.

Scopes: user:write:admin user:write
: Medium
users.userSsoTokenDelete

Revoke a user's SSO token.

After calling this API, the SSO user will be logged out of their current Zoom session.
Scopes: user:write:admin user:write
: Light
users.userStatus

An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.
Use this API to either an active user or to a deactivated user .

Scopes: user:write:admin user:write
: Light
users.userToken

Retrieve a user's token.

This token is used for starting meetings with the Client SDK.
Scopes: user:read:admin user:read
: Light If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead.
users.userUpdate

Update information on a user's Zoom .

Scopes: user:write:admin user:write
: Light
users.userVanityName

A personal meeting room is a virtual meeting room that can be permanently assigned to a user. Use this API to check if a personal meeting room with the given name exists or not.

Scopes: user:read:admin user:read
: Light
users.userZak

Get User’s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting on your app. Non-login users do not need to enter their username and password to join meetings.
Scope: user_zak:read
: Light
webinars.addBatchWebinarRegistrants
Use this API to register up to 30 registrants at once for a scheduled webinar that requires .
Prerequisites:
- The webinar host must be a Licensed user.
- The webinar should be of type 5, i.e., it should be a scheduled webinar. Other types of webinars are not supported by this API.
  
  Scope: webinar:write, webinar:write:admin
  : Heavy
webinars.deleteWebinarRegistrant

Delete a webinar registrant.

Scopes: webinar:write:admin webinar:write

: Light
webinars.getTrackingSources
allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.
Use this API to list information on all the tracking sources of a Webinar.
Scopes: webinar:read:admin, webinar:read
: Medium
Prerequisites:
- .
- Registration must be required for the Webinar.
webinars.getUsers
Zoom users with a have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to list all the webinars that are scheduled by or on-behalf a user (Webinar host).

Scopes: webinar:read:admin webinar:read

: Medium Prerequisites:
- Pro or higher plan with a Webinar Add-on.
webinars.listPastWebinarPollResults
The polling feature for webinar allows you to create single choice or multiple choice polling questions for your webinars. Use this API to retrieve the results for Webinar Polls of a specific Webinar.
Prerequisites:
- Scopes: webinar:read:admin, webinar:read
  : Medium
webinars.listPastWebinarQa
The feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions.
Use this API to list Q&A of a specific Webinar.
Prerequisites:
- Scopes: webinar:read:admin, webinar:read
: Medium
webinars.listWebinarParticipants
Use this API to list all the participants who attended a webinar hosted in the past.
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
  Scopes: webinar:read:admin webinar:read
**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
webinars.listWebinarTemplates
When you schedule a webinar, you can save the settings for that webinar as a template for scheduling future webinars.

Use this API to list a user's existing information.
Prerequisites:
- Pro or a higher account with Webinar plan enabled.
webinars.pastWebinars

List past webinar instances.

Scopes: webinar:read:admin webinar:read
: Light
webinars.webinar
Zoom users with a have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to get details of a scheduled webinar.

Scopes: webinar:read:admin webinar:read
: Light
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
webinars.webinarAbsentees

List absentees of a webinar.

Scopes: webinar:read:admin webinar:read
: Heavy
webinars.webinarCreate
Zoom users with a have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to schedule a Webinar for a user (host).

Scopes: webinar:write:admin webinar:write
: Light
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
webinars.webinarDelete
Delete a Webinar.

Scopes: webinar:write:admin webinar:write
: Light
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
webinars.webinarPanelistCreate
Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a webinar.
Use this API to to a scheduled webinar.

Scopes: webinar:write:admin webinar:write
: Medium
Prerequisites:
- Pro or a higher plan with .
webinars.webinarPanelistDelete
a single panelist from a webinar.
You can retrieve the panelistId by calling List Panelists API.

Scopes: webinar:write:admin webinar:write
: Light
Prerequisites:
- Pro or a higher plan with .
webinars.webinarPanelists
Panelists in a Webinar can view and send video, screen share, annotate, etc and do much more compared to attendees in a Webinar.
Use this API to list all the panelists of a Webinar.

Scopes: webinar:read:admin webinar:read
: Medium
Prerequisites:
- Pro or a higher plan with .
webinars.webinarPanelistsDelete
Remove all the panelists from a Webinar.
Scopes: webinar:write:admin webinar:write
: Light
Prerequisites:
- Pro or a higher plan with .
webinars.webinarPollCreate

Create a for a webinar.

Scopes: webinar:write:admin webinar:write
: Light
webinars.webinarPollDelete

Delete a webinar's .

Scopes: webinar:write:admin webinar:write
: Light
webinars.webinarPollGet

Get a webinar's details.

Scopes: webinar:read:admin webinar:read
: Light
webinars.webinarPolls

List all the of a Webinar.

Scopes: webinar:read:admin webinar:read
: Light
webinars.webinarPollUpdate

Update a webinar's .

Scopes: webinar:write:admin webinar:write
: Light
webinars.webinarRegistrantCreate
Zoom users with a have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to create and submit the registration of a user for a webinar.

Scopes: webinar:write:admin webinar:write
: Light
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
webinars.webinarRegistrantGet
Zoom users with a have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to get details on a specific user who has registered for the Webinar.

Scopes: webinar:read:admin webinar:read
: Light
Prerequisites:
- The account must have a Webinar plan.
webinars.webinarRegistrantQuestionUpdate
Scheduling a requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to update registration questions and fields of a scheduled Webinar that are to be answered by users while registering for a Webinar.

Prerequisites:
- Pro or higher plan with a Webinar Add-on.
- Registration option for Webinar should be set as required to use this API. Scopes: webinar:write:admin webinar:write
: Light
webinars.webinarRegistrants
Zoom users with a have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a requires your registrants to complete a brief form before receiving the link to join the Webinar.
Use this API to list all the users that have registered for a webinar.

Prerequisites:
- Pro or higher plan with a Webinar Add-on.
  Scopes: webinar:read:admin webinar:read
  : Medium
webinars.webinarRegistrantsQuestionsGet
Scheduling a requires your registrants to complete a brief form with fields and questions before they can receive the link to join the Webinar.
Use this API to list registration questions and fields that are to be answered by users while registering for a Webinar.
Prerequisites:
- Pro or higher plan with a Webinar Add-on. Scopes: webinar:read:admin webinar:read
: Light
webinars.webinarRegistrantStatus

Update a webinar registrant's status. Using this API, you can specify whether you want to approve a registration, deny a registration or cancel a previously approved registration.

Scopes: webinar:write:admin webinar:write
: Medium
webinars.webinarStatus
Update a webinar's status. Use this API to end an ongoing webinar.

Scopes: webinar:write:admin webinar:write
: Light
Prerequisites:
- The account must hold a valid .
webinars.webinarUpdate
Zoom users with a have access to creating and managing Webinars. Webinar allows a host to broadcast a Zoom meeting to up to 10,000 attendees.
Use this API to make updates to a scheduled Webinar.

Scopes: webinar:write:admin webinar:write
: Light
Prerequisites:
- Pro or higher plan with a Webinar Add-on.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools