Zoom Account API

Retrieve an account's locked settings.

Account admins and account owners can use Account Locked Settings to toggle settings on or off for all users in their account.

Note: You can use Account Locked Settings with accounts that have master and sub accounts enabled.

Prerequisites: * Pro or a higher paid account.

Scopes: account:read:admin

Rate Limit Label: MEDIUM

Update an account's locked settings.

Account Locked Settings allows account admins and account owners to toggle settings on or off for all users in your account.

Note: Yout must have a Pro or a higher plan and enabled master and sub accounts options.

Prerequisites:

• Pro or a higher paid account.
  

Scopes: account:write:admin

Rate Limit Label: MEDIUM

Retrieve a list of an account's managed domains. To get the master account's managed domains, pass the me value for the accountId path parameter.

Prerequisites: * A Pro or a higher paid account with the Master account option enabled.

Scopes: account:read:admin

Rate Limit Label: LIGHT

Change an account's owner.

An account's current owner can change the account's owner to another user on the same account.

Prerequisites: * An account owner or admin permissions of an account * The account making this API request must be on a Pro or a higher account plan with Master account privileges

Rate Limit Label: HEAVY

Get an account's webinar registration settings. To get the master account's webinar registration settings, use the me value for the accountId path parameter.

Prerequisites: * The account must be a paid account.

Scopes: account:read:admin

Rate Limit Label: MEDIUM

Update an account's webinar registration settings. To update the master account's webinar registration settings, pass the me value for the accountId path parameter.

Prerequisites: * The account must be a paid account.

Scopes: account:write:admin

Rate Limit Label: MEDIUM

Upload virtual background files for all users on the account to use.

Prerequisites: * The Virtual Background feature must be enabled on the account.

Scopes: account:write:admin

Rate Limit Label: MEDIUM

Delete an account's existing virtual background files.

Prerequisites: * The Virtual Background feature must be enabled on the account.

Scopes: account:write:admin

Rate Limit Label: LIGHT

Get an account's settings.

To get settings for a master account, use the me value for the accountId path parameter.

Prerequisites: * The account must be a paid account.

Scopes: account:read:admin

Rate Limit Label: MEDIUM

Update an account's settings. To update the settings for a master account, pass the me value for the accountId path parameter.

Prerequisites: * The account must be a paid account.

Scopes: account:write:admin

Rate Limit Label: MEDIUM

Retrieve an account's trusted domains. To get the master account's trusted domains, use the me value for the accountId path parameter.

Prerequisites: * The account must be a paid account.

Scopes: account:read:admin

Rate Limit Label: LIGHT

Get metrics for how users are utilizing Zoom Chat to send messages.

Use the from and to query parameters to specify a monthly date range for the dashboard data. The monthly date range must be within the last six months.

> Note: To query chat metrics from July 1, 2021 and later, use this endpoint instead of the Get IM metrics API.

Prerequisites:

• Business or a higher plan

Scopes: dashboard_im:read:admin,dashboard:read:admin

Rate Limit Label: Resource-intensive

Retrieve detailed information on a Zoom meetings client feedback.
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 * Feedback to Zoom enabled.

Scopes: dashboard_home:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Use this API to return Zoom meetings client feedback survey results. 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: * A Business or higher account. * The "Feedback to Zoom" option enabled.

Scopes: dashboard_home:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

If the End of Meeting Feedback Survey 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 Get Zoom meetings client feedback API.

Scopes: dashboard_home:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Use this API to list all the client versions and its count.

Prerequisites: * A Business or a higher plan.

Scopes: dashboard_home:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

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. <aside class='notice'>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".</aside>

Prerequisites:

• Business, Education or API Plan.
• Room Connector must be enabled on the account.
  

Scopes: dashboard_crc:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Use this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues. 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: * A Business or a higher plan. * A Zoom Room must be enabled in the account.

Scopes: dashboard_home:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

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.

Prerequisites:

• Business or a higher plan.
• Zoom Room must be enabled in the account.

Scopes: dashboard_home:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Show a list of meeting participants from live or past meetings, and their quality of service received during the meeting. The data returned indicates the connection quality for sending or receiving video, audio, and shared content.

Note:

This API may return empty values for participants' user_name, ip_address, location, and email responses when the account calling this API. * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.

Prerequisites: * A Business or a higher plan.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

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: * Feedback to Zoom 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.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Retrieve the sharing and recording details of participants from live or past meetings.

Prerequisites:

• Business or a higher plan.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Return the quality of service (QoS) report for participants from live or past meetings. The data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received.

When the sender sends data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum.

This API will not return data if there is no data being sent or received at the time of request.

Note:

This API may return empty values for participants' user_name, ip_address, location, and email responses when the account calling this API: * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

Return a list of participants from live or past meetings. If you don't provide the type query parameter, the default value is set to the live value. This API only returns metrics for participants in a live meeting, if any exist. 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.

Note:

This API may return empty values for participants' user_name, ip_address, location, and email responses when the account calling this API: * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.

Prerequisites: * A Business or higher plan.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

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.

Prerequisites:

• Business or a higher plan.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

Lists the total live or past meetings that occurred during a specified period of time. This overview shows 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. 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 a higher plan.

Scopes: dashboard_meetings:read:admin,dashboard:read:admin

Rate Limit Label: RESOURCE-INTENSIVE

Use this API to return meeting quality score information. Meeting quality scores are based on the mean opinion score (MOS). The MOS measures a meeting's quality on a scale of "Good" (5-4), "Fair" (4-3), "Poor" (3-2), or "Bad" (2-1).

Prerequisites: * A Business or a higher plan.

Scopes: dashboard_home:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Show a list of webinar participants from live or past webinars and the quality of service they received during the webinar. The data returned indicates the connection quality for sending/receiving video, audio, and shared content.

Note:

This API may return empty values for participants' user_name, ip_address, location, and email responses when the account calling this API: * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account, such as external users, unless they meet certain conditions. See Email address display rules for details.

Prerequisites: * A Business, Education, or API Plan with Webinar add-on.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

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: * Feedback to Zoom 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.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Retrieve the sharing and recording details of participants from live or past webinars.

Prerequisites:

• Business, Education or API Plan with Webinar add-on.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Return the quality of service (QoS) for participants during live or past webinars. This data returned indicates the connection quality for sending/receiving video, audio, and shared content. The API returns this data for either the API request or when the API request was last received.

When the sender sends its data, a timestamp is attached to the sender's data packet. The receiver then returns this timestamp to the sender. This helps determine the upstream and downstream latency, which includes the application processing time. The latency data returned is the five second average and five second maximum.

This API will not return data if there is no data being sent or received at the time of request.

Note:

This API may return empty values for participants' user_name, ip_address, location, and email responses when the account calling this API: * Does not have a signed HIPAA business associate agreement (BAA). * Is a legacy HIPAA BAA account. * Displays data for any users who are not part of the host's account, such as external users, unless they meet certain conditions. See Email address display rules for details.

Prerequisites: * A Business, Education, or API Plan with Zoom Rooms set up.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

Returns information about participants from live or past webinars. Displays data for any users who are not part of the host's account (external users) unless they meet certain conditions. See Email address display rules for details.

Note: This API might return empty values for participants' user_name, ip_address, location, and email responses when the account calls this API.

Prerequisites: * A Business, Education, or API Plan with Webinar add-on.

• Any legacy HIPAA BAA account.
• No signed HIPAA business associate agreement (BAA).

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: HEAVY

Retrieve details from live or past webinars.

Prerequisites:

• Business, Education or API Plan with Webinar add-on.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

Lists all the live or past webinars from a specified period of time.

Prerequisites

• Business, Education or API Plan with Webinar add-on.

Scopes: dashboard_webinars:read:admin,dashboard:read:admin

Rate Limit Label: RESOURCE-INTENSIVE

Get top 25 issues of Zoom Rooms.

Prerequisites:

• Business, Education or API Plan with Zoom Rooms set up.

Scopes: dashboard_zr:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

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.

Prerequisites:

• Business, Education or API Plan with Zoom Rooms set up.

Scopes: dashboard_zr:read:admin,dashboard:read:admin

Rate Limit Label: Heavy

List information on all Zoom Rooms in an account.

Prerequisites:

• Business, Education or API Plan with Zoom Rooms set up.

Scopes: dashboard_zr:read:admin,dashboard:read:admin

Rate Limit Label: Resource-intensive

Return an Information Barriers policy by its ID.

Prerequisites: * Contact Zoom Support to enable Information Barriers for your account.

Scopes: information_barriers:read:admin

Rate Limit Label: MEDIUM

Remove an Information Barrier policy.

Prerequisites: * Contact Zoom Support to enable Information Barriers for your account.

Scopes: information_barriers:write:admin

Rate Limit Label: MEDIUM

Update an Information Barriers policy.

Prerequisites: * Contact Zoom Support to enable Information Barriers for your account.

Scopes: information_barriers:write:admin

Rate Limit Label: MEDIUM

Return a list of all Information Barriers policies and their information.

Prerequisites: * Contact Zoom Support to enable Information Barriers for your account.

Scopes: information_barriers:read:admin

Rate Limit Label: MEDIUM

Create a new Information Barrier policy. Information Barriers help customers control communication policies and meet regulatory requirements at scale. Use information barriers to prevent specific groups of users who possess sensitive information from communicating with others who should not know this information.

Prerequisites: * Contact Zoom Support to enable Information Barriers for your account.

Scopes: information_barriers:write:admin

Rate Limit Label: MEDIUM

User roles 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.

Prerequisites:

• A Pro or a higher plan.

Scopes: role:write:admin

Rate Limit Label: Light

User roles 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.

Prerequisites:

• A Pro or a higher plan.

Scopes: role:read:admin

Rate Limit Label: Medium

User roles can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to assign a role to members.

Prerequisites:

• A Pro or a higher plan.

Scopes: role:write:admin

Rate Limit Label: Medium

Each Zoom user automatically has a role which can either be owner, administrator, or 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 role.

Pre-requisites

• A Pro or higher plan.

• For role management and updates, you must be either the account owner or a user with role management permissions.

Scopes: role:read:admin

Rate Limit Label: Light

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

Rate Limit Label: Light

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 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

Rate Limit Label: Light

List roles on your account

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.

Scopes: role:read:admin

Rate Limit Label: Medium

Each Zoom user automatically has a role which can either be owner, administrator, or member.

Pre-requisites

• Pro or higher plan.

• To set the initial role, you must be the account owner.

• For subsequent role management, you must be either the account owner or user with role management permissions.

Scopes: role:write:admin

Rate Limit Label: Light