Skip to main content

Zoom — Application Overview

Zoom is a cloud-based video communications platform used by businesses, educators, and organizations to host virtual meetings, webinars, phone calls, and online events. It provides tools for scheduling meetings, managing users, generating reports, and administering accounts. The Zoom integration within the Wrk platform allows you to automate meeting scheduling, user management, webinar Wrkflows, and reporting activities by calling the Zoom REST API through prebuilt Wrk Actions.

​

This document provides an overview of how Zoom integrates into Wrk, how authentication works, general API behaviour, and a full list of available Wrk Actions.

Authentication​

Zoom’s API uses OAuth 2.0 authentication for secure access. Based on the kind of Wrk Action you need to use there are 2 types of Zoom OAuth connections:

  1. Zoom OAuth - Regular scopes for users accessing there own content
  2. Zoom OAuth(Admin Scopes) - Additional scopes for admin users

When connecting Zoom in Wrk, users authenticate through Zoom’s OAuth flow. After authorization, Wrk receives an access token (and refresh token), which is used for all subsequent API calls.

​

If authentication fails, Zoom typically returns:

HTTP 401 UnauthorizedHTTP 403 Forbidden (insufficient scopes)

How to Authenticate​

  1. Create a new Zoom Connected Account in Wrk.
  2. Sign in to your Zoom account.
  3. Grant the required OAuth scopes.
  4. Wrk securely stores and refreshes tokens automatically.

Important Notes​

  • Access tokens expire periodically and are automatically refreshed by Wrk.
  • If scopes are modified or access is revoked inside Zoom, the connection must be reauthenticated.
  • OAuth apps must be created in the Zoom App Marketplace Developer Console.

Authentication documentation: https://developers.zoom.us/docs/api/#authentication

General API Behaviour​

Account Context and the “me” Keyword​

Zoom supports the use of the special me keyword in certain endpoints. Example:

GET /users/me/meetings

This automatically references the authenticated user’s account and eliminates the need to manually pass a user ID.

Documentation: https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword

Pagination​

Most Zoom list endpoints support pagination using:

  • page_size — number of records per page
  • next_page_token — token returned for retrieving the next page

Example parameters:

page_size=30next_page_token=<token>

A paginated response includes:

  • page_size
  • next_page_token
  • total_records

If next_page_token is null or missing, there are no additional pages.

When retrieving large datasets (e.g., past meetings, webinar participants, recordings), pagination should always be used to avoid truncated results.

Rate Limits​

Zoom enforces API rate limits based on:

  • Account-level limits
  • Endpoint category (Light, Medium, Heavy)
  • Daily limits for certain reporting endpoints

If rate limits are exceeded, Zoom typically returns:

HTTP 429 Too Many Requests

Developers should implement retry logic with backoff when calling high-volume endpoints.

Rate limit documentation: https://developers.zoom.us/docs/api/rate-limits/

Resource Identifiers​

Zoom resources commonly include:

  • id — numeric or string identifier
  • uuid — unique meeting/webinar identifier (often required for past meetings)

Important:

Meeting UUIDs may contain special characters and sometimes must be URL encoded when used in API paths.

Abbreviations reference: https://developers.zoom.us/docs/api/references/abbreviations/

Filtering and Query Parameters​

Zoom endpoints commonly support:

  • type filters (e.g., scheduled, live, past meetings)
  • date range filters for reporting endpoints
  • status filters
  • search keywords

Filtering rules vary by endpoint. Not all endpoints support advanced filtering.

Error Handling​

Common Zoom API error responses include:

  • 300 — Validation failed
  • 401 — Invalid or expired token
  • 404 — Resource not found
  • 429 — Rate limit exceeded

Error responses typically include a code and message field for troubleshooting.

Available Wrk Actions for Zoom​

Wrk provides a curated set of Zoom Actions that map directly to Zoom’s most commonly used API endpoints.

Zoom​

  • Create a meeting
  • Delete a meeting
  • Perform an API call
  • Retrieve a meeting
  • Retrieve a meeting transcript
  • Retrieve a user
  • Retrieve all recordings
  • Retrieve meeting recordings
  • Retrieve meetings
  • Retrieve past meeting details
  • Retrieve past meeting participants
  • Retrieve user call history

Zoom Admin​

Zoom Admin actions use the same Zoom application overview for documentation.

  • Create a meeting
  • Delete a meeting
  • Perform an API call
  • Retrieve a meeting
  • Retrieve a meeting activities report
  • Retrieve a meeting transcript
  • Retrieve accounts call history
  • Retrieve all recordings
  • Retrieve call history
  • Retrieve history meeting and webinar list
  • Retrieve meeting detail reports
  • Retrieve meeting participant reports
  • Retrieve meeting recordings
  • Retrieve meetings
  • Retrieve past meeting details
  • Retrieve past meeting participants
  • Retrieve phone users
  • Retrieve user call history
  • Retrieve webinar detail reports
  • Update a meeting

Additional Resources​

Zoom API Reference: https://developers.zoom.us/docs/api/

Authentication Guide: https://developers.zoom.us/docs/api/#authentication

Using the “me” Keyword: https://developers.zoom.us/docs/api/using-zoom-apis/#the-me-keyword

Rate Limits: https://developers.zoom.us/docs/api/rate-limits/

Abbreviations & Field Reference: https://developers.zoom.us/docs/api/references/abbreviations/