Zoom Meeting API

Get statistics about an account's archived meeting or webinar files.

Zoom's archiving solution lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA and other compliance requirements.

Prerequisites: * The Meeting and Webinar Archiving feature enabled for your account by Zoom Support.

Scopes: recording:read:admin

Rate Limit Label: Medium

Update an archived file's auto-delete status.

Prerequisites: * Zoom Support must enable the Meeting and Webinar Archiving feature for your account. * Open the disabling auto-delete feature in OP. Contact Zoom Support to open.

Scopes: recording:write,recording:write:admin

Rate Limit Label: LIGHT

Get an account's archived meeting or webinar files.

Zoom's archiving solution lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA or other compliance requirements.

Prerequisites: * The Meeting and Webinar Archiving feature enabled for your account by Zoom Support.

Scopes: recording:read:admin

Rate Limit Label: MEDIUM

Return a specific meeting instance's archived files.

Prerequisites: * The Meeting and Webinar Archiving feature enabled for your account by Zoom Support.

Scopes: recording:read

Rate Limit Label: LIGHT

Use this API to delete all of a meeting's archived files.

Prerequisites: * The Meeting and Webinar Archiving feature enabled for your account by Zoom Support.

Scopes: recording:write:admin,recording:write

Rate Limit Label: Light

Return a list of past meeting instances.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Medium

Retrieve information on participants from a past meeting. Note the API doesn't return results if there's only one participant in a meeting.

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.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: MEDIUM

Polls allow the meeting host to survey attendees. List poll results of a meeting.

Prerequisites:

• Host user type must be Pro.
• Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Medium

The question & answer (Q&A) feature for Zoom Meetings lets attendees ask questions during a meeting and lets the other attendees answer those questions.

List Q&A of a specific meeting.

Prerequisites:

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Medium

Get information about a past meeting.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Light

Get Zoom Device Manager (ZDM) group information for an account.

Scopes: device:read:admin

Rate Limit Label: MEDIUM

Assign a device to a user or common area, or move a device to another user or common area, or remove a device.

Prerequisites: * Device must be enrolled in Zoom Device Management (ZDM).

Scopes: device:write:admin

Rate Limit Label: MEDIUM

Upgrade ZPA firmware or app by Zoom Device Manager (ZDM) group ID.

Scopes: device:write:admin

Rate Limit Label: HEAVY

Remove a ZPA device from the device manager, by vendor and mac address.

Scopes: device:write:admin

Rate Limit Label: MEDIUM

Get ZPA firmware and app version information that can be upgraded for devices.

Scopes: device:read:admin

Rate Limit Label: MEDIUM

This Device API lets you change device association from one Zoom Room to another.

Prerequisites: * Device must be enrolled in ZMD (Zoom Device Management)

Scopes: device:write:admin

Rate Limit Label: Medium

Retrieve a device's details.

Scopes: device:read:admin,device:write:admin

Rate Limit Label: HEAVY

Delete a device from a Zoom account.

Prerequisites: * Device must be enrolled in ZMD (Zoom Device Management)

Scopes: device:write:admin

Rate Limit Label: HEAVY

Change device name.

Prerequisites: * Device must be enrolled in ZMD (Zoom Device Management)

Scopes: device:write:admin

Rate Limit Label: MEDIUM

This API lets you list devices.

Scopes: device:read:admin,device:write:admin

Rate Limit Label: HEAVY

Add a new device to Zoom account.

Scope: device:write:admin

Rate Limit Label: Medium

Scopes: device:write:admin

Rate Limit Label: MEDIUM

Lists all cloud recordings for a user.

For user-level apps, pass the me value instead of the userId parameter. To access a user's passcode protected cloud recording, send the user's OAuth access token as a bearer token in the authorization header.

Example: curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz

Prerequisites:
* Must have a Pro or a higher plan.
* Must enable Cloud Recording on the user's account.

Scopes: recording:read:admin,recording:read

Rate Limit Label: MEDIUM

List available meeting templates for a user. For user-level apps, pass the me value instead of the userId parameter.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: Medium

Create a meeting template from an existing meeting.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Medium

List a meeting host user's scheduled meetings. For user-level apps, pass the me value instead of the userId parameter.

Note * This API only supports scheduled meetings. This API does not return information about instant meetings. * This API only returns a user's unexpired meetings.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: MEDIUM

Create a meeting for a user. For user-level apps, pass the me value instead of the userId parameter.

• A meeting's start_url value is the URL a host or an alternative host can use to start a meeting. The expiration time for the start_url value is two hours for all regular users.
• For custCreate meeting hosts (users created with the custCreate parameter via the Create users API), the expiration time of the start_url parameter is 90 days from the generation of the start_url.

Note:

For security reasons, the recommended way to programmatically get the updated start_url value after expiry is to call the Get a meeting API. Refer to the start_url value in the response.

100 requests per day. The rate limit is applied against the userId of the meeting host used to make the request.

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: MEDIUM

List a Zoom user's upcoming meetings. For user-level apps, pass the me value instead of the userId parameter.

Note * This API includes the meetings that Zoom users schedule and the meetings they are invited to join. * This API only includes upcoming meetings within the next 24 hours.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: MEDIUM

Retrieve a list of a user's personal audio conference (PAC) accounts. For user-level apps, pass the me value instead of the userId parameter.

PAC allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.

Prerequisites * A Pro or higher plan with an Audio Conferencing subscription. * The Personal Audio Conference setting enabled in the user's profile.

Scopes: pac:read:admin,pac:read

Rate Limit Label: Light

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. <p></p>

Scopes: tsp:write:admin,tsp:write

Rate Limit Label: Light

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

Rate Limit Label: Light

Delete a user's TSP account.

Scopes: tsp:write:admin,tsp:write

Rate Limit Label: Light

Update a user's TSP account.

Scopes: tsp:write:admin,tsp:write

Rate Limit Label: Light

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

Rate Limit Label: Medium

Add a user's TSP account.

Scopes: tsp:write:admin,tsp:write

Rate Limit Label: Light

Display a list of a user's webinar templates. For user-level apps, pass the me value instead of the userId parameter. When you schedule a webinar, save the settings for that webinar as a template for scheduling future webinars. To use a template when scheduling a webinar, use the id value in this API response in the template_id field of the Create a webinar API. Prerequisites: * A Pro or a higher account with the Zoom Webinar plan.

Scopes: webinar:read:admin,webinar:read

Use this API to create a webinar template from an existing webinar.

Scopes: webinar:write:admin,webinar:write

Rate Limit Label: Medium

List all the webinars scheduled by or on behalf a webinar host. For user-level apps, pass the me value instead of the userId parameter.

Zoom users with a webinar plan have access to creating and managing webinars. Webinars let a host broadcast a Zoom meeting to up to 10,000 attendees.

Note This API only returns a user's unexpired webinars.

Prerequisites * A Pro or higher plan with the webinar add-on.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM

Schedule a webinar for a user who is a webinar host. For user-level apps, pass the me value instead of the userId parameter.

Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees.

Rate limit: Up to a maximum of 100 requests per day. The rate limit is applied to the userId of the webinar host used to make the request.

Prerequisites: * A Pro or higher plan with a Webinar plan add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Use this API to return a meeting recording's analytics details. Maximum duration: 1 Month. To access a password-protected cloud recording, send the user's OAuth access token as a Bearer token in the Authorization header. For example,

curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz

Scopes: recording:read:admin,recording:read

Rate Limit Label: Medium

Use this API to return a meeting recording's analytics summary. Maximum duration: 1 Month. To access a password-protected cloud recording, send the user's OAuth access token as a Bearer token in the Authorization header. For example,

curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz

Scopes: recording:read:admin,recording:read

Rate Limit Label: Medium

For on-demand 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

Rate Limit Label: Light

For on-demand 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

Rate Limit Label: Light

A registrant can either be approved or denied from viewing the on-demand recording. Use this API to update a registrant's status.

Scopes: recording:write:admin,recording:write

Rate Limit Label: Medium

Use this API to list registrants of a past meeting's on-demand cloud recordings. Users must register to view the recordings.

Scopes: recording:read:admin,recording:read

Rate Limit Label: Medium

Cloud Recordings of past Zoom Meetings can be made on-demand. Users should be registered 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

Rate Limit Label: Light

Retrieves settings applied to a meeting's Cloud Recording.

Scopes: recording:read:admin,recording:read

Rate Limit Label: LIGHT

Updates settings applied to a meeting's Cloud Recording.

Scopes: recording:write,recording:write:admin

Rate Limit Label: LIGHT

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

Rate Limit Label: Light

Delete a specific recording file from a meeting.<p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> To use this API, you must enable the <b>The host can delete cloud recordings</b> setting. You can find this setting in the <b>Recording</b> tab of the <b>Settings</b> interface in the Zoom web portal.</p>

Scopes: recording:write:admin,recording:write

Rate Limit Label: Light

Returns all of a meeting's recordings.

Use the download_url property listed in the response to download the recording files. To access a passcode-protected cloud recording, send the user's OAuth access token as a Bearer token in the Authorization header.

Example: curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz

Scopes: recording:read,phone_recording:read:admin

Rate Limit Label: LIGHT

Delete all recording files of a meeting.

Prerequisites: * Cloud Recording should be enabled on the user's account.

Scopes: recording:write:admin,recording:write

Rate Limit Label: Light

Polls allow the meeting host to survey attendees. Create batch polls for a meeting.

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.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Register up to 30 registrants at once for a meeting that requires registration.

Prerequisites:

• The meeting host must be a Licensed user.
• The meeting must require registration and should be of type 2, i.e., they should be scheduled meetings. Instant meetings and Recurring meetings are not supported by this API.
  

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: Heavy

Retrieve the meeting invitation note for a specific meeting.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: LIGHT

Create a batch of invitation links for a meeting.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Get a meeting's join token to allow live streaming. The join token allows a recording bot implemented using Zoom meeting SDK to connect to a Zoom meeting "hosted by the issuer of the token", and can call the streaming method automatically. It supports both regular live streaming, and raw streaming.

Prerequisites: * A Pro or higher plan for the meeting host. * The Allow livestreaming of meetings user setting enabled in the Zoom web portal.

Scopes: meeting_token:read:admin:live_streaming,meeting_token:read:live_streaming

Rate Limit Label: Light

Get a meeting's archive token to allow local archiving. The archive token allows a meeting SDK app or bot to get archive permission to access the meeting's raw audio and video media stream in real-time.

Prerequisites: * A Pro or higher plan for the meeting host. * The Archive meetings and webinars account setting enabled in the Zoom web portal.

Scopes: meeting_token:read:admin:local_archiving

Rate Limit Label: Light

Get a meeting's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK to connect to a Zoom meeting. The recording bot can then automatically start locally recording. This supports both regular and raw local recording types.

Prerequisites: * The Local recording user setting enabled in the Zoom web portal.

Scopes: meeting_token:read:local_recording,meeting_token:read:admin:local_recording

Rate Limit Label: LIGHT

Zoom allows users to livestream a meeting to a custom platform. Update the status of a meeting's livestream.

Prerequisites: * Meeting host must have a Pro license.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: LIGHT

Zoom allows users to livestream a meeting to a custom platform. Get a meeting's livestream 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 configured for the meeting.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Light

Update a meeting's livestream information. Zoom allows users to livestream a meeting to a custom platform.

Prerequisites: * Meeting host must have a Pro license.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Displays information about a meeting summary.

Prerequisites: * Host user type must be Pro or higher plan. * The Meeting Summary with AI Companion feature enabled in the host's account. * E2ee meetings do not have summary feature enabled.

Scopes: meeting_summary:read:admin,meeting_summary:read

Rate Limit Label: LIGHT

Polls allow the meeting host to survey attendees. Retrieve information about a specific meeting poll.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Light

Polls allow the meeting host to survey attendees. Update information of a specific meeting poll

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Polls allow the meeting host to survey attendees. Delete a meeting poll.

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.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Polls allow the meeting host to survey attendees. List all polls of a meeting.

Prerequisites:

• Host user type must be Pro or higher plan.
• Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Light

Polls allow the meeting host to survey attendees. Create a poll for a meeting.

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.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

List registration questions that will be displayed to users while registering for a meeting.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: Light

Update registration questions that will be displayed to users while registering for a meeting.

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: Light

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

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Medium

Retrieve details on a specific user who has registered for the meeting. A host or a user with administrative permissions can require registration for Zoom meetings.

Prerequisites: * The account must have a Meeting plan

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Light

Delete a meeting registrant.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

A host or a user with admin permission can require registration for a Zoom meeting. List users that have registered for a meeting.

Scopes: meeting:read:admin,meeting:read

Rate Limit Label: Medium

Create and submit a user's registration to a meeting. See Customizing webinar registration for details on how to set the requirements for these fields. Note that there is a maximum limit of 4,999 registrants per meeting and users will see an error if the meeting's capacity is reached.

Prerequisites: * The host must be a Licensed user type.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Get a meeting's SIP URI. The URI consists of the meeting ID, (optional, user-supplied) passcode and participant identifier code. The API return data also includes additional fields to indicate whether the API caller has a valid Cloud Room Connector subscription, the participant identifier code from the URI, and the SIP URI validity period (in seconds).

Scopes: meeting:write:sip_dialing,meeting:write:admin:sip_dialing

Rate Limit Label: Medium

Update the status of a meeting.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Display information about a meeting survey. Prerequisites: * The host has a Pro license. * The Meeting Survey feature is enabled on the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: LIGHT

Delete a meeting survey.

Prerequisites: * The host must be a Pro user type. * The Meeting Survey feature enabled in the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: Light

Update a meeting survey. Prerequisites: * The host must be a Pro user type. * The Meeting Survey feature is enabled in the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: LIGHT

Get a meeting's closed caption token (caption URL). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom meeting.

Prerequisites: * The Closed captioning setting enabled in the Zoom web portal. * The Allow use of caption API Token to integrate with 3rd-party Closed Captioning services setting enabled.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: Light

Retrieve the given meeting's details.

Scopes: meeting:read,meeting:read:admin

Rate Limit Label: LIGHT

Delete a meeting.

Scopes: meeting:write:admin,meeting:write

Rate Limit Label: Light

Update meeting details.

Note * The start_time value must be a future date. If the value is omitted or a date is in the past, the API ignores this value and does not update any recurring meetings. * The recurrence object is required. * This API has a rate limit of 100 requests per day. You can update a meeting for a maximum of 100 times within a 24-hour period.

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: LIGHT

Zoom allows users to recover recordings from trash for up to 30 days from the deletion date. Use this API to recover all deleted Cloud Recordings of a specific meeting.

Prerequisites:

• A Pro user with Cloud Recording enabled.

Scopes: recording:write:admin,recording:write

Rate Limit Label: Light

Generates a list of all meeting summaries for an account.

Prerequisites * Host user type must be Pro or higher plan. * The Meeting Summary with AI Companion feature enabled in the host's account. * E2ee meetings do not have summary feature enabled.

Scopes: meeting_summary:read:admin

Rate Limit Label: MEDIUM

Delete a message in a live meeting, based on ID.

Prerequisites: * Have Zoom enable the DLP for the in-meeting chat feature to use this API.

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: MEDIUM

Update a message in a live meeting, based on ID. Prerequisites: * Have Zoom enable the DLP for the in-meeting chat feature to use this API.

Scopes: meeting:write,meeting:write:admin

Rate Limit Label: MEDIUM

Control in-meeting features. In-meeting controls include starting and stopping a recording, pausing and resuming a recording, and inviting participants.

Note: This API's recording control only works for cloud recordings. It does not work for local recordings.

Prerequisites: * The meeting must be a live meeting except inviting participants to the meeting through [call out (phone)/(room system)]. * Recording control: Cloud recording must be enabled on the account. * The user calling this API must be the host or an alternative meeting host.

Scopes: meeting:write,meeting:write:admin,meeting:master

Rate Limit Label: Medium

Retrieve a list of sign in / sign out activity logs report of users under a Zoom account.

Prerequisites

• Pro or higher plan.
  

Scopes: report:read:admin

Rate Limit Label: Heavy

Get department billing invoices reports for a specific billing period. Provide the billing_id of the billing period for which you would like to retrieve the invoices for. This ID can be retrieved from Get Billing Reports API.

Prerequisites:

• Pro or a higher account with Department Billing option enabled. Contact the Zoom Support team to enable this feature.

Scopes: report:read:admin

Rate Limit Label: Heavy

Get department billing reports of a Zoom account.

Prerequisites:

• Pro or a higher account with Department Billing option enabled. Contact Zoom Support team for details.

Scopes: report:read:admin

Rate Limit Label: Heavy

Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day earlier 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

Rate Limit Label: Heavy

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

Rate Limit Label: Heavy

Return a report of a past meeting with two or more participants, including the host. To return a report for past meeting with only one participant, use the List meeting participants API.

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.

Prerequisites: * A Pro or a higher plan.

Scopes: report:read:admin

Rate Limit Label: Heavy

Use this API to get a report of poll results for a past meeting.

Prerequisites: * A Pro or a higher plan.

Scopes: report:read:admin

Rate Limit Label: Heavy

Retrieve a report on questions asked and answered by participants from past meetings.

Prerequisites:

• Pro plan or higher.

Scopes: report:read:admin

Rate Limit Label: HEAVY

Retrieve a report on past meeting survey.

Prerequisites:

• Pro or a higher plan.

Scopes: report:read:admin

Rate Limit Label: HEAVY

Get a detailed report for a past meeting.

Prerequisites:

• Pro or a higher plan.
  

Scopes: report:read:admin

Rate Limit Label: Heavy

The Operations Logs 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.

Prerequisites:

• Pro or higher plan.

Scopes: report:read:admin

Rate Limit Label: Heavy

The telephone report 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.

Prerequisites:

• Pro or higher plan.

Scopes: report:read:admin

Rate Limit Label: Heavy

Use this API to list upcoming meeting and/or webinar events within a specified period of time. The report's time range is limited to one month.

Prerequisites: * A Pro or higher plan

Scopes: report:read:admin

Rate Limit Label: Heavy

Retrieve report on past meetings and webinars for a specified time period. The time range for the report is limited to a month and the month must fall within the past six months.

Meetings and webinars are returned only if they have two or more unique participants.

Prerequisites:

• Pro or higher plan.

Scopes: report:read:admin

Rate Limit Label: Heavy

Retrieve a host report for a specified period of time within the last six months.
The report time range is limited to a month.

You can specify the type of report and date range using the query parameters.

• The Active Hosts report displays a list of meetings, participants, and meeting minutes. An active host is defined as any user who has hosted at least one meeting during the during the month specified in the from and to range.

• The Inactive Hosts report pulls a list of users who were not active during a specific period of time.
  An inactive host is defined as any user who has not hosted any meetings during the specified period of time for the report. to be inactive.

Prerequisites:

• Pro or higher plan.

Scopes: report:read:admin

Rate Limit Label: HEAVY

Get a detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months.

Prerequisites: * A Pro or a higher plan with Webinar add-on enabled.

Scopes: report:read:admin

Rate Limit Label: Heavy

Retrieve a report on past webinar polls.

Prerequisites:

• Pro or a higher plan with Webinar add-on enabled.

Scopes: report:read:admin

Rate Limit Label: Heavy

Retrieve a report on questions asked by participants and answered by panelists, co-hosts and hosts from past webinars.

Prerequisites:

• Pro or a higher plan with the Webinar add-on enabled.

Scopes: report:read:admin

Rate Limit Label: HEAVY

Retrieve a report on past webinar survey.

Prerequisites:

• Pro or a higher plan with Webinar add-on enabled.

Scopes: report:read:admin

Rate Limit Label: HEAVY

Retrieve a report containing past webinar details.

Prerequisites:

• Pro or higher plan with Webinar add-on.

Scopes: report:read:admin

Rate Limit Label: Heavy

Use this API to delete a Zoom account's SIP phone.

Prerequisites: * Currently only supported on Cisco and Avaya PBX systems. * The user must enable SIP Phone Integration by contacting the Zoom Sales team.

Scopes: sip_phone:write:admin

Rate Limit Label: Light

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 Sales team.

Scopes: sip_phone:write:admin

Rate Limit Label: Light

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 Sales team.

Scopes: sip_phone:read:admin

Rate Limit Label: Medium

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 Sales team.

Scopes: sip_phone:write:admin

Rate Limit Label: Light

Get information on Telephony Service Provider on an account level.

Prerequisites:

• A Pro or a higher plan.

Scopes: tsp:read:admin

Rate Limit Label: Light

Update information of the Telephony Service Provider set up on an account.

Prerequisites:

TSP account option should be enabled.

Scopes: tsp:write:admin

Rate Limit Label: Light

Use this API to return information about a tracking field.

Prerequisites: * A Business, Education, API or higher plan.

Scopes: tracking_fields:read:admin

Rate Limit Label: Light

Use this API to delete a tracking field.

Prerequisites: * A Business, Education, API or higher plan.

Scopes: tracking_fields:write:admin

Rate Limit Label: Light

Use this API to update a tracking field.

Prerequisites: * A Business, Education, API or higher plan.

Scopes: tracking_fields:write:admin

Rate Limit Label: Light

Use this API to list all the tracking fields on your Zoom account. Tracking fields let you analyze usage by various fields within an organization.

Prerequisites: * A Business, Education, API or higher plan.

Scopes: tracking_fields:read:admin

Rate Limit Label: Medium

Use this API to create a new tracking field. Tracking fields let you analyze usage by various fields within an organization. When scheduling a meeting, tracking fields will be included in the meeting options.

Prerequisites: * A Business, Education, API or higher plan.

Scopes: tracking_fields:write:admin

Rate Limit Label: Light

Deletes a message in a live webinar based on ID.

Prerequisites: * Have Zoom enable the DLP for the in-meeting chat feature to use this API.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: MEDIUM

List absentees of a webinar.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: HEAVY

List past webinar instances.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Retrieve a list of all the participants who attended a webinar hosted in the past.

Prerequisites: * A Pro or higher plan with a webinar add-on.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM

The polling feature for webinar lets you create single-choice or multiple-choice polling questions for your webinars. This API endpoint retrieves the results for webinar polls of a specific webinar.

Prerequisites:

• Webinar license
  

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM

List the Q&A of a specific past webinar.

The question & answer (Q&A) feature for webinars lets attendees ask questions during the webinar and for the panelists, co-hosts and host to answer their questions.

Prerequisites

• Webinar license
  

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM

Register up to 30 registrants at once for a scheduled webinar that requires registration.

Prerequisites:

• The webinar host must be a licensed user.
• The webinar should be type 5, a scheduled webinar. Other types of webinars are not supported by this API.
  

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: HEAVY

Use this API to update a webinar's Session Branding name tag. Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Medium

Use this API to create a webinar's Session Branding name tag. There's a limit of 20 name tags per webinar. Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Medium

Use this API to delete a webinar's Session Branding name tag.

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Light

Use this API to upload a webinar's session branding Virtual Background. Hosts and panelists can select and use these Virtual Backgrounds during the webinar. Branding Virtual Background files have the following restrictions: * A webinar cannot exceed more than 10 Virtual Background files. * You can only upload image files that are in JPG/JPEG, GIF or PNG format. * The Virtual Background file size cannot exceed 15 megabytes (MB).

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Medium

Use this API to delete a webinar's session branding Virtual Background.

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Light

Use this API to set a webinar's default session branding Virtual Background.

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Light

Use this API to upload a webinar's session branding wallpaper file. Webinar branding wallpaper files have the following requirements: * A webinar can only have one wallpaper file. * You can only upload image files that are in JPG/JPEG, GIF, or PNG format. * Image files must be 16:9 ratio. The recommended image size is 1920 x 1080 pixels (px). * The wallpaper file size cannot exceed 15 megabytes (MB).

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Medium

Use this API to delete a webinar's session branding wallpaper file.

Prerequisites: * The Webinar Session Branding setting enabled.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: Light

Use this API to get the webinar's Session Branding information. Session branding lets hosts visually customize a webinar by setting a webinar wallpaper that displays behind video tiles. Session branding also lets hosts set the Virtual Background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers.

Prerequisites: * A Pro or higher plan with the Webinar add-on. * The Webinar Session Branding setting enabled.

Scopes: webinar:read,webinar:read:admin

Rate Limit Label: Light

Create a batch of invitation links for a webinar.

Prerequisites:

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

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Use this API to get a webinar's archive token to allow live streaming. The join token allows a recording bot implemented using Zoom meeting SDK to connect to a Zoom meeting "hosted by the issuer of the token", and can call the streaming method automatically. It supports both regular live streaming, and raw streaming.

Prerequisites: * A Pro or higher plan with a Webinar Add-on. * The Allow livestreaming of webinars user setting enabled in the Zoom web portal.

Scopes: webinar_token:read:admin:live_streaming,webinar_token:read:live_streaming

Rate Limit Label: Light

Use this API to get a webinar's archive token to allow local archiving. The archive token allows a meeting SDK app or bot to get archive permission to access the webinar's raw audio and video media stream in real-time.

Prerequisites: * A Pro or higher plan with a Webinar Add-on. * The Archive meetings and webinars account setting enabled in the Zoom web portal.

Scopes: webinar_token:read:admin:local_archiving

Rate Limit Label: Light

Use this API to get a webinar's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK to connect to a Zoom webinar. The recording bot can then automatically start locally recording. This supports both regular and raw local recording types.

Prerequisites: * A Pro or higher plan with a Webinar Add-on. * The Local recording user setting enabled in the Zoom web portal.

Scopes: webinar_token:read:admin:local_recording,webinar_token:read:local_recording

Rate Limit Label: Light

Let users live stream a webinar to a custom platform. Update the status of a webinar's live stream.

Prerequisites:

• Pro or higher plan with a Webinar Add-on.

• Live streaming details must be configured for the webinar.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Get a webinar's live stream configuration details, such as Stream URL, Stream Key and Page URL.

Zoom allows users to live stream a webinar to a custom platform.

Prerequisites:

• Pro or higher plan with the webinar add-on.

• Live streaming details must have been configured for the webinar.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Update a webinar's live stream information.

Prerequisites:

• Pro or higher plan with the webinar add-on.

• Live streaming details must be configured for the webinar.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Remove a single panelist from a webinar.
Retrieve the panelistId by calling List Panelists API.

Prerequisites:

• Pro or a higher plan with the webinar add-on.
  

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

List all of a webinar's panelists.

Webinar panelists can view and send video, screen share, annotate, and do much more compared to webinar attendees.

Prerequisites:

• Pro or a higher plan with Webinar Add-on.
  

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM

Panelists in a webinar can view and send video, screen share, annotate, and do much more compared to attendees in a webinar.
Add panelists to a scheduled webinar.

Prerequisites: * Pro or a higher plan with the Webinar Add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: MEDIUM

Remove all the panelists from a webinar.

Prerequisites:

• Pro or a higher plan with the webinar add-on.
  

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Get a webinar's poll details.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Update a webinar's poll.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Delete a webinar's poll.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

List all the polls of a Webinar.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Create a poll for a webinar.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

List registration questions and fields that are to be answered by users while registering for a webinar.

Scheduling a webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the webinar.

Prerequisites:

• Pro or higher plan with the webinar add-on.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Update registration questions and fields of a scheduled webinar for users to answer during webinar registration. Scheduling a webinar with registration requires your registrants to complete a brief form with fields and questions before they can receive the link to join the 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,webinar:write:admin

Rate Limit Label: LIGHT

Update webinar registrants' registration status. You can approve or deny a registrant, or revoke a registrant's approval.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: MEDIUM

Zoom users with a webinar plan have access to creating and managing webinars. The webinar feature lets a host broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a webinar with registration 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.

Prerequisites:

• The account must have a webinar plan.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Delete a webinar registrant.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

List all users that have registered for a given webinar. Zoom users with a webinar plan have access to creating and managing webinars. The webinar functionality lets a host broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a webinar with registration requires your registrants to complete a brief form before receiving the link to join the webinar.

Prerequisites * Pro or higher plan with a Webinar Add-on.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM

Create and submit a user's registration for a webinar. Zoom users with a Webinar plan have access to creating and managing webinars. Webinars allow hosts to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a webinar with registration requires your registrants to complete a brief form before receiving the link to join the webinar.

Prerequisites: * A Pro or higher plan with the Webinar add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Get a webinar's SIP URI. The URI consists of the webinar ID, an optional user-supplied passcode, and participant identifier code. The API return data also includes additional fields to indicate whether the API caller has a valid Cloud Room Connector subscription, the participant identifier code from the URI, and the SIP URI validity period in seconds.

Scopes: webinar:write:admin:sip_dialing,webinar:write:sip_dialing

Rate Limit Label: LIGHT

Update a webinar's status. Use this API to end an ongoing webinar.

Prerequisites:

• The account must hold a valid Webinar plan.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Return information about a webinar survey.

Prerequisites: * A Pro or higher plan with the Webinar add-on. * The Webinar Survey feature enabled in the host's account.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Use this API to delete a webinar survey.

Prerequisites: * A Pro or higher plan with the Webinar Add-on. * The Webinar Survey feature enabled in the host's account.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Update a webinar survey. Prerequisites: * A Pro or higher plan with the Webinar add-on. * Enable the Webinar Survey feature in the host's account.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Use this API to get a webinar's closed caption token (caption URL). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom webinar.

Prerequisites: * A Pro or higher plan with the Webinar add-on. * The Closed captioning setting enabled in the Zoom web portal. * * The Allow use of caption API Token to integrate with 3rd-party Closed Captioning services setting enabled.

Scopes: webinar:read,webinar:read:admin

Rate Limit Label: Light

Webinar Registration Tracking Sources 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.

Prerequisites:

• Webinar license.
• Registration must be required for the Webinar.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: MEDIUM

Get details for a scheduled Zoom Webinar.

Prerequisites: * Pro or higher plan with a Webinar add-on.

Scopes: webinar:read:admin,webinar:read

Rate Limit Label: LIGHT

Delete a webinar.

Prerequisites:

• Pro or higher plan with the webinar add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

Make updates to a scheduled webinar.

100 requests per day. The rate limit is applied to the userId of the webinar host used to make the request.

Prerequisites * A Pro or higher plan with a webinar add-on.

Scopes: webinar:write,webinar:write:admin

Rate Limit Label: LIGHT

A H.323 or SIP device can make a video call to a Room Connector 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

Rate Limit Label: Light

A H.323 or SIP device can make a video call to a Room Connector 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

Rate Limit Label: Light

A H.323 or SIP device can make a video call to a Room Connector 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

Rate Limit Label: Medium

A H.323 or SIP device can make a video call to a Room Connector 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

Rate Limit Label: Light