Generated banner for Build Zoom Rest API App
Generated logo for Build Zoom Rest API App

Build Zoom Rest API App

OpenAIOfficialCreated by ZoomDistributed by OpenAI

  • Skill
  • Tool integration
  • Software development
  • MIT
  • Medium risk

From the author

Use when calling REST APIs.
— the description by Zoom

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured approach to interacting with the Zoom REST API. It offers guidance on selecting appropriate authentication flows, managing resources such as meetings and users, and implementing robust API interaction patterns like pagination and rate-limit handling. It includes reference documentation for various Zoom product areas, including account management and AI Companion services, to assist developers in building API-integrated applications.

What it does

  • Provides endpoint inventories for Zoom API product areas.
  • Outlines authentication requirements for user-level, account-level, and server-to-server workflows.
  • Defines patterns for implementing API wrappers with pagination and retry logic.
  • Offers guidance on webhook processing, including signature verification.
  • Assists in troubleshooting common API issues like scope mismatches and rate limits.

When to use it

  • When developing applications that need to programmatically manage Zoom meetings, users, or recordings.
  • When integrating Zoom account settings or dashboard metrics into custom software.
  • When setting up event-driven workflows using Zoom webhooks.
  • When debugging authentication or scope-related errors during Zoom API integration.

Advantages

  • Centralizes access to official Zoom API endpoint documentation.
  • Standardizes the implementation of API interaction patterns.
  • Clarifies the selection of correct authentication scopes for different API operations.
  • Provides a clear methodology for handling API rate limits and resource management.

Usage examples

“How do I list meeting participants using the Zoom API?”
The agent provides the correct endpoint path from the dashboard references and explains the necessary OAuth scopes and pagination requirements.
“What authentication should I use for an account-level Zoom integration?”
The agent guides you through the account-level OAuth flow requirements as defined in the authentication documentation.

Install

  1. Download the skill as a ZIP:

    https://autogineer.com/agent-skills/openai/build-zoom-rest-api-app/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip build-zoom-rest-api-app.zip -d .agents/skills

Documentation by Zoom

Build Zoom REST API App

Use this skill when the task needs deterministic Zoom API calls or resource management from application code.

Workflow

  1. Define the resource and actor: user, meeting, webinar, recording, docs, chat, phone, account, or admin-level workflow.

  2. Select the endpoint and required scopes from the reference files before coding.

  3. Confirm auth fit: user-level OAuth for user-owned resources, account-level OAuth for admin workflows, and only use server-to-server OAuth where the target API documents support for it.

  4. Implement narrow API wrappers with explicit pagination, retry, idempotency, and rate-limit handling.

  5. Treat webhook processing as a separate event-ingestion path with signature verification and replay protection.

  6. Debug by checking token audience, missing scopes, resource ownership, account settings, API enablement, and rate-limit headers.

References

Files

references/commerce.md

Zoom Commerce API

Authoritative endpoint inventory for Commerce. This file mirrors the official Zoom API Hub OpenAPI document for this product area.

Canonical Source

Notes

  • Endpoint methods and paths below are generated from the official Zoom API Hub paths object.

  • Scope names are defined per operation and frequently use granular scope names. Check the API Hub operation page for the exact scopes before implementation.

  • Use this file for endpoint discovery and inventory. Use ../examples/ for orchestration patterns, not as the canonical source of path names.

Coverage

MetricValue
Endpoint operations33
Path templates31
Tags8

Tag Index

TagOperations
Account Management4
Billing3
Deal Registration5
Order4
Platform3
Product Catalog3
Quote6
Subscription5

Endpoints by Tag

Account Management
MethodEndpointSummaryOperation ID
POST/commerce/accountCreate an end customer accountcreateAccount
POST/commerce/account/{accountKey}/contactsAdd contacts to an existing end customer or your own account.addAccountContact
GET/commerce/accountsGet the list of all accounts associated with a Zoom Partner/Sub-Reseller, by the account typegetAllAccounts
GET/commerce/accounts/{accountKey}Get the account details for a Zoom Partner/Subreseller/End CustomergetAccountDetails
Billing
MethodEndpointSummaryOperation ID
GET/commerce/billing_documentsGets all billing documents for a distributor or a resellergetAllBillingDocs
GET/commerce/billing_documents/{documentNumber}/documentGets the PDF document for the billing document IDdownloadBillingDoc
GET/commerce/invoices/{invoiceNumber}Get detailed information about a specific invoice for a distributor or a resellergetInvoiceDetail
Deal Registration
MethodEndpointSummaryOperation ID
GET/commerce/campaignsRetrieves all valid Zoom Campaigns which a deal registration can be associated with.getCampaigns
POST/commerce/deal_registrationCreates a new deal registration for a partnercreateDealReg
GET/commerce/deal_registrationsGets all valid Deal Registrations for a partnergetAllDealRegs
GET/commerce/deal_registrations/{dealRegKey}Get details of a deal registration by registration numbergetDealRegDetails
PATCH/commerce/deal_registrations/{dealRegKey}Updates an existing deal registrationUpdatesanexistingdealregistration
Order
MethodEndpointSummaryOperation ID
POST/commerce/orderCreate a subscription order for a Zoom partnercreateOrder
POST/commerce/order/previewPreview delta order metrics and subscriptions in an ordercreateOrderPreview
GET/commerce/ordersGets all orders for a Zoom partner.getAllOrders
GET/commerce/orders/{orderReferenceId}Get order details by order reference IDgetOrderDetails
Platform
MethodEndpointSummaryOperation ID
POST/commerce/fileUpload an attachment pdf file in context of a deal registration or quoteuploadFile
GET/commerce/files/{associatedReferenceId}/detailsGets details of all files associated with a quote or deal registrationallFileDetails
GET/commerce/files/{documentReferenceId}Download a file associated with a quote or deal registration.downloadFile.
Product Catalog
MethodEndpointSummaryOperation ID
POST/commerce/catalogGets Zoom Product Catalog for a Zoom PartnergetOffers
GET/commerce/catalog/{offerId}Gets the details for a Zoom product or offer.getOfferDetail
GET/commerce/pricebooksGets the pricebook in a downloadable filedownloadPricebook
Quote
MethodEndpointSummaryOperation ID
POST/commerce/quoteCreate a subscription quote for a Zoom PartnercreateQuote
POST/commerce/quote/previewPreview delta quote metrics and subscriptions in a quotecreateQuotePreview
GET/commerce/quotesGets all quotes for a Zoom partnergetAllQuotes
GET/commerce/quotes/{quoteReferenceId}Get quote details by quote reference IDgetQuoteDetails
PATCH/commerce/quotes/{quoteReferenceId}Update a subscription quote for a Zoom partnerupdateQuote
PATCH/commerce/quotes/{quoteReferenceId}/fulfillmentSubmits a subscription quote for provisioningprovisionQuote
Subscription
MethodEndpointSummaryOperation ID
GET/commerce/subscriptionsGets paid subscriptions for a Zoom partner.getAllSubscriptions
GET/commerce/subscriptions/{subscriptionNumber}Gets subscription details for a given subscription numbergetSubscriptionDetails
GET/commerce/subscriptions/{subscriptionNumber}/versionsGets subscription changes/versions for a given subscription number.getSubscriptionVersions
GET/commerce/trialsGet trial subscriptions for a Zoom partnergetAllTrialSubscriptions
GET/commerce/trials/{trialReferenceId}Get trial details for an end customer by their Zoom account number or the trial IDgetTrialDetails

Requirements and compatibility

Written for: OpenAI Codex

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Security

What our scanner noticed· Medium risk

  • Possible data-exfiltration endpoints
  • Instructions that use the network

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

Created by
Zoom
Publisher
OpenAI (Official)
Distributed by
OpenAI
Source
openai/plugins · plugins/zoom/skills/rest-api · commit d420d13
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from plugins/zoom/LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Zoom or OpenAI.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download build-zoom-rest-api-app.zip