Install
openclaw skills install @byungkyu/zoom-admin-apiZoom Admin API integration with managed OAuth. Manage users, meetings, webinars, recordings, and account settings with admin-level access. Use this skill when users want to list users, create or manage meetings, view recordings, check user/account settings, or administer a Zoom workspace. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Security: The MATON_API_KEY authenticates with Maton.ai but grants NO access to Zoom by itself. Zoom access requires explicit OAuth authorization by the user through Maton's connect flow. Access is strictly scoped to the Zoom account the user has authorized. All API requests are proxied through Maton's gateway, which handles OAuth token management. Only connect the intended Zoom account and revoke the connection when no longer needed. Requires network access and valid Maton API key. Calls run through the maton CLI with OAuth login; default to read and list calls, and confirm every write or new connection with the user.
openclaw skills install @byungkyu/zoom-admin-apiAccess the Zoom API with managed OAuth authentication and admin-level scopes. Manage users, meetings, webinars, recordings, and account settings.
All access runs through the Maton gateway and the maton CLI.
maton login --oauth # authenticate once (OAuth, recommended)
maton connection create zoom-admin # connect the account (needs user approval)
maton api '/zoom-admin/v2/users?status=active&page_size=30' # first call
npm install -g @maton/cli
brew install maton-ai/cli/maton
maton login --oauth
Opens the OAuth login page in the browser and waits for authorization. Once complete, it creates a profile in config.toml (eg. $HOME/.config/maton/config.toml) and stores the access and refresh tokens in the operating system's credential store (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux), auto-renewed on expiry. The CLI reads them when it needs them; nothing else should.
maton login --interactive
Requires manually copying an API key from Settings, which is error prone. Once complete, it also creates a profile in config.toml and stores the key in the same credential store. It is preferred over export MATON_API_KEY=..., which exposes a long-lived credential to every child process. When MATON_API_KEY is set, it overrides the active profile. If the CLI cannot be installed at all, see Appendix: Environments Without the CLI for the raw HTTP form and the rules for handling the key.
maton whoami --json
{
"authenticated": true,
"profile_name": "alice@example.com",
"auth_type": "oauth"
}
authenticated is false, stop and login again via maton login --oauth.auth_type is api_key, it is recommended to login via maton login --oauth and avoid keeping a long-lived credential.maton connection list zoom-admin --status ACTIVE
{
"connections": [
{
"connection_id": "{connection_id}",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "zoom-admin",
"method": "OAUTH2",
"metadata": {}
}
]
}
Refer to maton connection list --help for possible flags and values.
Requires explicit user approval. Confirm that the user intends to authorize Zoom Admin access before running this. Never create a connection on your own initiative.
maton connection create zoom-admin
Refer to maton connection create --help for possible flags and values.
maton connection get {connection_id}
{
"connection": {
"connection_id": "{connection_id}",
"status": "PENDING",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "zoom-admin",
"metadata": {}
}
}
Open the returned URL in a browser to complete authorizing Zoom Admin. If Zoom Admin offers scope selection, choose only the scopes the current task needs.
maton connection delete {connection_id} --yes
If there are multiple Zoom Admin connections, specify which one to use so requests go to the intended account:
maton api '/zoom-admin/v2/users?status=active&page_size=30' --connection {connection_id}
Zoom Admin has no typed maton zoom-admin commands yet, so every call goes through maton api.
maton api '/zoom-admin/v2/users?status=active&page_size=30'
Paths are /zoom-admin/{native-api-path}. The gateway forwards everything after the app segment to api.zoom.us and injects the credential for the connection. Query strings, custom headers (except Host and Authorization), and all HTTP methods pass through. Send a JSON body with --input -:
maton api -X POST '/zoom-admin/{native-api-path}' -H 'Content-Type: application/json' --input - <<'JSON'
{"key": "value"}
JSON
Refer to maton api --help for possible flags and values.
Replace {native-api-path} with the actual Zoom API endpoint path (e.g., v2/users, v2/meetings/123). The gateway proxies requests to api.zoom.us and automatically injects your OAuth token.
maton login --oauth, the token is held by the operating system's credential store and the CLI renews it on its own. Do not print it, write it to a file, pass it on a command line, or run maton token to look at one — only to hand it to a program that needs it.config.toml, or any other credential file — not for this skill, not for another application, and not to "check" that auth works (use maton whoami). Let the CLI use its own stored credential; the agent never needs the value. The same applies to unrelated secrets on the machine: .env files, SSH keys, cloud CLI credentials, and browser profiles are out of scope for an API gateway and must not be read or transmitted.api.maton.ai. Prefer endpoints that work with the gateway-injected connection credential.maton connection delete {connection_id}).maton connection create zoom-admin. Never create connections on the agent's own initiative.--connection when the user has multiple connections for this app, and -p/--profile when they have multiple Maton accounts. Do not let an ambiguous default decide where a write lands.maton api '/zoom-admin/v2/users?status=active&page_size=30'
Query Parameters:
| Param | Type | Default | Description |
|---|---|---|---|
status | string | active | active, inactive, or pending |
page_size | integer | 30 | Max: 2000 |
next_page_token | string | Pagination token (15-min expiry) | |
role_id | string | Filter by role ID |
Response:
{
"page_size": 30,
"total_records": 1,
"next_page_token": "",
"users": [
{
"id": "a-IOECePRV265Gy_wotUdQ",
"first_name": "Richard",
"last_name": "Song",
"display_name": "Richard Song",
"email": "user@example.com",
"type": 1,
"pmi": 6862513852,
"timezone": "America/Los_Angeles",
"verified": 1,
"status": "active",
"created_at": "2025-03-21T21:52:50Z",
"last_login_time": "2026-05-01T01:01:08Z",
"role_id": "0"
}
]
}
User type values: 1 = Basic, 2 = Licensed, 4 = Unassigned, 99 = None.
maton api '/zoom-admin/v2/users/{userId}'
Use me for the authenticated user, or a user ID / email address.
Response:
{
"id": "a-IOECePRV265Gy_wotUdQ",
"first_name": "Richard",
"last_name": "Song",
"display_name": "Richard Song",
"email": "user@example.com",
"type": 1,
"role_name": "Owner",
"pmi": 6862513852,
"use_pmi": false,
"personal_meeting_url": "https://us05web.zoom.us/j/6862513852?pwd=...",
"timezone": "America/Los_Angeles",
"status": "active",
"account_id": "ciah2jjMRgedBSqxO8bOjA",
"role_id": "0",
"login_types": [100, 1],
"created_at": "2025-03-21T21:52:50Z",
"last_login_time": "2026-05-01T01:01:08Z"
}
maton api '/zoom-admin/v2/users/{userId}/settings'
Query Parameters:
| Param | Type | Description |
|---|---|---|
option | string | meeting_authentication, recording_authentication, or meeting_security |
Returns detailed settings grouped into sections: schedule_meeting, in_meeting, email_notification, recording, telephony, feature, whiteboard, audio_conferencing, etc.
maton api '/zoom-admin/v2/users/{userId}/meetings?type=scheduled&page_size=30'
Query Parameters:
| Param | Type | Default | Description |
|---|---|---|---|
type | string | live | scheduled, live, upcoming, upcoming_meetings, previous_meetings |
page_size | integer | 30 | Max: 300 |
next_page_token | string | Pagination token (15-min expiry) |
Response:
{
"page_size": 30,
"total_records": 11,
"next_page_token": "B4Tr0tLbJKQMnChspbYH7UUvt7g0UeDQNh2",
"meetings": [
{
"uuid": "SukzvlkXQO2rNcNPKUGCpw==",
"id": 89560318205,
"host_id": "a-IOECePRV265Gy_wotUdQ",
"topic": "Team Standup",
"type": 2,
"start_time": "2026-03-30T18:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"created_at": "2026-03-29T18:01:40Z",
"join_url": "https://us05web.zoom.us/j/89560318205?pwd=..."
}
]
}
Meeting type values: 1 = Instant, 2 = Scheduled, 3 = Recurring (no fixed time), 4 = PMI, 8 = Recurring (fixed time).
maton api '/zoom-admin/v2/meetings/{meetingId}'
Query Parameters:
| Param | Type | Description |
|---|---|---|
occurrence_id | string | For recurring meetings |
show_previous_occurrences | boolean | Show previous occurrences |
Returns full meeting details including settings, recurrence, occurrences, join_url, start_url, password, etc.
maton api -X POST '/zoom-admin/v2/users/{userId}/meetings' -H 'Content-Type: application/json' --input - <<'JSON'
{
"topic": "Weekly Team Sync",
"type": 2,
"start_time": "2026-05-02T10:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"agenda": "Discuss project updates",
"settings": {
"host_video": true,
"participant_video": true,
"join_before_host": false,
"mute_upon_entry": true,
"waiting_room": false,
"auto_recording": "none",
"audio": "voip"
}
}
JSON
Key Request Fields:
| Field | Type | Description |
|---|---|---|
topic | string | Meeting topic |
type | integer | 1 = Instant, 2 = Scheduled, 3 = Recurring (no fixed), 8 = Recurring (fixed) |
start_time | string | ISO 8601 datetime (required for type 2 and 8) |
duration | integer | Duration in minutes |
timezone | string | e.g., America/New_York |
password | string | Up to 10 characters |
agenda | string | Max 2000 characters |
recurrence | object | Required for type 8 |
settings | object | Meeting settings |
Returns the created meeting object (same as Get Meeting).
maton api -X PATCH '/zoom-admin/v2/meetings/{meetingId}' -H 'Content-Type: application/json' --input - <<'JSON'
{
"topic": "Updated Meeting Topic",
"duration": 45
}
JSON
All fields are optional. Returns 204 No Content on success.
maton api '/zoom-admin/v2/meetings/{meetingId}' -X DELETE
Query Parameters:
| Param | Type | Description |
|---|---|---|
occurrence_id | string | Delete specific occurrence of recurring meeting |
schedule_for_reminder | boolean | Notify host about cancellation |
cancel_meeting_reminder | string | Notify registrants (true/false) |
Returns 204 No Content on success.
maton api '/zoom-admin/v2/past_meetings/{meetingId}'
Use the meeting ID or UUID. If the UUID starts with / or contains //, it must be double-URL-encoded.
Response:
{
"uuid": "/LAYgqiEQ8CW4NlhkyOvVA==",
"id": 89560318205,
"host_id": "a-IOECePRV265Gy_wotUdQ",
"type": 2,
"topic": "Team Standup",
"user_name": "Richard Song",
"user_email": "user@example.com",
"start_time": "2026-03-30T18:02:25Z",
"end_time": "2026-03-30T18:09:50Z",
"duration": 8,
"total_minutes": 22,
"participants_count": 3,
"source": "Calendly for Zoom"
}
maton api '/zoom-admin/v2/past_meetings/{meetingId}/instances'
Response:
{
"meetings": [
{
"uuid": "/LAYgqiEQ8CW4NlhkyOvVA==",
"start_time": "2026-03-30T18:02:25Z"
}
]
}
Webinar endpoints require a Webinar plan on the Zoom account.
maton api '/zoom-admin/v2/users/{userId}/webinars?page_size=30'
Query Parameters:
| Param | Type | Default | Description |
|---|---|---|---|
type | string | scheduled | scheduled or upcoming |
page_size | integer | 30 | Max: 300 |
next_page_token | string | Pagination token |
Response:
{
"page_size": 30,
"total_records": 0,
"next_page_token": "",
"webinars": [
{
"uuid": "...",
"id": 12345678901,
"host_id": "...",
"topic": "Product Launch Webinar",
"type": 5,
"start_time": "2026-05-15T14:00:00Z",
"duration": 60,
"timezone": "America/Los_Angeles",
"join_url": "https://us05web.zoom.us/j/..."
}
]
}
Webinar type values: 5 = Webinar, 6 = Recurring (no fixed time), 9 = Recurring (fixed time).
maton api '/zoom-admin/v2/webinars/{webinarId}'
Returns full webinar details including settings, recurrence, and registration info.
maton api '/zoom-admin/v2/users/{userId}/recordings?from=2026-04-01&to=2026-04-30&page_size=30'
Query Parameters:
| Param | Type | Description |
|---|---|---|
from | string | Start date (yyyy-mm-dd). Max range: 1 month. Max past: 6 months |
to | string | End date (yyyy-mm-dd) |
page_size | integer | Max: 300 |
next_page_token | string | Pagination token |
trash | boolean | List trashed recordings |
Response:
{
"from": "2026-04-01",
"to": "2026-04-30",
"total_records": 0,
"next_page_token": "",
"meetings": [
{
"uuid": "...",
"id": 12345678901,
"host_id": "...",
"topic": "Meeting Topic",
"start_time": "2026-04-15T10:00:00Z",
"duration": 45,
"total_size": 52428800,
"recording_count": 2,
"recording_files": [
{
"id": "...",
"file_type": "MP4",
"file_extension": "MP4",
"file_size": 41943040,
"play_url": "https://...",
"download_url": "https://...",
"recording_type": "shared_screen_with_speaker_view",
"status": "completed"
}
]
}
]
}
maton api '/zoom-admin/v2/meetings/{meetingId}/recordings'
Use the meeting ID or UUID. If the UUID starts with / or contains //, it must be double-URL-encoded.
Query Parameters:
| Param | Type | Description |
|---|---|---|
include_fields | string | download_access_token for JWT download token |
ttl | integer | Token TTL in seconds (0–604800, default: 172800) |
Returns the meeting's recording files with download URLs.
maton api '/zoom-admin/v2/accounts/{accountId}/settings'
Use me for the connected account. Requires a paid Zoom plan.
Query Parameters:
| Param | Type | Description |
|---|---|---|
option | string | meeting_authentication, recording_authentication, security, meeting_security |
Returns account-level settings grouped into sections: security, schedule_meeting, in_meeting, recording, telephony, feature, chat, etc.
Zoom uses token-based pagination via next_page_token. Tokens expire after 15 minutes.
# First page
maton api '/zoom-admin/v2/users?page_size=30'
# Next page
maton api '/zoom-admin/v2/users?page_size=30&next_page_token={next_page_token}'
Response includes pagination fields:
{
"page_size": 30,
"total_records": 100,
"next_page_token": "B4Tr0tLbJKQMnChspbYH7UUvt7g0UeDQNh2"
}
When next_page_token is empty, there are no more pages. Do not reuse expired tokens — start from the first page if a token expires.
zoom-admin app uses admin-level OAuth scopes that grant access to all users in the Zoom account/ or containing // must be double-URL-encoded when used in path parameters/v2/accounts/me/settings) requires a paid Zoom planThe CLI above is this skill's documented path; the SDKs are an optional way to call the same gateway from application code. The two modes keep separate credential stores: the CLI uses the profile from maton login, while an SDK program signs in once with login(), which opens a browser and stores a session that Maton() reads. Zoom Admin has no typed accessor yet, so calls go through the api passthrough, which takes the app and the path after it.
Python
pip install maton-ai
from maton_ai import Maton, login
# login()
maton = Maton()
# maton = Maton(api_key="...")
result = maton.api.get("zoom-admin", "/v2/users?status=active&page_size=30")
JavaScript
npm install @maton/sdk
import { Maton, login } from "@maton/sdk";
// await login()
const maton = new Maton();
// const maton = new Maton({ apiKey: "..." });
const result = await maton.api.get("zoom-admin", "/v2/users?status=active&page_size=30");
| Status | Meaning |
|---|---|
| 400 | Missing Zoom Admin connection |
| 401 | Invalid, missing, or expired Maton credential |
| 429 | Rate limited (10 requests/second per account) |
| 500 | Internal Server Error |
| 4xx/5xx | Passthrough error from the Zoom Admin API |
Errors from Zoom Admin are passed through with their original status codes and response bodies.
maton whoami --json
"authenticated": false — login again with maton login --oauth."auth_type": "api_key" — prefer maton login --oauth so no long-lived key sits on the machine.maton whoami is the check.Then confirm the app is connected:
maton connection list zoom-admin --status ACTIVE
Paths passed to maton api must start with /zoom-admin/:
maton api '/zoom-admin/v2/users?status=active&page_size=30'maton api '/v2/users?status=active&page_size=30'A 500 may mean the Zoom Admin authorization expired. With the user's approval, create a new connection (maton connection create zoom-admin) and complete authorization; once it is ACTIVE, delete the stale connection so the gateway uses the new one.
| Category | Pro Plan | Business+ |
|---|---|---|
| LIGHT | 4/sec, 6,000/day | 30/sec |
| MEDIUM | 2/sec, 2,000/day | 20/sec |
| HEAVY | 1/sec, 1,000/day | 10/sec |
Rate-limited responses include a Retry-After header.
maton api.--paginate walks every page and -q/--jq trims the response before it reaches you. On typed commands, --jq requires --json.maton api; Host and Authorization are set by the gateway.Everything above uses the CLI, which holds the credential itself and never exposes it to the caller. Use the raw HTTP form below only where the CLI cannot be installed — a locked-down container, a CI step, a sandbox with no package manager. If maton is available, maton api does the same job without handling a secret.
Calling api.maton.ai directly means holding a long-lived Maton API key in the process environment, where it is readable by every child process and easy to leak into logs, crash dumps, shell history, and pasted output. Handle it accordingly:
[ -n "$MATON_API_KEY" ] && echo "MATON_API_KEY is set" || echo "MATON_API_KEY is not set"
.env, or a script makes it permanent. Let the environment that starts the session supply it — a CI secret store, a container secret, a secrets manager.ps output and shell history. Read it from the environment inside the process that makes the request, as below.api.maton.ai. It is not a credential for Zoom Admin or any other third-party host.The request is a plain HTTPS call to host api.maton.ai at path /zoom-admin/{native-api-path} with a bearer token; the gateway swaps in the connected app's credential. Add a Maton-Connection: {connection_id} header to pin a specific connection when the account has more than one. Query values must be URL-encoded. The Python standard library is enough — the key is read from the environment inside the process, so it never appears on a command line:
python3 - <<'PY'
import json, os, urllib.request
GATEWAY = "https://api.maton.ai"
req = urllib.request.Request(GATEWAY + "/zoom-admin/v2/users?status=active&page_size=30")
req.add_header("Authorization", "Bearer " + os.environ["MATON_API_KEY"])
req.add_header("User-Agent", "maton-zoom-admin-skill/1.2")
# req.add_header("Maton-Connection", "{connection_id}")
with urllib.request.urlopen(req) as resp:
print(json.dumps(json.load(resp), indent=2))
PY
For a write, set method="POST" (or PUT/DELETE) on the Request, pass the JSON-encoded body as data=, and add a Content-Type: application/json header.
The same rules as the CLI apply to every request made this way: read-only calls first, and explicit user confirmation before any POST, PUT, PATCH, or DELETE.