Zoom

Zoom is a video conferencing and online meeting platform featuring breakout rooms, screen sharing, and integrations with various enterprise tools zoom · 105 tools · 11 triggers

Connect it

run auth zoom
run auth zoom --scope team    # shared with the organization

Or from the Integrations page in the console. See Connections for personal versus shared, and who may remove one.

Use it

run zoom          # common commands
run zoom --all    # every command

import { zoom } from "@boxd/run";

Common tools

Tool	What it does
`create-meeting`	Enable Zoom meeting creation via user-level apps with “me”. “Start_url” for hosts expires in 2 hours, or 90 days for “custCreate” users.
`delete-meeting`	Delete or cancel a scheduled Zoom meeting. Use occurrence_id to delete a specific occurrence of a recurring meeting.
`delete-recording-file`	Deletes a specific cloud recording file from a meeting or webinar.
`get-meeting`	Retrieves detailed information about a Zoom meeting by its ID.
`get-meeting-summary`	IMPORTANT: This action requires a PAID Zoom account (Pro, Business, or Enterprise plan).
`get-meeting-recordings`	To download meeting recordings, use `download_url`. Include OAuth token in the header for passcode-protected ones.
`get-user`	Retrieves detailed information about a specific Zoom user by ID, email, or ‘me’.
`list-all-recordings`	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.
`list-meetings`	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.
`list-meeting-summary-templates`	Tool to retrieve a list of meeting summary templates for a specified user.
`list-webinar-registrants`	Retrieves the list of registrants for a webinar with registration enabled.
`search-company-contacts`	Tool to search company contacts in Zoom by first name, last name, or email.

All 100 tools

Tool	What it does
`add-meeting-registrant`	Registers a participant for a Zoom meeting that has registration enabled. Prerequisites: - The meeting host must have a **licensed (paid) Zoom…
`add-webinar-registrant`	Registers a participant for a Zoom webinar that has registration enabled. Prerequisites: - The webinar host must have a **Pro or higher plan with…
`add-project-collaborators`	Adds one or more collaborators to a whiteboard project. Use this action when you want to invite team members or external users to collaborate on a…
`add-whiteboard-collaborator`	Adds one or more collaborators to a whiteboard. Use this action when you need to invite users or team chat channels to collaborate on a specific whiteboard.
`apply-classification-to-whiteboard`	Applies or updates a classification label on a whiteboard. Use this action when you need to assign or change a security classification label on an existing whiteboard.
`create-meeting`	Enable Zoom meeting creation via user-level apps with “me”. “Start_url” for hosts expires in 2 hours, or 90 days for “custCreate” users.
`create-iq-conversation`	DEPRECATED: Use ZOOM_CREATE_ZRA_CONVERSATION instead (Zoom rebranded IQ to ZRA).
`create-iq-conversation-comment`	DEPRECATED: Use ZOOM_CREATE_ZRA_CONVERSATION_COMMENT instead (Zoom rebranded IQ to ZRA).
`create-iq-user-conversation`	DEPRECATED: Use ZOOM_CREATE_ZRA_USER_CONVERSATION instead (Zoom rebranded IQ to ZRA).
`create-project`	Creates a new whiteboard project in Zoom. Use when you need to organize and group whiteboards together, optionally adding collaborators and…
`create-whiteboard`	Creates a new whiteboard for the authenticated user. Use when you need to create a blank whiteboard that can be shared and collaborated on with others.
`create-whiteboard-export`	Creates an export task to generate PDF exports and audit logs for specified whiteboards.
`create-zra-conversation`	Tool to create a new conversation in Zoom Revenue Accelerator (ZRA).
`create-zra-conversation-comment`	Tool to create a comment on a Zoom Revenue Accelerator conversation.
`create-zra-crm-accounts`	Tool to create or update CRM accounts in Zoom Revenue Accelerator (ZRA).
`create-zra-crm-contacts`	Tool to bulk import or delete CRM contacts in Zoom Revenue Accelerator.
`create-zra-crm-deals`	Tool to bulk import or delete CRM deals in Zoom Revenue Accelerator (ZRA).
`create-zra-crm-leads`	Tool to bulk import CRM leads into Zoom Revenue Accelerator (ZRA).
`create-zra-crm-settings`	Tool to register a new CRM API integration for Zoom Revenue Accelerator (ZRA).
`create-zra-user-conversation`	Tool to create a new conversation in Zoom Revenue Accelerator for a specific user.
`delete-meeting`	Delete or cancel a scheduled Zoom meeting. Use occurrence_id to delete a specific occurrence of a recurring meeting.
`delete-iq-conversation`	DEPRECATED: Use ZOOM_DELETE_ZRA_CONVERSATION instead (Zoom rebranded IQ to ZRA).
`delete-iq-conversation-comment`	DEPRECATED: Use ZOOM_DELETE_ZRA_CONVERSATION_COMMENT instead (Zoom rebranded IQ to ZRA).
`delete-iq-deal-activities`	DEPRECATED: Use ZOOM_DELETE_ZRA_DEAL_ACTIVITIES instead (Zoom rebranded IQ to ZRA).
`delete-meeting-recordings`	Deletes all cloud recordings for a meeting or webinar. Requires the account to have Cloud Recording enabled.
`delete-project`	Deletes a whiteboard project by its ID. Deleting a project removes all associated whiteboards from the project.
`delete-project-collaborator`	Removes a collaborator from a whiteboard project. Use this action when you need to revoke a user’s access to a specific whiteboard project.
`delete-recording-file`	Deletes a specific cloud recording file from a meeting or webinar.
`delete-whiteboard`	Deletes a whiteboard by its unique identifier. Use when you need to permanently remove a specific whiteboard from Zoom.
`delete-whiteboard-collaborator`	Removes a collaborator from a whiteboard. Use this action when you need to revoke a user’s access to a specific whiteboard by removing them as a collaborator.
`delete-zra-conversation`	Deletes a ZRA (Zoom Revenue Accelerator) conversation by ID.
`delete-zra-conversation-comment`	Tool to delete a comment from a Zoom Revenue Accelerator conversation.
`delete-zra-crm-settings`	Deletes CRM settings for Zoom Revenue Accelerator (ZRA). Use when you need to remove CRM configuration from the account.
`delete-zra-deal-activities`	Tool to delete activities from a Zoom Revenue Accelerator (ZRA) deal.
`download-imported-whiteboard-file`	Downloads a specific file that was imported into a whiteboard, including images, PDFs, DOCX, and other supported file formats.
`download-whiteboard-export`	Downloads the exported whiteboard content for a completed whiteboard export task.
`download-whiteboard-session-activity`	Downloads the activity archive file for a whiteboard archiving session.
`get-meeting`	Retrieves detailed information about a Zoom meeting by its ID.
`get-meeting-summary`	IMPORTANT: This action requires a PAID Zoom account (Pro, Business, or Enterprise plan).
`get-webinar`	Access Zoom Webinar details requires Pro or higher plan and Webinar add-on.
`get-daily-usage-report`	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.
`get-iq-conversation-comments`	DEPRECATED: Use ZOOM_GET_ZRA_CONVERSATION_COMMENTS instead (Zoom rebranded IQ to ZRA).
`get-iq-conversation-content-analysis`	Tool to retrieve content analysis for a Zoom IQ conversation by its ID.
`get-iq-conversation-interactions`	DEPRECATED: Use ZOOM_GET_ZRA_CONVERSATION_INTERACTIONS instead (Zoom rebranded IQ to ZRA).
`get-iq-conversation-scorecards`	DEPRECATED: Use ZOOM_GET_ZRA_CONVERSATION_SCORECARDS instead (Zoom rebranded IQ to ZRA).
`get-iq-deal`	Tool to get details of a specific deal in Zoom Revenue Accelerator (formerly Zoom IQ).
`get-iq-deal-activities`	DEPRECATED: Use ZOOM_GET_ZRA_DEAL_ACTIVITIES instead (Zoom rebranded IQ to ZRA).
`get-iq-user-conversations-playlists`	DEPRECATED: Use ZOOM_LIST_ZRA_USER_CONVERSATION_PLAYLISTS instead (Zoom rebranded IQ to ZRA).
`get-marketplace-user-apps`	Retrieves a paginated list of Zoom Marketplace apps installed for a specific user.
`get-marketplace-user-entitlements`	Retrieves marketplace entitlements for a specific Zoom user by ID or ‘me’.
`get-meeting-recordings`	To download meeting recordings, use `download_url`. Include OAuth token in the header for passcode-protected ones.
`get-past-meeting-participants`	Retrieves the list of participants who attended a past (ended) Zoom meeting.
`get-project`	Retrieves detailed information about a specific whiteboard project by its ID.
`get-user`	Retrieves detailed information about a specific Zoom user by ID, email, or ‘me’.
`get-whiteboard`	Retrieves details about a specific whiteboard document. Returns comprehensive whiteboard information including name, creation/modification dates…
`get-whiteboard-export-status`	Retrieves the status of a whiteboard export task by its task ID.
`get-whiteboard-session`	Retrieves detailed information about a specific whiteboard session by its session ID.
`get-zra-conversation-comments`	Tool to retrieve comments for a specific Zoom Revenue Accelerator (ZRA) conversation.
`get-zra-conversation-interactions`	Retrieves interaction details for a specific Zoom Revenue Accelerator (ZRA) conversation.
`get-zra-conversation-scorecards`	Tool to retrieve scorecards for a specific conversation in Zoom Revenue Accelerator.
`get-zra-deal-activities`	Tool to retrieve activities associated with a Zoom Revenue Accelerator (ZRA) deal.
`import-whiteboard`	Initiates an import of a whiteboard from an external source (Miro, Mural, or Visio files).
`list-all-recordings`	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.
`list-archived-files`	Lists archived meeting and webinar files within a specified date range (max 7 days).
`list-devices`	Lists devices in your Zoom account managed through Zoom Device Management (ZDM).
`list-iq-conversations`	DEPRECATED: Use ZOOM_LIST_ZRA_CONVERSATIONS instead (Zoom rebranded IQ to ZRA).
`list-iq-deals`	DEPRECATED: Use ZOOM_LIST_ZRA_DEALS instead (Zoom rebranded IQ to ZRA).
`list-marketplace-app-custom-fields`	Tool to retrieve custom fields configured for a Zoom Marketplace app.
`list-meetings`	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.
`list-meeting-summary-templates`	Tool to retrieve a list of meeting summary templates for a specified user.
`list-past-meeting-instances`	Tool to retrieve all UUIDs for past instances of a given meeting.
`list-project-collaborators`	Lists all collaborators for a whiteboard project, including their roles and permissions.
`list-projects`	Lists all whiteboard projects accessible to the user. Returns project metadata including ID, name, owner, and timestamps.
`list-users-collaboration-devices`	Tool to list collaboration devices associated with a user. Use when you need to retrieve information about a user’s collaboration devices.
`list-users-settings`	Tool to retrieve a user’s settings including meeting scheduling, in-meeting features, email notifications, recording, telephony, and security preferences.
`list-webinar-participants`	Get a list of past webinar participants with a Pro plan or above plus an add-on.
`list-webinar-registrants`	Retrieves the list of registrants for a webinar with registration enabled.
`list-webinars`	The API lists all scheduled webinars for Zoom users with a webinar plan, using `me` for user-level apps.
`list-whiteboards`	Lists all whiteboards accessible to the user. Returns whiteboard metadata including ID, name, owner, and timestamps.
`list-zra-conversations`	Tool to list all conversations in Zoom Revenue Accelerator. Use when you need to retrieve analytics data from Revenue Accelerator conversations…
`list-zra-crm-accounts`	Lists CRM accounts from Zoom Revenue Accelerator by account IDs.
`list-zra-crm-contacts`	Tool to retrieve CRM contact information from Zoom IQ Revenue Accelerator (ZRA).
`list-zra-crm-deals`	Tool to retrieve CRM deal information from Zoom Revenue Accelerator (ZRA).
`list-zra-crm-leads`	Tool to retrieve CRM lead information from Zoom IQ Revenue Accelerator (ZRA).
`list-zra-crm-settings`	Tool to retrieve the current CRM API registration information for Zoom Revenue Accelerator (ZRA).
`list-zra-deals`	Tool to list deals from Zoom Revenue Accelerator (ZRA). Returns deal information including name, amount, stage, and owner details.
`list-zra-scheduled`	Tool to list scheduled Zoom Revenue Accelerator (ZRA) items.
`list-zra-settings-indicators`	Tool to retrieve account indicator settings for Zoom Revenue Accelerator (ZRA).
`list-zra-user-conversation-playlists`	Tool to list conversation playlists for a specific user in Zoom Revenue Accelerator.
`move-whiteboards-to-project`	Moves one or more whiteboards to a specified Zoom Whiteboard project.
`remove-whiteboard-classification`	Removes the classification label from a whiteboard. Use this action when you need to unassign or clear a security classification label from an existing whiteboard.
`remove-whiteboards-from-project`	Removes one or more whiteboards from a specified Zoom Whiteboard project.
`search-company-contacts`	Tool to search company contacts in Zoom by first name, last name, or email.
`update-meeting`	To update a meeting via API, ensure `start_time` is future-dated; `recurrence` is needed.
`update-classification-label`	Updates an existing classification label in Zoom Whiteboard.
`update-iq-conversation-comment`	DEPRECATED: Use ZOOM_UPDATE_ZRA_CONVERSATION_COMMENT instead (Zoom rebranded IQ to ZRA).
`update-iq-conversation-host`	DEPRECATED: Use ZOOM_UPDATE_ZRA_CONVERSATION_HOST instead (Zoom rebranded IQ to ZRA).
`update-project`	Updates the name of an existing whiteboard project in Zoom. This action allows you to rename a project to better reflect its content or purpose.
`update-project-collaborators`	Updates collaborator permissions for a whiteboard project. Use this action when you need to change the permission level of one or more collaborators…
`update-whiteboard-collaborator`	Updates collaborator settings for a whiteboard. Changes the permission role for one or more collaborators on the whiteboard.

Triggers (11)

Subscribe with .on(...) in a script. A trigger with required configuration takes it as the second argument.

Trigger	Needs	What fires it
Daily Usage Report Changed	nothing	Triggers when the Zoom daily usage report changes for a selected year/month.
Meeting Details Changed	`meeting_id`	Triggers when a specific meeting’s details change.
Meeting Recording Changed	`meeting_id`	Triggers when a specific meeting’s cloud recordings change.
Meeting Summary Created or Updated	`meeting_id`	Triggers when a meeting summary is created or updated for a specific meeting.
New Cloud Recording	nothing	Triggers when a new cloud recording meeting instance appears for a user.
New Meeting Created	nothing	Triggers when a new Zoom meeting is created for a user.
New Meeting Participant	`meeting_id`	Triggers when a new participant appears in a past meeting’s participant report.
New Webinar Created	nothing	Triggers when a new webinar is created for a user.
New Webinar Participant	`webinar_id`	Triggers when a new participant appears in a past webinar’s participant list.
User Information Changed	`user_id`	Triggers when a Zoom user’s information changes.
Webinar Details Changed	`webinar_id`	Triggers when a Zoom webinar’s details change.

Open Zoom in the console →

Getting started

Guides

Integrations & automations

Use cases

References

Connect it

Use it

Common tools

Triggers (11)

​Connect it

​Use it

​Common tools

​Triggers (11)

Connect it

Use it

Common tools

Triggers (11)