Studio Project workflows for Zoom meetings, users, webinars, and cloud recordings
Zoom is a cloud unified communications platform for video meetings and webinars, providing programmatic access to meetings, webinars, recordings, users, and accounts through a REST API.
This project provides OpenAPI specs for automating against the Zoom REST API via an Integration Model. The -latest spec is a curated subset covering common CRUD for meeting and webinar automation — see OpenAPIs below.
| Asset | Description |
|---|---|
| OpenAPIs/ | Zoom REST API OpenAPI specs — curated -latest plus the full dated spec |
| Studio Projects/Zoom | 24 workflows covering common CRUD automation |
| Requirement | Version |
|---|---|
| Itential Platform | 6.x |
| Zoom API | 2.0.0 |
| Zoom Integration Model | Required to build automation against the OpenAPI specs |
Import the OpenAPI spec from OpenAPIs/ as an Integration Model in Admin > Integrations, then create an integration pointing at Zoom's API.
Authentication is an API key passed in the access_token query parameter:
GET https://api.zoom.us/v2/users?access_token=<your-access-token> Generate an access token by creating a Server-to-Server OAuth app at marketplace.zoom.us, then exchanging the app's client ID and secret for an access token via POST https://zoom.us/oauth/token.
The instance's authentication/server properties should look like this once configured:
{
"authentication": {
"global": {
"value": "<your-api-key>"
}
},
"server": {
"protocol": "https",
"host": "api.zoom.us",
"base_path": "/v2"
}
} | Spec | Version | Operations | Description |
|---|---|---|---|
zoom-latest.json | latest (curated) | 49 | Actively-maintained, trimmed to 49 of 155 upstream operations — see breakdown below |
zoom-2.0.0.json | 2.0.0 | 155 | Full, unmodified vendor spec |
zoom-latest.jsonActively-maintained spec (x-vendor-api-version: 2.0.0). Trimmed to 49 of 155 upstream operations covering common CRUD for automation.
Resources included, by category:
Excluded: sub-account administration and billing, groups and IM groups/chat, H.323/SIP device management, dashboard metrics, usage/report endpoints, past meeting/webinar instance history, TSP telephony provider configuration, webhook management, tracking fields, and long-tail user administration (assistants, schedulers, PAC accounts, profile pictures, SSO tokens, permissions). See the full spec below for these.
zoom-2.0.0.jsonFull, unmodified vendor spec for Zoom API 2.0.0 (155 operations) — the vendor's complete API surface, preserved as-is. See zoom-latest.json above for the curated subset if you just need common CRUD automation.
Backed by the Zoom:latest Integration Model (see zoom-latest.json above). The project contains 24 workflows organized into 4 folders, one atomic workflow per API operation, covering the common-CRUD subset of the curated spec.
| Folder | Workflows | Scope |
|---|---|---|
| Meetings | Create, List, Get, Update, Delete Meeting, List/Add Meeting Registrant | Meeting lifecycle and registrants |
| Users | List, Create, Get, Update, Delete User, Get/Update User Settings | User account management |
| Webinars | Create, List, Get, Update, Delete Webinar, List/Add Webinar Registrant | Webinar lifecycle and registrants |
| Cloud Recording | Get/Delete Meeting Recordings, List User Recordings | Recording retrieval and cleanup |
| Dependency | Notes |
|---|---|
Zoom:latest Integration Model | Import from zoom-latest.json before importing the project |
Zoom integration instance | Create in Admin > Integrations with the connection properties above. Workflows are wired to an integration instance named Zoom — update the adapter_id value in each workflow task if yours is named differently |