Introduction to Canvas API

The Canvas API extends Canvas capabilities, enabling developers to integrate document creation, collaboration, and management into their applications.

The API is organized into three main areas:

  • Document management – Create, read, and delete documents.
  • Document content – Programmatically import content into a document.
  • Data tables – Import tables into structured datasets inside documents.

Data tables are a unique feature of Canvas that are ideal for team workflows, such as project management, task tracking, and resource planning.

With Canvas, users can draft, organize, and share content across meetings, chats, and teams. The API brings these capabilities to your applications, allowing you to automate document workflows, manage permissions, and extend collaboration at scale.

The ability to manage permissions, and control sharing will be introduced in a future API release.

Prerequisites

Before using the Canvas API, make sure you have:

  • A Zoom account on one of these plans: Basic, Pro, Pro Plus, Business, Business Plus, Education, or Enterprise
  • Canvas enabled on the account
  • The latest version (6.1.6 or higher) of:
    • Zoom Workplace desktop app (Windows, macOS, or Linux)
    • Zoom Workplace mobile app (iOS or Android)
    • Zoom Web App

If Canvas is not enabled on your account, the API will return errors. Contact your Zoom administrator to enable it.

The Canvas API provides programmatic access to Canvas content and features. Use the API to:

  • Create, read, and delete documents.

The API is designed to be consistent with modern collaboration platforms, such as Whiteboard, Google Drive, Microsoft OneDrive, and Notion. It delivers a developer-friendly experience and full integration with the Zoom Workplace platform.

Why use the Canvas API?

Developers and integrators can use the Canvas API to:

  • Embed Canvas in custom apps and services.
  • Synchronize documents across collaboration tools.
  • Build workflows that combine documents and data tables for creation, editing, and record management.
  • Automate document tasks to extend Zoom's collaboration suite.

With the Canvas API, you can create connected, intelligent workspaces where content flows seamlessly with your teams.