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://mp-staging.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/openapi.md

OpenAPI / Swagger Specifications

Zoom provides OpenAPI specifications for API client generation and tooling integration.

Official Specifications

Zoom API v2 (Current)
PropertyValue
FormatSwagger 2.0 (JSON)
StatusDeprecated - Last updated November 2018
Coverage~103 endpoints (subset of full API)
Downloadopenapi.v2.json
Repositorygithub.com/zoom/api
Zoom API v1 (Legacy)
PropertyValue
FormatSwagger 2.0 (JSON)
StatusDeprecated
Coverage~93 endpoints
Downloadopenapi.v2.json
Repositorygithub.com/zoom/api-v1

Coverage Limitations

The official OpenAPI specs only cover a small subset of Zoom's 600+ endpoints:

CoveredNOT Covered
MeetingsPhone API
UsersTeam Chat API
AccountsMail API
GroupsCalendar API
ReportsRooms API
WebinarsClips API
H.323 DevicesWhiteboard API
IM GroupsContact Center API
AI Companion API
20+ other modern APIs

Instead of using the outdated OpenAPI specs, Zoom recommends using Zoom Rivet - their official API client library.

Installation
npm install @zoom/rivet
Usage
import Zoom from '@zoom/rivet';

const zoom = new Zoom({
  accountId: process.env.ZOOM_ACCOUNT_ID,
  clientId: process.env.ZOOM_CLIENT_ID,
  clientSecret: process.env.ZOOM_CLIENT_SECRET,
});

// Create a meeting
const meeting = await zoom.meetings.create({
  userId: 'me',
  body: {
    topic: 'My Meeting',
    type: 2,
    duration: 60,
  },
});

// List users
const users = await zoom.users.list();

// Get recordings
const recordings = await zoom.cloudRecordings.list({
  userId: 'me',
  from: '2024-01-01',
  to: '2024-01-31',
});
Why Rivet Over OpenAPI?
AspectOpenAPI SpecsZoom Rivet
Coverage~103 endpointsFull API
MaintenanceDeprecated (2018)Actively maintained
Type SafetyRequires codegenBuilt-in TypeScript
Auth HandlingManualAutomatic token management
PaginationManualBuilt-in helpers
Rate LimitingManualBuilt-in retry logic

Using OpenAPI Specs Anyway

If you still need the OpenAPI specs (e.g., for custom tooling), here's how to use them:

Download the Spec
# Download Zoom API v2 spec
curl -o zoom-api-v2.json \
  https://raw.githubusercontent.com/zoom/api/442998230a148f403c3d1de1fe7aa54937354fa9/openapi.v2.json
Generate TypeScript Client
# Using openapi-generator
npm install @openapitools/openapi-generator-cli -g

openapi-generator-cli generate \
  -i zoom-api-v2.json \
  -g typescript-fetch \
  -o ./zoom-client
Generate Python Client
openapi-generator-cli generate \
  -i zoom-api-v2.json \
  -g python \
  -o ./zoom-client-python
Known Issues with Code Generation

The Zoom OpenAPI specs have known issues that may cause errors during code generation:

IssueWorkaround
Enum type mismatchesManually fix integer/string enum definitions
Missing required fieldsAdd required fields to generated models
Invalid syntaxValidate and fix JSON before generation
Outdated endpointsSupplement with manual API calls for new endpoints

Postman Collection

For interactive API exploration, Zoom provides a Postman collection:

# Import to Postman
# 1. Open Postman
# 2. Click Import
# 3. Enter URL: https://www.postman.com/zoom-developer/zoom-developer-api

API Reference Documentation

For the most up-to-date API documentation, use the official reference:

Resources

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