Zoom API

https://github.com/zoom/api
Admin
The Zoom API provides developers with the ability to manage Zoom resources, including users,...
Tokens:89,557
Snippets:632
Trust Score:8.2
License:Apache-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### List recordings curl example

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/cloud-recording.md

Example request to list recordings for a user using curl.

```bash
curl "https://api.zoom.us/v2/users/u1/recordings?from=2020-01-01&to=2020-01-31" \
  -H "Authorization: Bearer $JWT"
```

--------------------------------

### POST /users/{userId}/assistants example

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

A cURL example demonstrating how to add an assistant to a user via a POST request.

```bash
curl -X POST https://api.zoom.us/v2/users/u1/assistants \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "assistants": [ { "email": "assist@company.com" } ] }'
```

--------------------------------

### curl POST /h323/devices - Create device example

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/admin.md

Example curl command to create a device with name, protocol, ip, and encryption. Uses JWT authentication.

```bash
curl -X POST https://api.zoom.us/v2/h323/devices \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "name": "Lobby", "protocol": "H.323", "ip": "10.0.0.10", "encryption": "auto" }'
```

--------------------------------

### curl example - Create a webinar

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webinars.md

Example curl command to create a webinar with a JSON body. Uses a Bearer token for authorization and sets the Content-Type header to application/json.

```bash
curl -X POST https://api.zoom.us/v2/users/u1/webinars \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{
    "topic": "Product launch",
    "type": 5,
    "start_time": "2020-02-01T16:00:00Z",
    "duration": 45,
    "settings": { "practice_session": true }
  }'
```

--------------------------------

### Recover recording curl example

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/cloud-recording.md

Example request to recover a meeting's recordings using curl.

```bash
curl -X PUT https://api.zoom.us/v2/meetings/123456789/recordings/status \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "action": "recover" }'
```

--------------------------------

### Create a meeting with cURL

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/meetings.md

Example request to create a scheduled meeting using cURL. The request body includes the meeting topic, type, start time, duration, timezone, and settings.

```bash
curl -X POST https://api.zoom.us/v2/users/u1/meetings \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{
    "topic": "Weekly sync",
    "type": 2,
    "start_time": "2020-01-01T10:00:00Z",
    "duration": 60,
    "timezone": "UTC",
    "settings": { "join_before_host": true }
  }'
```

--------------------------------

### GET and PATCH /accounts/{accountId}/settings

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

GET returns 200 with AccountSettings (groups: schedule_meeting, in_meeting, email_notification, zoom_rooms, security, recording, telephony, integration, feature) or 404. PATCH body is AccountSettings, returns 204 or 404.

```http
GET   https://api.zoom.us/v2/accounts/{accountId}/settings
PATCH https://api.zoom.us/v2/accounts/{accountId}/settings
```

--------------------------------

### GET /metrics/zoomrooms

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Lists Zoom Rooms with metrics.

```APIDOC
## GET /metrics/zoomrooms

### Description
Lists Zoom Rooms with metrics.

### Method
GET

### Endpoint
/metrics/zoomrooms

### Authentication
JWT auth required.

### Rate Limits
1 request/second.

```

--------------------------------

### Error Response Example

Source: https://github.com/zoom/api/blob/master/_autodocs/errors.md

Example of an error response body with a code and message.

```APIDOC
## Error Response Example

### Description
Example of an error response body with a code and message.

### Response
#### Error Response
- **code** (integer) - Error code.
- **message** (string) - Error message.

#### Response Example
{
  "code": 300,
  "message": "Request Body should be a valid JSON object."
}
```

--------------------------------

### GET /h323/devices

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/admin.md

Lists H.323/SIP devices.

```APIDOC
## GET /h323/devices

### Description
List H.323/SIP devices.

### Method
GET

### Endpoint
https://api.zoom.us/v2/h323/devices

### Response
#### Success Response (200)
- **devices** (Device[]) - List of devices
- Pagination fields (from Pagination)

#### Response Example
(No example provided in source)

```

--------------------------------

### GET and PATCH /accounts/{accountId}/billing

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

GET returns 200 with BillingContactRequired (all fields required) or 404. PATCH body is BillingContact (optional fields), returns 204 or 404.

```http
GET   https://api.zoom.us/v2/accounts/{accountId}/billing
PATCH https://api.zoom.us/v2/accounts/{accountId}/billing
```

--------------------------------

### GET /groups

Source: https://github.com/zoom/api/blob/master/_autodocs/types.md

Lists groups.

```APIDOC
## GET /groups

### Description
Lists groups.

### Method
GET

### Endpoint
/groups

### Response
#### Success Response (200)
- **total_records** (integer) - Total number of records.
- **groups** (array) - Array of group objects, each containing:
  - **id** (string) - Group ID.
  - **name** (string) - Group name.
  - **total_members** (integer) - Total number of members.
```

--------------------------------

### GET /metrics/webinars

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Lists webinars with metrics.

```APIDOC
## GET /metrics/webinars

### Description
Lists webinars with metrics.

### Method
GET

### Endpoint
/metrics/webinars

### Authentication
JWT auth required.

### Rate Limits
1 request/second, 2000 requests/day, and additionally 1 request/minute.

```

--------------------------------

### GET /accounts/{accountId}/settings

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Retrieves settings for a sub-account.

```APIDOC
## GET /accounts/{accountId}/settings

### Description
Get settings for a sub-account.

### Method
GET

### Endpoint
/accounts/{accountId}/settings

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

### Response
#### Success Response (200)
- **account_settings** (AccountSettings) - The account settings.

#### Response Example
{
  "account_settings": {
    "meeting_authentication": false,
    "recording_authentication": false,
    "admin_change_name_pic": false
  }
}
```

--------------------------------

### GET /metrics/zoomrooms

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Retrieves a list of Zoom Room metrics.

```APIDOC
## GET /metrics/zoomrooms

### Description
Retrieves a list of Zoom Room metrics.

### Method
GET

### Endpoint
https://api.zoom.us/v2/metrics/zoomrooms

### Parameters
#### Query Parameters
- **page_size** (integer) - Optional - Default 30.
- **page_number** (integer) - Optional - Default 1.

### Response
#### Success Response (200)
- **ZoomRoomList** (object) - Contains pagination and zoomrooms array.

### Response Example
{
  "page_size": 30,
  "page_number": 1,
  "zoomrooms": []
}
```

--------------------------------

### GET /accounts/{accountId}/settings

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Retrieves the settings for a sub account.

```APIDOC
## GET /accounts/{accountId}/settings

### Description
Retrieves the settings for a sub account.

### Method
GET

### Endpoint
https://api.zoom.us/v2/accounts/{accountId}/settings

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

### Response
#### Success Response (200)
Returns an AccountSettings object with groups: schedule_meeting, in_meeting, email_notification, zoom_rooms, security, recording, telephony, integration, feature.

#### Error Response (404)
Account not found.
```

--------------------------------

### GET /users/{userId}/settings

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Retrieves a user's settings.

```APIDOC
## GET /users/{userId}/settings

### Description
Get settings.

### Method
GET

### Endpoint
/users/{userId}/settings

### Path Parameters
- **userId** (string) - Required - The user ID or email address.

### Response
#### Success Response (200)
- **settings** (object) - User settings.

#### Response Example
{
  "settings": {}
}
```

--------------------------------

### GET /users endpoint definition

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

The base URL for the GET /users request.

```http
GET https://api.zoom.us/v2/users
```

--------------------------------

### Create a user with cURL

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Example request to create a new user by providing the action and user information in the JSON body.

```bash
curl -X POST https://api.zoom.us/v2/users \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{
    "action": "create",
    "user_info": { "email": "user@company.com", "type": 2 }
  }'
```

--------------------------------

### GET /users/email, GET /users/vanity_name, GET /users/zpk

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

These endpoints are read-only availability probes to check if an email, personal meeting room name, or zpk is available. They all return a 200 status code.

```APIDOC
## GET /users/email, GET /users/vanity_name, GET /users/zpk

### Description
These endpoints are read-only availability probes to check if an email, personal meeting room name, or zpk is available. They all return a 200 status code.

### Method
GET

### Endpoint
- `https://api.zoom.us/v2/users/email?email=<email>`
- `https://api.zoom.us/v2/users/vanity_name?vanity_name=<name>`
- `https://api.zoom.us/v2/users/zpk?zpk=<zpk>`

### Parameters
#### Query Parameters
- **email** (string) - Required - Email to check
- **vanity_name** (string) - Required - Personal meeting room name to check
- **zpk** (string) - Required - zpk to verify (deprecated)

### Response
#### Success Response (200)
All endpoints return `200`.

```

--------------------------------

### GET /metrics/zoomrooms/{zoomroomId}

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Retrieves metrics for a specific Zoom Room.

```APIDOC
## GET /metrics/zoomrooms/{zoomroomId}

### Description
Retrieves metrics for a specific Zoom Room.

### Method
GET

### Endpoint
https://api.zoom.us/v2/metrics/zoomrooms/{zoomroomId}

### Parameters
#### Path Parameters
- **zoomroomId** (string) - Required - The Zoom Room ID.

#### Query Parameters
- **from** (string, date) - Required - Start date.
- **to** (string, date) - Required - End date.

### Response
#### Success Response (200)
- **ZoomRoom** (object) - Zoom Room detail.

### Response Example
{
  "id": "123456",
  "name": "Room 1"
}
```

--------------------------------

### Create a webhook - POST /webhooks

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webhooks.md

Creates a webhook with required fields: url, auth_user, auth_password, and events. Returns 201 with the created webhook details. Throws 404.

```http
POST https://api.zoom.us/v2/webhooks
```

--------------------------------

### Curl Example for 404 Error

Source: https://github.com/zoom/api/blob/master/_autodocs/errors.md

Example of using curl to make a request that returns a 404 error for a non-existent meeting.

```APIDOC
## Curl Example for 404 Error

### Description
Example of using curl to make a request that returns a 404 error for a non-existent meeting.

### Request
#### Example
curl -s -w '\nHTTP %{http_code}\n' \
    -H "Authorization: Bearer $JWT" \
    https://api.zoom.us/v2/meetings/000000000

### Response
#### Success Response (404)
- **code** (integer) - Error code.
- **message** (string) - Error message.

#### Response Example
HTTP 404
{
  "code": 300,
  "message": "Meeting not found."
}
```

--------------------------------

### POST /h323/devices

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/admin.md

Creates a new H.323/SIP device.

```APIDOC
## POST /h323/devices

### Description
Create a device.

### Method
POST

### Endpoint
https://api.zoom.us/v2/h323/devices

### Parameters
#### Request Body
- **name** (string, max 64) - Required - Device name
- **protocol** (string) - Required - enum `H.323`, `SIP`
- **ip** (string) - Required - Device IP
- **encryption** (string) - Required - enum `auto`, `yes`, `no`

### Request Example
```bash
curl -X POST https://api.zoom.us/v2/h323/devices \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "name": "Lobby", "protocol": "H.323", "ip": "10.0.0.10", "encryption": "auto" }'
```

### Response
#### Success Response (201)
Created.

```

--------------------------------

### curl - Create a sub account

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Example curl command to create a sub account. Uses a Bearer token for authorization and sends a JSON body with user details.

```bash
curl -X POST https://api.zoom.us/v2/accounts \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{
    "first_name": "Zoomie", "last_name": "Userton",
    "email": "sub@company.com", "password": "P@55w0rd"
  }'
```

--------------------------------

### Register and Approve Meeting Registrants via cURL

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/meetings.md

Examples of using cURL to register a new participant and update the status of existing registrants.

```bash
curl -X POST "https://api.zoom.us/v2/meetings/123456789/registrants" \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "email": "guest@company.com", "first_name": "Zoomie", "last_name": "Userton" }'

curl -X PUT "https://api.zoom.us/v2/meetings/123456789/registrants/status" \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "action": "approve", "registrants": [ { "id": "r1", "email": "guest@company.com" } ] }'
```

--------------------------------

### GET /tsp - Retrieve account TSP information

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/admin.md

Sends a GET request to retrieve the account's TSP provider and enable state. Returns 200 with inline schema.

```http
GET https://api.zoom.us/v2/tsp
```

--------------------------------

### GET /webinars/{webinarId} - Retrieve a webinar

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webinars.md

Retrieves a webinar by ID. Returns 200 with WebinarInfo merged with {uuid, id, host_id}. Throws 404 if the webinar does not exist.

```http
GET https://api.zoom.us/v2/webinars/{webinarId}
```

--------------------------------

### Poll endpoints (GET, POST, PUT, DELETE)

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webinars.md

Lists the REST endpoints for managing webinar polls: list, create, get, update, and delete. Expected responses: 200, 201, 204, and 404 for invalid IDs.

```http
GET    https://api.zoom.us/v2/webinars/{webinarId}/polls
POST   https://api.zoom.us/v2/webinars/{webinarId}/polls
GET    https://api.zoom.us/v2/webinars/{webinarId}/polls/{pollId}
PUT    https://api.zoom.us/v2/webinars/{webinarId}/polls/{pollId}
DELETE https://api.zoom.us/v2/webinars/{webinarId}/polls/{pollId}
```

--------------------------------

### POST /accounts

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Creates a sub account. Requires user details and optional settings.

```APIDOC
## POST /accounts

### Description
Creates a sub account. Requires user details and optional settings.

### Method
POST

### Endpoint
https://api.zoom.us/v2/accounts

### Parameters
#### Request Body
- **first_name** (string) - Required - User's first name
- **last_name** (string) - Required - User's last name
- **email** (string) - Required - User's email address
- **password** (string, min 8) - Required - User's password
- **options.share_rc** (boolean) - Optional - Enable Share Virtual Room Connector (default false)
- **options.room_connectors** (string) - Optional - Virtual Room Connector, comma separated
- **options.share_mc** (boolean) - Optional - Enable Share Meeting Connector (default false)
- **options.meeting_connectors** (string) - Optional - Meeting Connector, comma separated
- **options.pay_mode** (string) - Optional - enum `master` (default), `sub`

### Request Example
```bash
curl -X POST https://api.zoom.us/v2/accounts \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{
    "first_name": "Zoomie", "last_name": "Userton",
    "email": "sub@company.com", "password": "P@55w0rd"
  }'
```

### Response
#### Success Response (201)
- **id** (string) - Account ID
- **owner_id** (string) - Owner ID
- **owner_email** (string) - Owner email
- **created_at** (string) - Creation timestamp

#### Response Example
(No response example provided in source.)

### Error Handling
- **409** - Conflict, e.g., duplicate account.
```

--------------------------------

### GET /webhooks

Source: https://github.com/zoom/api/blob/master/_autodocs/types.md

Lists webhook subscriptions.

```APIDOC
## GET /webhooks

### Description
Lists webhook subscriptions.

### Method
GET

### Endpoint
/webhooks

### Response
#### Success Response (200)
- **total_records** (integer) - Total number of records.
- **webhooks** (array) - Array of webhook objects, each containing:
  - **webhook_id** (string) - Webhook ID.
  - **url** (string) - Webhook endpoint URL.
  - **auth_user** (string) - Auth user name.
  - **auth_password** (string) - Auth password.
  - **events** (array of strings) - Array of event types.
  - **created_at** (string) - Creation timestamp.
```

--------------------------------

### POST /accounts

Source: https://github.com/zoom/api/blob/master/_autodocs/types.md

Creates a new account with required fields and optional account options.

```APIDOC
## POST /accounts

### Description
Creates a new account. The request body must include `email`, `first_name`, `last_name`, and `password` (minimum 8 characters). The `options` field is an `AccountOptions` object.

### Method
POST

### Endpoint
/accounts

### Parameters
#### Request Body
- **first_name** (string) - Required - Account holder's first name.
- **last_name** (string) - Required - Account holder's last name.
- **email** (string) - Required - Account email.
- **password** (string) - Required - Password with minimum 8 characters.
- **options** (AccountOptions) - Optional - Account options object.

### Request Example
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john.doe@example.com",
  "password": "password123",
  "options": {
    "share_rc": false,
    "room_connectors": "",
    "share_mc": false,
    "meeting_connectors": "",
    "pay_mode": "master"
  }
}

### Response
#### Success Response (201)
- **id** (string) - The created account ID.
```

--------------------------------

### GET /v2/tracking_fields

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/admin.md

Lists tracking fields.

```APIDOC
## GET /v2/tracking_fields

### Description
List tracking fields.

### Method
GET

### Endpoint
https://api.zoom.us/v2/v2/tracking_fields

### Response
#### Success Response (200)
- **total_records** (integer) - Total number of records
- **tracking_fields** (array) - List of tracking fields, each containing `id` and TrackingField properties

#### Response Example
(No example provided in source)

```

--------------------------------

### Plans endpoints - GET, POST, PUT

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Endpoints for managing plans: GET /plans returns 200 AccountPlans or 404; POST /plans body is { contact: BillingContactRequired } merged with AccountPlans, returns 201 AccountPlans; PUT /plans/base body is AccountPlanBaseRequired (required type, hosts), returns 204; POST /plans/addons body is AccountPlanRequired (required type, hosts), returns 201; PUT /plans/addons body is AccountPlanRequired, returns 204.

```http
GET  https://api.zoom.us/v2/accounts/{accountId}/plans
POST https://api.zoom.us/v2/accounts/{accountId}/plans
PUT  https://api.zoom.us/v2/accounts/{accountId}/plans/base
POST https://api.zoom.us/v2/accounts/{accountId}/plans/addons
PUT  https://api.zoom.us/v2/accounts/{accountId}/plans/addons
```

--------------------------------

### POST /accounts/{accountId}/plans/addons

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Adds addon plans for a sub account.

```APIDOC
## POST /accounts/{accountId}/plans/addons

### Description
Adds addon plans for a sub account.

### Method
POST

### Endpoint
https://api.zoom.us/v2/accounts/{accountId}/plans/addons

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

#### Request Body
- **type** (string) - Required - The plan type.
- **hosts** (integer) - Required - The number of hosts.

### Response
#### Success Response (201)
Returns an AccountPlans object.

#### Error Response (404)
Account not found.
```

--------------------------------

### POST /users

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Creates a new user in the account.

```APIDOC
## POST /users

### Description
Creates a user.

### Method
POST

### Endpoint
/users

### Request Body
- **action** (string) - Required - The action to perform (e.g., create).
- **user_info** (object) - Required - User information.

### Request Example
{
  "action": "create",
  "user_info": {}
}

### Response
#### Success Response (201)
- **id** (string) - The new user's ID.

#### Response Example
{
  "id": "string"
}
```

--------------------------------

### GET /metrics/meetings

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Lists meetings with metrics.

```APIDOC
## GET /metrics/meetings

### Description
Lists meetings with metrics.

### Method
GET

### Endpoint
/metrics/meetings

### Authentication
JWT auth required.

### Rate Limits
1 request/second, 2000 requests/day, and additionally 1 request/minute.

```

--------------------------------

### POST /h323/devices - Create a device

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/admin.md

Creates a new H.323/SIP device. Body requires name, protocol (H.323 or SIP), ip, and encryption (auto, yes, no). Returns 201.

```http
POST https://api.zoom.us/v2/h323/devices
```

--------------------------------

### Error response example (JSON)

Source: https://github.com/zoom/api/blob/master/_autodocs/errors.md

Shown on the reference page as the standard error response. The body carries a numeric `code` and a `message`; this example uses code 300 with a generic message about the request body needing to be a valid JSON object.

```json
{
    "code": 300,
    "message": "Request Body should be a valid JSON object."
}
```

--------------------------------

### Create webhook with curl

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webhooks.md

Example curl command to create a webhook. Uses JWT bearer token and sends a JSON body with url, auth_user, auth_password, and events array.

```bash
curl -X POST https://api.zoom.us/v2/webhooks \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/zoom-hook",
    "auth_user": "hookuser",
    "auth_password": "secret",
    "events": ["meeting_started", "meeting_ended", "recording_completed"]
  }'
```

--------------------------------

### GET /users/{userId}/settings

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Retrieves the settings for a user. Optionally specify the login type via query parameter. Returns 200 with UserSettings, or 404 if the user is not found.

```APIDOC
## GET /users/{userId}/settings

### Description
Retrieves the settings for a user.

### Method
GET

### Endpoint
https://api.zoom.us/v2/users/{userId}/settings

### Parameters
#### Path Parameters
- **userId** (string) - Required - The user ID.

#### Query Parameters
- **login_type** (string) - Optional - Enum: `0`, `1`, `99`, `100`, `101`.

### Response
#### Success Response (200)
Returns a `UserSettings` object. See types.md for field groups.

#### Error Response (404)
User not found.
```

--------------------------------

### GET /metrics/im

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Retrieves IM usage metrics.

```APIDOC
## GET /metrics/im

### Description
Retrieves IM usage metrics.

### Method
GET

### Endpoint
https://api.zoom.us/v2/metrics/im

### Parameters
#### Query Parameters
- **from** (string, date) - Required - Start date.
- **to** (string, date) - Required - End date.
- **page_size** (integer) - Optional - Page size.
- **next_page_token** (string) - Optional - Token for the next page.

### Response
#### Success Response (200)
- **im** (object) - IM usage data.

### Response Example
{
  "im": {}
}
```

--------------------------------

### GET /past_webinars/{webinarId}/instances

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webinars.md

Lists all instances of a past webinar. Returns a list of webinar instance objects.

```APIDOC
## GET /past_webinars/{webinarId}/instances

### Description
List ended webinar instances.

### Method
GET

### Endpoint
/past_webinars/{webinarId}/instances

### Parameters
#### Path Parameters
- **webinarId** (integer) - Required - The webinar ID.

### Response
#### Success Response (200)
- **instances** (array) - List of webinar instance objects.

#### Response Example
{
  "instances": []
}
```

--------------------------------

### Retrieve Meeting Metrics via cURL

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Examples of using cURL to fetch meeting metrics and participant QOS data with authorization headers.

```bash
curl "https://api.zoom.us/v2/metrics/meetings?from=2020-01-01&to=2020-01-07&type=past" \
  -H "Authorization: Bearer $JWT"

curl "https://api.zoom.us/v2/metrics/meetings/123456789/participants/qos?type=past" \
  -H "Authorization: Bearer $JWT"
```

--------------------------------

### GET /metrics/im

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Retrieves IM usage metrics.

```APIDOC
## GET /metrics/im

### Description
Retrieves IM usage metrics.

### Method
GET

### Endpoint
/metrics/im

### Authentication
JWT auth required.

### Rate Limits
1 request/second.

```

--------------------------------

### GET /users/zpk

Source: https://github.com/zoom/api/blob/master/_autodocs/endpoints.md

Retrieves user information by ZPK (deprecated).

```APIDOC
## GET /users/zpk

### Description
Retrieves user information by ZPK (deprecated).

### Method
GET

### Endpoint
/users/zpk

### Parameters
#### Query Parameters
- **zpk** (string) - Required - The ZPK identifier (deprecated).

### Response
#### Success Response (200)
User information returned.
```

--------------------------------

### List users with cURL

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Example request to list active users with a specified page size using a Bearer token.

```bash
curl "https://api.zoom.us/v2/users?status=active&page_size=10" \
  -H "Authorization: Bearer $JWT"
```

--------------------------------

### GET /users/vanity_name

Source: https://github.com/zoom/api/blob/master/_autodocs/endpoints.md

Retrieves user information by vanity name.

```APIDOC
## GET /users/vanity_name

### Description
Retrieves user information by vanity name.

### Method
GET

### Endpoint
/users/vanity_name

### Parameters
#### Query Parameters
- **vanity_name** (string) - Required - The vanity name of the user.

### Response
#### Success Response (200)
User information returned.
```

--------------------------------

### Switch webhook version - PATCH /webhooks/options

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webhooks.md

Switches the webhook version between v1 and v2. Requires a 'version' field. Returns 204 on success, throws 404.

```http
PATCH https://api.zoom.us/v2/webhooks/options
```

--------------------------------

### GET /users/email

Source: https://github.com/zoom/api/blob/master/_autodocs/endpoints.md

Retrieves user information by email address.

```APIDOC
## GET /users/email

### Description
Retrieves user information by email address.

### Method
GET

### Endpoint
/users/email

### Parameters
#### Query Parameters
- **email** (string) - Required - The email address of the user.

### Response
#### Success Response (200)
User information returned.
```

--------------------------------

### POST /accounts - Create a sub account

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Creates a sub account. Requires a JSON body with first_name, last_name, email, and password (min 8 characters). Returns 201 with account details, or 409 on conflict (e.g., duplicate).

```http
POST https://api.zoom.us/v2/accounts
```

--------------------------------

### Retrieve a webhook - GET /webhooks/{webhookId}

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webhooks.md

Retrieves a specific webhook by ID. Returns 200 with webhook details including created_at. Throws 404.

```http
GET https://api.zoom.us/v2/webhooks/{webhookId}
```

--------------------------------

### UserList

Source: https://github.com/zoom/api/blob/master/_autodocs/types.md

The UserList object schema for GET /users response.

```APIDOC
## UserList

### Description
`allOf: [Pagination]` — `{page_count, page_number, page_size, total_records}` plus `users: User[]` → `GET /users`.
```

--------------------------------

### POST /accounts

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Creates a sub-account under the master account. Requires master-account privileges. The created user does not receive a confirmation email.

```APIDOC
## POST /accounts

### Description
Create a sub account.

### Method
POST

### Endpoint
/accounts

### Parameters
#### Request Body
- **first_name** (string) - Required - User's first name.
- **last_name** (string) - Required - User's last name.
- **email** (string) - Required - User's email address.
- **password** (string) - Required - User's password.
- **account_name** (string) - Required - The account name.
- **account_type** (integer) - Required - Account type.
- **phone_number** (string) - Optional - User's phone number.
- **phone_country** (string) - Optional - User's phone country.
- **options** (AccountOptions) - Optional - Account options.

### Request Example
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "password": "secret",
  "account_name": "Example Corp",
  "account_type": 1,
  "phone_number": "+1234567890",
  "phone_country": "US",
  "options": {
    "share_rc": false,
    "meeting_connector": false,
    "pay_mode": "master",
    "use_crm": false,
    "room_connector": false
  }
}

### Response
#### Success Response (201)
- **id** (string) - The account ID.
- **first_name** (string) - User's first name.
- **last_name** (string) - User's last name.
- **email** (string) - User's email address.
- **account_name** (string) - The account name.
- **account_type** (integer) - Account type.
- **created_at** (string) - The creation time.

#### Response Example
{
  "id": "string",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john@example.com",
  "account_name": "Example Corp",
  "account_type": 1,
  "created_at": "2023-01-01T00:00:00Z"
}
```

--------------------------------

### GET /users/{userId}/permissions

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Lists permissions for a user.

```APIDOC
## GET /users/{userId}/permissions

### Description
List permissions.

### Method
GET

### Endpoint
/users/{userId}/permissions

### Path Parameters
- **userId** (string) - Required - The user ID or email address.

### Response
#### Success Response (200)
- **permissions** (array) - List of permission strings.

#### Response Example
{
  "permissions": []
}
```

--------------------------------

### curl POST /accounts/a1/plans - Create plan

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Creates a plan for account a1 using a JWT bearer token. The request body includes contact details and plan_base with type 'pro' and 5 hosts.

```bash
curl -X POST https://api.zoom.us/v2/accounts/a1/plans \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{
    "contact": { "first_name": "B", "last_name": "C", "email": "bill@company.com",
                 "phone_number": "+1000", "address": "1 St", "city": "SF",
                 "state": "CA", "zip": "94107", "country": "US" },
    "plan_base": { "type": "pro", "hosts": 5 }
  }'
```

--------------------------------

### GET /users/{userId}/schedulers

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Lists schedulers for a user.

```APIDOC
## GET /users/{userId}/schedulers

### Description
List schedulers.

### Method
GET

### Endpoint
/users/{userId}/schedulers

### Path Parameters
- **userId** (string) - Required - The user ID or email address.

### Response
#### Success Response (200)
- **schedulers** (array) - List of scheduler objects.

#### Response Example
{
  "schedulers": []
}
```

--------------------------------

### POST /accounts/{accountId}/plans/addons

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/accounts.md

Adds add-on plans to a sub-account.

```APIDOC
## POST /accounts/{accountId}/plans/addons

### Description
Add add-on plans to a sub-account.

### Method
POST

### Endpoint
/accounts/{accountId}/plans/addons

### Parameters
#### Path Parameters
- **accountId** (string) - Required - The account ID.

#### Request Body
- **addons** (array of AccountPlanRequired) - Required - List of add-on plans.

### Request Example
{
  "addons": [
    {
      "type": "large_meeting",
      "hosts": 1,
      "frequency": "monthly"
    }
  ]
}

### Response
#### Success Response (201)
- **addons** (array of AccountPlan) - List of added add-on plans.

#### Response Example
{
  "addons": [
    {
      "type": "large_meeting",
      "hosts": 1,
      "frequency": "monthly"
    }
  ]
}
```

--------------------------------

### GET /users/{userId}/assistants

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Lists assistants for a user.

```APIDOC
## GET /users/{userId}/assistants

### Description
List assistants.

### Method
GET

### Endpoint
/users/{userId}/assistants

### Path Parameters
- **userId** (string) - Required - The user ID or email address.

### Response
#### Success Response (200)
- **assistants** (array) - List of assistant objects.

#### Response Example
{
  "assistants": []
}
```

--------------------------------

### GET /users/{userId}/webinars - List webinars

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webinars.md

Lists webinars for a specified user. Returns a WebinarList object with pagination and webinar info. A 404 error is returned for an unknown user.

```http
GET https://api.zoom.us/v2/users/{userId}/webinars
```

--------------------------------

### GET /meetings/{meetingId}/polls

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/meetings.md

Lists polls for a meeting.

```APIDOC
## GET /meetings/{meetingId}/polls

### Description
List polls.

### Method
GET

### Endpoint
/meetings/{meetingId}/polls

### Parameters
#### Path Parameters
- **meetingId** (string) - Required - The meeting ID.
```

--------------------------------

### POST /webhooks

Source: https://github.com/zoom/api/blob/master/_autodocs/types.md

Creates a webhook subscription.

```APIDOC
## POST /webhooks

### Description
Creates a webhook subscription.

### Method
POST

### Endpoint
/webhooks

#### Request Body
- **url** (string) - Required - Webhook endpoint URL (max 256 characters).
- **auth_user** (string) - Required - Auth user name (max 128 characters).
- **auth_password** (string) - Required - Auth password (max 64 characters).
- **events** (array of strings) - Required - Array of event types. Allowed values: `meeting_started`, `meeting_ended`, `meeting_jbh`, `meeting_join`, `recording_completed`, `participant_joined`, `participant_left`, `meeting_registered`, `recording_transcript_completed`.
```

--------------------------------

### GET /meetings/{meetingId}/registrants

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/meetings.md

Lists registrants for a meeting.

```APIDOC
## GET /meetings/{meetingId}/registrants

### Description
List registrants.

### Method
GET

### Endpoint
/meetings/{meetingId}/registrants

### Parameters
#### Path Parameters
- **meetingId** (string) - Required - The meeting ID.
```

--------------------------------

### GET /report/webinars/{webinarId}

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/reports.md

Retrieves a webinar details report.

```APIDOC
## GET /report/webinars/{webinarId}

### Description
Retrieves a webinar details report.

### Method
GET

### Endpoint
https://api.zoom.us/v2/report/webinars/{webinarId}

### Parameters
#### Path Parameters
- **webinarId** (string) - Required - The webinar ID.

### Response
#### Success Response (200)
Returns webinar details report.

#### Error Response (404)
Not found.
```

--------------------------------

### POST /users/{userId}/webinars - Create a webinar

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webinars.md

Creates a webinar for a specified user. The request body is a Webinar object with fields like topic, type, start_time, duration, timezone, password, agenda, recurrence, settings, and tracking_fields. Returns a 201 response with WebinarInfo merged with uuid, id, and host_id. A 404 error is returned for an unknown user.

```http
POST https://api.zoom.us/v2/users/{userId}/webinars
```

--------------------------------

### GET /h323/devices - List H.323/SIP devices

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/admin.md

Retrieves a paginated list of H.323/SIP devices. Returns 200 with DeviceList (allOf Pagination + devices array).

```http
GET https://api.zoom.us/v2/h323/devices
```

--------------------------------

### GET /report/cloud_recording

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/reports.md

Retrieves the cloud recording usage report.

```APIDOC
## GET /report/cloud_recording

### Description
Retrieves the cloud recording usage report.

### Method
GET

### Endpoint
/report/cloud_recording

### Parameters
#### Query Parameters
- **from** (string) - Required - Start date for the report.
- **to** (string) - Required - End date for the report.

### Response
#### Success Response (200)
- **cloud_recording** (array) - List of cloud recording usage entries.

#### Response Example
{
  "cloud_recording": [
    {
      "date": "2023-01-01",
      "storage_used": 1024
    }
  ]
}
```

--------------------------------

### GET /metrics/crc

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Retrieves CRC port usage metrics.

```APIDOC
## GET /metrics/crc

### Description
Retrieves CRC port usage metrics.

### Method
GET

### Endpoint
https://api.zoom.us/v2/metrics/crc

### Parameters
#### Query Parameters
- **from** (string, date) - Required - Start date.
- **to** (string, date) - Required - End date.

### Response
#### Success Response (200)
- **crc** (object) - CRC port usage data.

### Response Example
{
  "crc": {}
}
```

--------------------------------

### GET /webinars/{webinarId}/registrants

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/webinars.md

Lists all registrants for a webinar. Returns a list of registrant objects.

```APIDOC
## GET /webinars/{webinarId}/registrants

### Description
List registrants of a webinar.

### Method
GET

### Endpoint
/webinars/{webinarId}/registrants

### Parameters
#### Path Parameters
- **webinarId** (integer) - Required - The webinar ID.

### Response
#### Success Response (200)
- **registrants** (array) - List of registrant objects.

#### Response Example
{
  "registrants": []
}
```

--------------------------------

### Create a TSP account via cURL

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/users.md

Example request to create a new TSP account for a specific user using a POST request.

```bash
curl -X POST https://api.zoom.us/v2/users/u1/tsp \
  -H "Authorization: Bearer $JWT" -H "Content-Type: application/json" \
  -d '{ "conference_code": "123456", "leader_pin": "9876" }'
```

--------------------------------

### GET /metrics/webinars/{webinarId}

Source: https://github.com/zoom/api/blob/master/_autodocs/api-reference/dashboards.md

Retrieves metrics for a specific webinar.

```APIDOC
## GET /metrics/webinars/{webinarId}

### Description
Retrieves metrics for a specific webinar.

### Method
GET

### Endpoint
https://api.zoom.us/v2/metrics/webinars/{webinarId}

### Parameters
#### Path Parameters
- **webinarId** (string) - Required - The webinar ID.

#### Query Parameters
- **type** (string) - Optional - The type of metrics to retrieve.

### Response
#### Success Response (200)
- **WebinarMetric** (object) - The webinar metrics.

### Response Example
{
  "id": "123456789",
  "topic": "Webinar Topic"
}
```
Tokens:
Raw