Zoom

Enable zoom meeting creation via user-level apps with "me". "start url" for hosts expires in 2 hours, or 90 days for "custcreate" users. renew via api, capped at 100 requests/day. requires "meeting:write" permission, subject to medium rate limit.

Delete a meeting registrant. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

The text provides details on api permissions for reading meeting information, categorizing permissions into general and granular scopes, and labels the rate limit as 'light'.

Meeting summary info requires a pro+ host plan, ai companion enabled, excluding e2ee meetings. scopes include meeting summary:read and admin versions. rate limit: light.

To download meeting recordings, use `download url`. include oauth token in the header for passcode-protected ones. supports `recording:read` and `phone recording:read:admin` scopes, with a `light` rate limit.

This text details how to list zoom cloud recordings for a user, notably by using "me" for user-level apps and requiring an oauth token for access. it requires a pro plan, cloud recording enabled, and has a medium rate limit.

This zoom api lists a user's scheduled meetings using the `me` value for user-level apps, excluding instant meetings and only showing unexpired ones. it requires specific scopes and has a `medium` rate limit.

Update the status of a meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

This text guides on creating and customizing a user's registration for a zoom meeting, with a max of 4,999 registrants. preconditions include the host being licensed. api scopes and a light rate limit apply.

Add a new device to a zoom account, requiring `device:write:admin` scope with a `medium` rate limit.

Add a user's tsp account. **scopes:** `tsp:write:admin`,`tsp:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Zoom users with a webinar plan can create and manage webinars, broadcasting to up to 10,000 attendees. registration requires a pro plan, specific permissions, and is governed by a "light" rate limit.

Panelists in webinars have access to more features like video sharing and screen sharing compared to attendees. adding panelists requires a pro or higher zoom plan with webinar add-on and specific scopes. rate limit label is medium.

Assign, move, or remove a device for a user/common area within zoom device management (zdm). requires the device to be enrolled in zdm and appropriate admin scopes. rate limit category is medium.

Change device name. **prerequisites:** * device must be enrolled in zmd (zoom device management) **scopes:** `device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`

Api allows changing zoom room device associations, requiring enrollment in zoom device management (zmd) with admin write access. rate limit is medium.

H.323/sip devices can join or be called into zoom meetings via room connector. use the api to add devices to your zoom account. rate limit: light.

Meeting hosts can create polls for attendees if using a pro or higher plan, with the polling feature enabled, and for scheduled meetings only. rate limit: light.

Create a meeting template from an existing meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`

Zoom offers on-demand cloud recordings of past meetings, accessible to registered users via an api. api scopes required are `recording:write:admin` and `recording:write`, with a 'light' rate limit.

Use the api to create tracking fields for zoom, allowing analysis of usage by organization fields. prerequisites include a business or higher plan. rate limit is light.

To schedule a host's webinar, use 'me' in user-level apps. max 10,000 attendees, 100 daily requests. needs pro plan or higher, webinar add-on, `webinar:write` scopes, and falls under 'light' rate limit.

Use the api to create up to 20 name tags for a webinar's session branding. requires enabled webinar session branding setting and `webinar:write`, `webinar:write:admin` scopes. rate limit is medium.

Learn how to create a poll for a webinar, including permissions needed (webinar:write, admin) and specific abilities (poll creation). rate limit category is light.

Use this api to create a webinar template from an existing webinar. **scopes:** `webinar:write:admin`,`webinar:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `medium`

Create a batch of invitation links for a meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Generate webinar invitation links requiring a business, education, or api plan with add-on. necessary scopes include `webinar:write` and `webinar:write:admin` with granular scopes for invitation links. rate limit is light.

A h.323/sip device can join or be called into a zoom meeting via a room connector. this api allows for the deletion of such a device from a zoom account. it has an `h323:write:admin` scope and a `light` rate limit.

Delete a message in a zoom live meeting using the api, requires dlp enabled for in-meeting chat. applicable scopes are `meeting:write` and `meeting:write:admin`. rate limit is classified as `medium`.

This api lets you delete a specific message in a live webinar by id. required: zoom's dlp for in-meeting chat enabled. scopes needed are `webinar:write` and `webinar:write:admin`, with a `medium` rate limit.

Delete a meeting. **scopes:** `meeting:write:admin`,`meeting:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Meeting hosts can survey attendees using polls, but polls must be deleted post-meeting. requirements: pro account, enabled polling, and a scheduled meeting. rate limit: light.

To delete a meeting recording, enable "the host can delete cloud recordings" in zoom's recording settings. permissions needed are `recording:write:admin` and `recording:write` with a light rate limit.

To delete a zoom meeting survey, the host needs a pro account with the survey feature enabled for scheduled meetings. permissions: `meeting:write`, `meeting:write:admin`. rate limit: `light`.

Api to delete all meeting's archived files requires meeting/webinar archiving enabled and scopes `recording:write:admin`, `recording:write`. rate limit: light.

This api allows deletion of zoom tracking fields. requirements: business, education, api plan, or higher. needs admin permissions with `tracking fields:write:admin` scope. rate limit is light.

Delete a user's tsp account. **scopes:** `tsp:write:admin`,`tsp:write` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

To delete a webinar, you need a pro plan or higher with the webinar add-on. required scopes are `webinar:write` and `webinar:delete:webinar`. rate limit is light.

Guidelines for deleting a webinar's poll feature in zoom, requiring 'webinar:write' and admin permissions, with granular scopes for poll deletion. rate limit label is 'light'.

Guide to deleting webinar registrants, requiring `webinar:write` or admin permissions and specific granular scopes. rate limit level: light.

Use the api to delete zoom webinar surveys if you have a pro plan or higher, the survey feature enabled, and the right scopes. rate limit is light.

This api removes a webinar's session branding name tag. requirements include enabled webinar session branding setting. it needs `webinar:write` or `webinar:write:admin` scopes, with a `light` rate limit.

This api allows the deletion of webinar session branding, specifically virtual backgrounds. requires the webinar session branding setting enabled. accessible with `webinar:write` and `webinar:write:admin` scopes. rate limit is light.

This api removes a webinar's session branding wallpaper file, requiring the webinar session branding setting and `webinar:write` or `webinar:write:admin` scopes. it has a light rate limit.

Delete a device from a zoom account. **prerequisites:** * device must be enrolled in zmd (zoom device management) **scopes:** `device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `heavy`

Summary: to delete all meeting recordings, ensure the user's account has cloud recording enabled. required permissions include `recording:write:admin` and `recording:write` with a `light` rate limit label.

This api deletes a zoom account's sip phone, supported only on cisco and avaya pbx systems. users must enable sip phone integration via zoom sales. scope required: `sip phone:write:admin` with a `light` rate limit.

To remove a zpa device in the device manager by vendor and mac, use scopes `device:write:admin`, `device:delete:zpa device:admin`, and `device:delete:zpa device:master`. rate limit: medium.

Zoom's psi allows integration of sip phones with supported pbx systems (cisco, avaya) for softphone functionality within zoom. requires enabling by account owner/admin through sales. scope: `sip phone:write:admin`, rate limit: `light`.

Access telephony service provider info at account level requires a pro plan or higher, `tsp:read:admin` scope, and falls under `light` rate limit according to zoom's api.

Generate reports for active or inactive hosts within the last 6 months, limited to a month's range. active hosts have hosted meetings; inactive have not. requires pro plan or higher and specific admin permissions. rate limit: heavy.

Zoom offers an archiving solution for accounts to automate the recording and collection of meeting/webinar data for compliance. it requires meeting/webinar archiving enabled and has a medium rate limit.

Meeting hosts can survey attendees through polls, with details available via a provided link. it requires `meeting:read:admin` and `meeting:read` permissions and has a `light` rate limit.

Details on a specific user registered for a zoom meeting can be accessed by a host or admin with permissions. requires a meeting plan and the scopes `meeting:read:admin` and `meeting:read`. rate limit label is `light`.

The api retrieves a meeting's sip uri, including meeting id, optional passcode, and participant code, plus subscription status, participant code, and uri validity. scopes and rate limit are specified.

Zoom's post-meeting survey and reporting require a pro license, enabled survey feature, and scheduled meeting setup. it applies to `meeting:read` and `meeting:read:admin` scopes with a `light` rate limit.

To access archived files for a specific meeting, ensure your account has the meeting and webinar archiving feature enabled by zoom support. requires `recording:read` scope. rate limit label: light.

Get a meeting archive token for sdk apps or bots to access real-time raw media streams. requires a pro plan or higher and activating **archive meetings and webinars** in zoom settings. scope: `meeting token:read:admin:local archiving`. rate limit: light.

To live stream a zoom meeting, obtain a join token for a recording bot using the zoom sdk, which supports regular and raw streaming. requires a pro plan, livestreaming enabled, and specific scopes. rate limit: light.

Obtain a join token for a zoom meeting to enable a recording bot, using the sdk, to connect and start local recording. requires enabling local recording in zoom settings. applicable rate limit: light.

This api provides details on zoom's scheduling tracking fields. it requires a business, education, api, or higher plan with `tracking fields:read:admin` scope. the rate limit label is `light`.

This api retrieves details for a user's specific tsp account, with a two-account maximum per user. it requires `tsp:read:admin` or `tsp:read` scopes and has a 'light' rate limit.

Access zoom webinar details requires pro or higher plan and webinar add-on. scopes include `webinar:read:admin` and `webinar:read`. granular scopes and a 'light' rate limit also apply.

Access webinar poll details with `webinar:read:admin` or `webinar:read` scopes. for specific poll info, use `webinar:read:poll` or its admin version. it's under `light` rate limit.

Zoom's webinar feature supports broadcasting to up to 10,000 attendees, requiring registration and a webinar plan. it includes an api for user details and comes with a 'light' rate limit.

To obtain a webinar's sip uri, include its id, any passcode, and participant code. api also displays subscription status, participant code, and uri lifespan. necessary scopes and a light rate limit apply.

Zoom's webinar survey feature requires a pro or higher plan and an add-on, enabled in the host's account. it's governed by scopes (`webinar:read:admin`, `webinar:read`) and granular scopes, with a `light` rate limit.

This api provides a webinar's archive token for real-time access to raw audio and video streams, requiring a pro plan, webinar add-on, and enabled archive settings. rate limit: light.

Api provides a webinar archive token for live streaming via zoom sdk and supports both live and raw streaming. prerequisites include pro plan with webinar add-on and enabling streaming in settings. scopes and light rate limit apply.

Api provides a join token for webinar local recording via a bot using zoom sdk, supporting standard and raw types. requires pro plan, webinar add-on, and enabled setting. scopes: webinar token:read. rate limit: light.

Access department billing invoices using `billing id` from the get billing reports api. requires pro account, department billing, `report:read:admin`, and `report:read:billing invoice:admin` scope. heavy rate limits apply.

To get zoom account department billing reports, require a pro/higher account with department billing enabled and permission scopes `report:read:admin` and `report:read:billing:admin`. contact zoom support for setup. note: heavy rate limits apply.

Get cloud recording usage report for the last 6 months, up to yesterday, with a max date range of 30 days. requires pro plan or higher, `report:read:admin` scope, and has a `heavy` rate limit.

The daily report provides zoom service usage details, like new users, meetings, participants, and minutes per day for a month, requiring a pro plan or higher. it has a 'heavy' rate limit.

Retrieve a device's details. **scopes:** `device:read:admin`,`device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `heavy`

Zoom supports livestreaming meetings to a custom platform, requiring a pro plan or higher, pre-configuration of streaming details, and observing rate limits. it provides stream url, stream key, and page url for the stream.

Zoom webinar live stream setup requires pro plan or higher, webinar add-on, and pre-configured streaming details. it supports custom platforms, including stream url, stream key, and page url. rate limit: light.

Obtain a thorough report for a previous meeting. requirements: pro plan or higher, with admin rights to read reports. rate limit is categorized as heavy.

Retrieve the meeting invitation note for a specific meeting. **scopes:** `meeting:read`,`meeting:read:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Use this api to generate past meeting reports with multiple participants, excluding solo participant reports. note: information may be limited without a hipaa baa. requires pro plan, specific admin scopes, and adheres to heavy rate limits.

This api allows fetching past meeting poll results. requirements: pro plan or higher, `report:read:admin` and `report:read:list meeting polls:admin` scopes. rate limit is heavy.

Summary: access past meeting q&a reports requires a pro plan or higher, with `report:read:admin` and `report:read:meeting qna:admin` scopes. note the `heavy` rate limit label.

This text outlines the api for retrieving zoom cloud recording settings for meetings, specifying required scopes (`recording:read:admin` and `recording:read`) and indicating a `light` rate limit label.

Access zoom meeting recording analytics and download within 1 month using oauth token in the authorization header. requires scopes `recording:read:admin`,`recording:read` with a medium rate limit.

Access zoom meeting recording analytics with a 1-month max duration using an oauth token. use specific api scopes and note the medium rate limit. example: `curl` command with authorization header.

Retrieve reports on past zoom meetings and webinars within a six-month period, limited to one month at a time, requiring at least two unique participants. applicable for pro plans or higher, with specific admin scopes. rate limit label: heavy.

To access past meeting survey reports on zoom, a pro or higher plan is needed, with `report:read:admin` and `report:read:meeting survey:admin` permissions. rate limit label is `heavy`.

Get a zoom meeting closed caption token to use with third-party captioning services by enabling specific settings. it requires meeting read permissions and has a 'light' rate limit.

The zoom operations logs report allows auditing of user and admin actions like additions, setting adjustments, and recording deletions within a period. it requires at least a pro plan and specific scopes, with a high rate limit.

Get information about a past meeting. **scopes:** `meeting:read:admin`,`meeting:read` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `light`

Api allows paid users (pro+) to fetch past meeting attendee info, excluding solo participants. requires double encoding for certain uuids, with `meeting:read` scope and others. rate limit is medium.

Use the api to fetch questions displayed for user registration to view specific meeting on-demand recordings. includes fields for question inclusion. scopes: `recording:read:admin`, `recording:read`. rate limit: light.

Get zoom user sign in/out logs with a pro plan or higher. requires `report:read:admin` and `report:read:user activities:admin` scopes. rate limit is heavy.

The telephone report api offers data on who joined meetings by phone, their dial-in number, and more, for a given time. it requires a pro plan, specific admin read scopes, and has a heavy rate limit.

This api lists upcoming meetings/webinars within a month for users with a pro plan or higher. it requires `report:read:admin` and `report:read:upcoming meetings webinars:admin` scopes. rate limit: heavy.

This text details api permissions for viewing absentees of a webinar, including specific scopes and granular scopes, and notes that the rate limit label for this action is categorized as "heavy."

Access past webinar details through a report, requiring a pro or higher plan with webinar add-on. it needs `report:read:admin` and `report:read:webinar:admin` scopes and is subject to a `heavy` rate limit.

Access detailed reports on webinar attendees for up to 6 months. requires pro or higher plan with webinar add-on. necessary scopes include `report:read:admin` and `report:read:list webinar participants:admin`. rate limit label: heavy.

Access past webinar polls report on zoom with a pro/higher plan and webinar add-on. requires `report:read:admin` and `report:read:list webinar polls:admin` permissions. rate limit: heavy.

Summary: get a report of q&as from past webinars, requiring a pro/higher plan with webinar add-on, and specific admin permissions. rate limit category: heavy.

Access past webinar survey reports with a pro plan or higher and webinar add-on. requires `report:read:admin` and `report:read:webinar survey:admin` scopes. note: heavy rate limit applies.

This api lets you customize webinars with wallpapers and virtual backgrounds for participants, requiring a pro plan, webinar add-on, and session branding enabled. rate limit: light.

Get a closed caption token for zoom webinars to enable third-party closed captioning by visiting the provided link. requires a pro plan, webinar add-on, and specific settings enabled. rate limit: light.

Zoom's webinar registration tracking sources feature allows users to analyze where registrants come from, aiding in marketing strategy optimization. it needs a webinar license, registration, and permissions, with a 'medium' rate limit.

Retrieve zoom device manager group details for an account, requiring `device:read:admin` or granular `device:read:list groups:admin/master` permissions. rate limit: medium.

Get zpa firmware/app version upgrade info. scopes: `device:read:admin`. granular: `device:read:list zpa versions:admin`, `device:read:list zpa versions:master`. rate limit: medium.

Zoom's archiving solution enables administrators to automatically record and archive meeting data to third-party platforms for compliance, needing the meeting and webinar archiving feature enabled.

To list a user's pac accounts on zoom, use the 'me' value for user-level apps. requires pro plan or higher with audio conferencing subscription and pac enabled. scopes: `pac:read:admin`, `pac:read`. rate limit: light.

The text outlines zoom webinar's api for listing polls, including required scopes (`webinar:read:admin`, `webinar:read`, `webinar:read:list polls`, `webinar:read:list polls:admin`) and mentioning its `light` rate limit label.

This api lets you list devices. **scopes:** `device:read:admin`,`device:write:admin` **[rate limit label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `heavy`