Zoom API Version 1

https://github.com/zoom/api-v1
Admin
Zoom API Version 1 Documentation
Tokens:5,934
Snippets:4
Trust Score:8.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Zoom API Rate Limits and Webhooks

Source: https://github.com/zoom/api-v1/blob/master/source/index.html.md

This section provides information on Zoom API rate limits and webhook configurations. Understanding rate limits is crucial for managing API request frequency, while webhooks enable real-time event notifications. Examples are provided for interacting with these aspects using cURL and Node.js.

```APIDOC
Reference:
  - reference/index: API Reference overview
  - reference/rate_limits: Zoom API Rate Limits
    - Description: Details on request limits per API endpoint and user tier.
    - Usage: Monitor response headers like X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.
  - reference/webhooks: Zoom Webhooks Configuration
    - Description: Set up and manage webhook subscriptions to receive real-time event notifications.
    - Methods:
      - Create webhook subscription: POST /webhooks/subscriptions
      - List webhook subscriptions: GET /webhooks/subscriptions
      - Get webhook subscription: GET /webhooks/subscriptions/{subscriptionId}
      - Update webhook subscription: PUT /webhooks/subscriptions/{subscriptionId}
      - Delete webhook subscription: DELETE /webhooks/subscriptions/{subscriptionId}
    - Parameters: Event types, callback URL, verification token.
    - Returns: Subscription details or status.

```

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

### Zoom API Analytics Reports

Source: https://github.com/zoom/api-v1/blob/master/source/index.html.md

This section details the Zoom API endpoints for retrieving various analytics and reporting data. It covers account-level reports, audio reports, daily usage summaries, and user-specific analytics. Examples are provided for interacting with these endpoints using cURL and Node.js.

```APIDOC
Analytics Reports:
  - analytics/report/index: Analytics Reports API overview
  - analytics/report/get_account: Get account analytics report
    - GET /accounts/{accountId}/analytics/reports
    - Parameters: accountId, report type, date range
    - Returns: Account analytics data
  - analytics/report/get_audio: Get audio analytics report
    - GET /analytics/reports/audio
    - Parameters: query parameters (e.g., date range, user ID)
    - Returns: Audio analytics data
  - analytics/report/get_daily: Get daily usage report
    - GET /analytics/reports/daily
    - Parameters: query parameters (e.g., date, user type)
    - Returns: Daily usage statistics
  - analytics/report/get_user: Get user analytics report
    - GET /users/{userId}/analytics/reports
    - Parameters: userId, report type, date range
    - Returns: User-specific analytics data

Analytics Dashboards:
  - analytics/dashboard/index: Analytics Dashboards API overview
  - analytics/dashboard/list-meeting: List meeting analytics dashboards
    - GET /analytics/dashboards/meetings
    - Parameters: query parameters (e.g., date range)
    - Returns: List of meeting analytics dashboards
  - analytics/dashboard/get-meeting: Get specific meeting analytics dashboard
    - GET /analytics/dashboards/meetings/{meetingId}
    - Parameters: meetingId
    - Returns: Specific meeting analytics data
  - analytics/dashboard/list-webinar: List webinar analytics dashboards
    - GET /analytics/dashboards/webinars
    - Parameters: query parameters (e.g., date range)
    - Returns: List of webinar analytics dashboards
  - analytics/dashboard/get-webinar: Get specific webinar analytics dashboard
    - GET /analytics/dashboards/webinars/{webinarId}
    - Parameters: webinarId
    - Returns: Specific webinar analytics data
  - analytics/dashboard/get_share_record_details: Get shared recording details
    - GET /analytics/dashboards/recordings/shared
    - Parameters: query parameters
    - Returns: Details of shared recordings
  - analytics/dashboard/list-zoom-room: List Zoom Room analytics dashboards
    - GET /analytics/dashboards/zoom_rooms
    - Parameters: query parameters
    - Returns: List of Zoom Room analytics dashboards
  - analytics/dashboard/get-zoom-room: Get specific Zoom Room analytics dashboard
    - GET /analytics/dashboards/zoom_rooms/{roomId}
    - Parameters: roomId
    - Returns: Specific Zoom Room analytics data
  - analytics/dashboard/get-user-qos: Get user Quality of Service (QoS) data
    - GET /analytics/dashboards/users/{userId}/qos
    - Parameters: userId, query parameters
    - Returns: User QoS metrics
  - analytics/dashboard/get-crc-port-usage: Get CRC port usage data
    - GET /analytics/dashboards/crc/port_usage
    - Parameters: query parameters
    - Returns: CRC port usage statistics
  - analytics/dashboard/get-im: Get IM analytics data
    - GET /analytics/dashboards/im
    - Parameters: query parameters
    - Returns: IM analytics data

```

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

### Zoom API Core Functionality

Source: https://github.com/zoom/api-v1/blob/master/source/index.html.md

This section covers the core operations for managing key Zoom resources such as accounts, users, meetings, and webinars. It includes common CRUD (Create, Read, Update, Delete) operations and specific actions relevant to each resource type. Examples demonstrate how to interact with these endpoints using cURL and Node.js.

```APIDOC
Account Management:
  - core/account/index: Account API overview
  - core/account/create: Create a new account
    - POST /accounts
    - Parameters: account details
    - Returns: Created account information
  - core/account/list: List accounts
    - GET /accounts
    - Returns: List of accounts
  - core/account/get: Get account details
    - GET /accounts/{accountId}
    - Parameters: accountId
    - Returns: Specific account details
  - core/account/update: Update account details
    - PUT /accounts/{accountId}
    - Parameters: accountId, updated details
    - Returns: Updated account information
  - core/account/delete: Delete an account
    - DELETE /accounts/{accountId}
    - Parameters: accountId
    - Returns: Success/failure status
  - core/account/subscribe: Subscribe an account to a plan
    - POST /accounts/{accountId}/plans
    - Parameters: accountId, plan details
    - Returns: Subscription confirmation
  - core/account/add_plan: Add a plan to an account
    - POST /accounts/{accountId}/plans
    - Parameters: accountId, plan details
    - Returns: Plan addition status
  - core/account/get_plan: Get account's plan information
    - GET /accounts/{accountId}/plans
    - Parameters: accountId
    - Returns: Account's current plan details
  - core/account/update_plan: Update account's plan
    - PUT /accounts/{accountId}/plans
    - Parameters: accountId, new plan details
    - Returns: Updated plan information
  - core/account/update_billing: Update account billing information
    - PUT /accounts/{accountId}/billing
    - Parameters: accountId, billing details
    - Returns: Billing update status

User Management:
  - core/user/index: User API overview
  - core/user/create: Create a new user
    - POST /users
    - Parameters: user details (email, type, etc.)
    - Returns: Created user information
  - core/user/auto_create: Auto-create a user
    - POST /users/autoCreate
    - Parameters: user details
    - Returns: Auto-created user information
  - core/user/cust_create: Create a custom user
    - POST /users/custCreate
    - Parameters: user details
    - Returns: Custom user information
  - core/user/list: List users
    - GET /users
    - Parameters: query parameters for filtering
    - Returns: List of users
  - core/user/list_pending: List pending users
    - GET /users/pending
    - Returns: List of pending users
  - core/user/get: Get user details by ID
    - GET /users/{userId}
    - Parameters: userId
    - Returns: Specific user details
  - core/user/get_by_email: Get user details by email
    - GET /users/email/{email}
    - Parameters: email
    - Returns: Specific user details
  - core/user/update: Update user details
    - PUT /users/{userId}
    - Parameters: userId, updated user details
    - Returns: Updated user information
  - core/user/update_password: Update user password
    - PUT /users/{userId}/password
    - Parameters: userId, new password
    - Returns: Password update status
  - core/user/upload_picture: Upload user profile picture
    - POST /users/{userId}/picture
    - Parameters: userId, image file
    - Returns: Picture upload status
  - core/user/activate: Activate a user
    - PUT /users/{userId}/status/activate
    - Parameters: userId
    - Returns: Activation status
  - core/user/deactivate: Deactivate a user
    - PUT /users/{userId}/status/deactivate
    - Parameters: userId
    - Returns: Deactivation status
  - core/user/delete: Delete a user
    - DELETE /users/{userId}
    - Parameters: userId
    - Returns: Deletion status
  - core/user/delete_permanently: Permanently delete a user
    - DELETE /users/{userId}/permanent
    - Parameters: userId
    - Returns: Permanent deletion status
  - core/user/provision_sso: Provision SSO for a user
    - POST /users/{userId}/sso
    - Parameters: userId, SSO details
    - Returns: SSO provisioning status
  - core/user/revoke_sso: Revoke SSO for a user
    - DELETE /users/{userId}/sso
    - Parameters: userId
    - Returns: SSO revocation status
  - core/user/set_assistant: Set a user as an assistant
    - POST /users/{userId}/assistants
    - Parameters: userId, assistant details
    - Returns: Assistant assignment status
  - core/user/delete_assistant: Remove a user as an assistant
    - DELETE /users/{userId}/assistants/{assistantId}
    - Parameters: userId, assistantId
    - Returns: Assistant removal status
  - core/user/list_assistant: List assistants for a user
    - GET /users/{userId}/assistants
    - Parameters: userId
    - Returns: List of assistants
  - core/user/check_email: Check if an email is associated with a Zoom account
    - GET /users/email/{email}
    - Parameters: email
    - Returns: Email association status
  - core/user/check_zpk: Check Zoom Phone Key status
    - GET /users/{userId}/zpk
    - Parameters: userId
    - Returns: ZPK status

Meeting Management:
  - core/meeting/index: Meeting API overview
  - core/meeting/create: Create a meeting
    - POST /users/{userId}/meetings
    - Parameters: userId, meeting details (topic, start time, duration)
    - Returns: Created meeting information
  - core/meeting/list: List meetings for a user
    - GET /users/{userId}/meetings
    - Parameters: userId, query parameters for filtering
    - Returns: List of meetings
  - core/meeting/list_live: List live meetings
    - GET /meetings/live
    - Returns: List of currently active meetings
  - core/meeting/get: Get meeting details
    - GET /meetings/{meetingId}
    - Parameters: meetingId
    - Returns: Specific meeting details
  - core/meeting/update: Update a meeting
    - PUT /meetings/{meetingId}
    - Parameters: meetingId, updated meeting details
    - Returns: Updated meeting information
  - core/meeting/delete: Delete a meeting
    - DELETE /meetings/{meetingId}
    - Parameters: meetingId
    - Returns: Deletion status
  - core/meeting/end: End a live meeting
    - PUT /meetings/{meetingId}/status/end
    - Parameters: meetingId
    - Returns: Meeting end status
  - core/meeting/registration: Manage meeting registration
    - POST /meetings/{meetingId}/registrants
    - Parameters: meetingId, registrant details
    - Returns: Registration status

Webinar Management:
  - core/webinar/index: Webinar API overview
  - core/webinar/create: Create a webinar
    - POST /users/{userId}/webinars
    - Parameters: userId, webinar details
    - Returns: Created webinar information
  - core/webinar/list: List webinars for a user
    - GET /users/{userId}/webinars
    - Parameters: userId, query parameters
    - Returns: List of webinars
  - core/webinar/get: Get webinar details
    - GET /webinars/{webinarId}
    - Parameters: webinarId
    - Returns: Specific webinar details
  - core/webinar/update: Update a webinar
    - PUT /webinars/{webinarId}
    - Parameters: webinarId, updated webinar details
    - Returns: Updated webinar information
  - core/webinar/delete: Delete a webinar
    - DELETE /webinars/{webinarId}
    - Parameters: webinarId
    - Returns: Deletion status
  - core/webinar/end: End a webinar
    - PUT /webinars/{webinarId}/status/end
    - Parameters: webinarId
    - Returns: Webinar end status
  - core/webinar/register: Register attendees for a webinar
    - POST /webinars/{webinarId}/registrants
    - Parameters: webinarId, registrant details
    - Returns: Registration status
  - core/webinar/list_registration: List webinar registrants
    - GET /webinars/{webinarId}/registrants
    - Parameters: webinarId
    - Returns: List of registrants
  - core/webinar/get_registration: Get specific webinar registrant details
    - GET /webinars/{webinarId}/registrants/{registrantId}
    - Parameters: webinarId, registrantId
    - Returns: Registrant details
  - core/webinar/delete_registration: Delete a webinar registrant
    - DELETE /webinars/{webinarId}/registrants/{registrantId}
    - Parameters: webinarId, registrantId
    - Returns: Deletion status
  - core/webinar/list_manual_registration: List manually registered attendees
    - GET /webinars/{webinarId}/manual_registrants
    - Parameters: webinarId
    - Returns: List of manual registrants
  - core/webinar/approve_pending: Approve pending webinar registrations
    - PUT /webinars/{webinarId}/registrants/pending/approve
    - Parameters: webinarId
    - Returns: Approval status
  - core/webinar/get_panelists: Get webinar panelists
    - GET /webinars/{webinarId}/panelists
    - Parameters: webinarId
    - Returns: List of panelists
  - core/webinar/get_ended_uuid: Get ended webinar UUID
    - GET /past/webinars/{webinarId}/instances
    - Parameters: webinarId
    - Returns: List of past webinar instances
  - core/webinar/get_ended_attendees: Get attendees of an ended webinar
    - GET /past/webinars/{webinarId}/instances/{occurrenceId}/attendees
    - Parameters: webinarId, occurrenceId
    - Returns: List of attendees
  - core/webinar/get_ended_polls: Get poll results from an ended webinar
    - GET /past/webinars/{webinarId}/polls
    - Parameters: webinarId
    - Returns: Poll results
  - core/webinar/get_ended_qa: Get Q&A from an ended webinar
    - GET /past/webinars/{webinarId}/qa
    - Parameters: webinarId
    - Returns: Q&A data

Group Management:
  - core/group/index: Group API overview
  - core/group/create: Create a new group
    - POST /groups
    - Parameters: group details
    - Returns: Created group information
  - core/group/list: List groups
    - GET /groups
    - Returns: List of groups
  - core/group/get: Get group details
    - GET /groups/{groupId}
    - Parameters: groupId
    - Returns: Specific group details
  - core/group/update: Update group details
    - PUT /groups/{groupId}
    - Parameters: groupId, updated details
    - Returns: Updated group information
  - core/group/delete: Delete a group
    - DELETE /groups/{groupId}
    - Parameters: groupId
    - Returns: Deletion status
  - core/group/list_members: List members of a group
    - GET /groups/{groupId}/members
    - Parameters: groupId
    - Returns: List of group members
  - core/group/add_members: Add members to a group
    - POST /groups/{groupId}/members
    - Parameters: groupId, member details
    - Returns: Member addition status
  - core/group/delete_members: Remove members from a group
    - DELETE /groups/{groupId}/members
    - Parameters: groupId, member IDs
    - Returns: Member removal status

IM Group Management:
  - core/im_group/index: IM Group API overview
  - core/im_group/create: Create a new IM group
    - POST /im/groups
    - Parameters: IM group details
    - Returns: Created IM group information
  - core/im_group/list: List IM groups
    - GET /im/groups
    - Returns: List of IM groups
  - core/im_group/get: Get IM group details
    - GET /im/groups/{groupId}
    - Parameters: groupId
    - Returns: Specific IM group details
  - core/im_group/update: Update IM group details
    - PUT /im/groups/{groupId}
    - Parameters: groupId, updated details
    - Returns: Updated IM group information
  - core/im_group/delete: Delete an IM group
    - DELETE /im/groups/{groupId}
    - Parameters: groupId
    - Returns: Deletion status
  - core/im_group/list_members: List members of an IM group
    - GET /im/groups/{groupId}/members
    - Parameters: groupId
    - Returns: List of IM group members
  - core/im_group/add_members: Add members to an IM group
    - POST /im/groups/{groupId}/members
    - Parameters: groupId, member details
    - Returns: Member addition status
  - core/im_group/delete_members: Remove members from an IM group
    - DELETE /im/groups/{groupId}/members
    - Parameters: groupId, member IDs
    - Returns: Member removal status

Cloud Recording Management:
  - core/cloud_recording/index: Cloud Recording API overview
  - core/cloud_recording/list: List cloud recordings
    - GET /meetings/{meetingId}/recordings
    - Parameters: meetingId
    - Returns: List of cloud recordings for a meeting
  - core/cloud_recording/list_for_mc: List cloud recordings for a meeting controller
    - GET /meetings/{meetingId}/recordings
    - Parameters: meetingId
    - Returns: List of cloud recordings
  - core/cloud_recording/get: Get specific cloud recording details
    - GET /meetings/{meetingId}/recordings/{recordingId}
    - Parameters: meetingId, recordingId
    - Returns: Specific recording details
  - core/cloud_recording/delete: Delete a cloud recording
    - DELETE /meetings/{meetingId}/recordings/{recordingId}
    - Parameters: meetingId, recordingId
    - Returns: Deletion status

Device Management:
  - core/device/index: Device API overview
  - core/device/create: Create a new device
    - POST /devices
    - Parameters: device details
    - Returns: Created device information
  - core/device/list: List devices
    - GET /devices
    - Parameters: query parameters for filtering
    - Returns: List of devices
  - core/device/update: Update device details
    - PUT /devices/{deviceId}
    - Parameters: deviceId, updated details
    - Returns: Updated device information
  - core/device/delete: Delete a device
    - DELETE /devices/{deviceId}
    - Parameters: deviceId
    - Returns: Deletion status

Archived Chat Messages:
  - core/archived_chat_messages/index: Archived Chat Messages API overview
  - core/archived_chat_messages/list: List archived chat messages
    - GET /chat/archived/messages
    - Parameters: query parameters (e.g., channel name, date range)
    - Returns: List of archived chat messages
  - core/archived_chat_messages/get: Get specific archived chat messages
    - GET /chat/archived/messages/{messageId}
    - Parameters: messageId
    - Returns: Specific archived message details

```

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

### Zoom API Appendix and Lists

Source: https://github.com/zoom/api-v1/blob/master/source/index.html.md

This section provides access to supplementary information and lists relevant to the Zoom API. It includes details on recurrence patterns for meetings, available plans, and various lookup lists such as states, countries, timezones, and toll-free country codes. Examples are provided for interacting with these endpoints using cURL and Node.js.

```APIDOC
Appendix:
  - appendix/index: Appendix overview
  - appendix/recurrence: Recurrence patterns for meetings
    - GET /meetings/recurrence/patterns
    - Returns: List of recurrence patterns
  - appendix/plans: Available Zoom plans
    - GET /plans
    - Returns: List of available plans

Lists:
  - appendix/lists/index: Lists API overview
  - appendix/lists/state: List of states (for addresses)
    - GET /lists/states
    - Parameters: country code
    - Returns: List of states for a given country
  - appendix/lists/country: List of countries
    - GET /lists/countries
    - Returns: List of countries
  - appendix/lists/timezone: List of timezones
    - GET /lists/timezones
    - Returns: List of timezones
  - appendix/lists/tollfree_countries: List of toll-free countries
    - GET /lists/tollfree_countries
    - Returns: List of countries supporting toll-free numbers
  - appendix/lists/premium_countries: List of premium countries
    - GET /lists/premium_countries
    - Returns: List of countries with premium features

```
Tokens:
Raw