Build Zoom Rest API App
OpenAIOfficialCreated by ZoomDistributed by OpenAI
- Skill
- Tool integration
- Software development
- MIT
- Medium risk
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
Download the skill as a ZIP:
https://autogineer.com/agent-skills/openai/build-zoom-rest-api-app/downloadUnzip 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
Define the resource and actor: user, meeting, webinar, recording, docs, chat, phone, account, or admin-level workflow.
Select the endpoint and required scopes from the reference files before coding.
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.
Implement narrow API wrappers with explicit pagination, retry, idempotency, and rate-limit handling.
Treat webhook processing as a separate event-ingestion path with signature verification and replay protection.
Debug by checking token audience, missing scopes, resource ownership, account settings, API enablement, and rate-limit headers.
References
Full preserved guide: references/full-guide.md
API architecture: concepts/api-architecture.md
Authentication flows: concepts/authentication-flows.md
Rate limits: references/rate-limits.md
Meetings: references/meetings.md
Recordings: references/recordings.md
Users: references/users.md
Token and scope playbook: troubleshooting/token-scope-playbook.md
Files
- ATTRIBUTION.mdAdded by AutoGineer878 B
- LICENSELicence file added by AutoGineer1.1 KiB
- RUNBOOK.md3.1 KiB
- SKILL.md1.6 KiB
- agents/openai.yaml143 B
- concepts/api-architecture.md8.9 KiB
- concepts/authentication-flows.md9.1 KiB
- concepts/meeting-urls-and-sdk-joining.md1.2 KiB
- concepts/rate-limiting-strategy.md9.6 KiB
- examples/graphql-queries.md465 B
- examples/meeting-lifecycle.md14.6 KiB
- examples/recording-pipeline.md661 B
- examples/user-management.md509 B
- examples/webhook-server.md14.4 KiB
- references/accounts.md7.5 KiB
- references/ai-companion.md1.2 KiB
- references/ai-services.md1.5 KiB
- references/authentication.md11.0 KiB
- references/auto-dialer.md2.6 KiB
- references/calendar.md4.9 KiB
- references/chatbot.md1.4 KiB
- references/clips.md2.9 KiB
- references/cobrowse-sdk-api.md1.4 KiB
- references/commerce.md5.8 KiB
- references/contact-center.md33.1 KiB
- references/crc.md3.5 KiB
- references/environment-variables.md976 B
- references/events.md13.0 KiB
- references/full-guide.md25.5 KiB
- references/graphql.md8.9 KiB
- references/healthcare.md1.3 KiB
- references/mail.md6.9 KiB
- references/marketplace-apps.md4.0 KiB
- references/meetings.md21.3 KiB
- references/number-management.md4.8 KiB
- references/openapi.md4.4 KiB
- references/phone.md45.9 KiB
- references/qss.md1.6 KiB
- references/quality-management.md1.7 KiB
- references/rate-limits.md9.9 KiB
- references/recordings.md1.4 KiB
- references/reports.md1.2 KiB
- references/revenue-accelerator.md9.4 KiB
- references/rooms.md15.3 KiB
- references/scheduler.md3.8 KiB
- references/scim2.md1.9 KiB
- references/tasks.md2.6 KiB
- references/team-chat.md13.5 KiB
- references/users.md7.3 KiB
- references/video-management.md4.0 KiB
- references/video-sdk-api.md5.3 KiB
- references/virtual-agent.md2.2 KiB
- references/webinars.md1.2 KiB
- references/whiteboard.md5.3 KiB
- references/workforce-management.md3.1 KiB
- references/zoom-docs.md3.2 KiB
- troubleshooting/common-errors.md11.6 KiB
- troubleshooting/common-issues.md650 B
- troubleshooting/forum-top-questions.md1.7 KiB
- troubleshooting/token-scope-playbook.md1.5 KiB
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
OpenAPI JSON: https://developers.zoom.us/api-hub/commerce/methods/endpoints.json
Base URL:
https://api.zoom.us/v2Authentication details: authentication.md
Notes
Endpoint methods and paths below are generated from the official Zoom API Hub
pathsobject.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
| Metric | Value |
|---|---|
| Endpoint operations | 33 |
| Path templates | 31 |
| Tags | 8 |
Tag Index
| Tag | Operations |
|---|---|
| Account Management | 4 |
| Billing | 3 |
| Deal Registration | 5 |
| Order | 4 |
| Platform | 3 |
| Product Catalog | 3 |
| Quote | 6 |
| Subscription | 5 |
Endpoints by Tag
Account Management
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /commerce/account | Create an end customer account | createAccount |
| POST | /commerce/account/{accountKey}/contacts | Add contacts to an existing end customer or your own account. | addAccountContact |
| GET | /commerce/accounts | Get the list of all accounts associated with a Zoom Partner/Sub-Reseller, by the account type | getAllAccounts |
| GET | /commerce/accounts/{accountKey} | Get the account details for a Zoom Partner/Subreseller/End Customer | getAccountDetails |
Billing
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| GET | /commerce/billing_documents | Gets all billing documents for a distributor or a reseller | getAllBillingDocs |
| GET | /commerce/billing_documents/{documentNumber}/document | Gets the PDF document for the billing document ID | downloadBillingDoc |
| GET | /commerce/invoices/{invoiceNumber} | Get detailed information about a specific invoice for a distributor or a reseller | getInvoiceDetail |
Deal Registration
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| GET | /commerce/campaigns | Retrieves all valid Zoom Campaigns which a deal registration can be associated with. | getCampaigns |
| POST | /commerce/deal_registration | Creates a new deal registration for a partner | createDealReg |
| GET | /commerce/deal_registrations | Gets all valid Deal Registrations for a partner | getAllDealRegs |
| GET | /commerce/deal_registrations/{dealRegKey} | Get details of a deal registration by registration number | getDealRegDetails |
| PATCH | /commerce/deal_registrations/{dealRegKey} | Updates an existing deal registration | Updatesanexistingdealregistration |
Order
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /commerce/order | Create a subscription order for a Zoom partner | createOrder |
| POST | /commerce/order/preview | Preview delta order metrics and subscriptions in an order | createOrderPreview |
| GET | /commerce/orders | Gets all orders for a Zoom partner. | getAllOrders |
| GET | /commerce/orders/{orderReferenceId} | Get order details by order reference ID | getOrderDetails |
Platform
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /commerce/file | Upload an attachment pdf file in context of a deal registration or quote | uploadFile |
| GET | /commerce/files/{associatedReferenceId}/details | Gets details of all files associated with a quote or deal registration | allFileDetails |
| GET | /commerce/files/{documentReferenceId} | Download a file associated with a quote or deal registration. | downloadFile. |
Product Catalog
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /commerce/catalog | Gets Zoom Product Catalog for a Zoom Partner | getOffers |
| GET | /commerce/catalog/{offerId} | Gets the details for a Zoom product or offer. | getOfferDetail |
| GET | /commerce/pricebooks | Gets the pricebook in a downloadable file | downloadPricebook |
Quote
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| POST | /commerce/quote | Create a subscription quote for a Zoom Partner | createQuote |
| POST | /commerce/quote/preview | Preview delta quote metrics and subscriptions in a quote | createQuotePreview |
| GET | /commerce/quotes | Gets all quotes for a Zoom partner | getAllQuotes |
| GET | /commerce/quotes/{quoteReferenceId} | Get quote details by quote reference ID | getQuoteDetails |
| PATCH | /commerce/quotes/{quoteReferenceId} | Update a subscription quote for a Zoom partner | updateQuote |
| PATCH | /commerce/quotes/{quoteReferenceId}/fulfillment | Submits a subscription quote for provisioning | provisionQuote |
Subscription
| Method | Endpoint | Summary | Operation ID |
|---|---|---|---|
| GET | /commerce/subscriptions | Gets paid subscriptions for a Zoom partner. | getAllSubscriptions |
| GET | /commerce/subscriptions/{subscriptionNumber} | Gets subscription details for a given subscription number | getSubscriptionDetails |
| GET | /commerce/subscriptions/{subscriptionNumber}/versions | Gets subscription changes/versions for a given subscription number. | getSubscriptionVersions |
| GET | /commerce/trials | Get trial subscriptions for a Zoom partner | getAllTrialSubscriptions |
| GET | /commerce/trials/{trialReferenceId} | Get trial details for an end customer by their Zoom account number or the trial ID | getTrialDetails |
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