Skip to main content

Documentation Index

Fetch the complete documentation index at: https://sferadev.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

A type-safe API client for the Zoom API, auto-generated from the official OpenAPI specification with full TypeScript support.

​
Features

  • Type-Safe - Full TypeScript support with auto-generated types from OpenAPI spec
  • Meeting API - Complete coverage of Zoom Meeting API
  • Auto-Updated - Daily regeneration from upstream OpenAPI specs

​
Installation

pnpm add zoom-api-js

​
Usage

​
Basic Usage

import { createClient } from "zoom-api-js";

const client = createClient({
  baseUrl: "https://api.zoom.us/v2",
  headers: {
    Authorization: `Bearer ${process.env.ZOOM_ACCESS_TOKEN}`,
  },
});

// List users
const users = await client.listUsers();

// Get user details
const user = await client.getUser({
  userId: "me",
});

// Create a meeting
const meeting = await client.createMeeting({
  userId: "me",
  body: {
    topic: "Team Standup",
    type: 2, // Scheduled meeting
    start_time: "2024-01-15T10:00:00Z",
    duration: 30,
  },
});

​
Type Exports

import type { Types } from "zoom-api-js";

// Use TypeScript types
type User = Types.User;
type Meeting = Types.Meeting;

​
API Reference

The client exposes Zoom API endpoints including:
  • Users - User management and information
  • Meetings - Create, update, and manage meetings
  • Webinars - Webinar management
  • Recordings - Access and manage recordings
  • Reports - Usage and activity reports
  • And more…
For the complete API reference, see the Zoom API documentation.