Zoom
Video conferencing and virtual meeting platform
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.zoom.us/v2 | link | — | — | — |
Actions (87)
Metrics · 32
- Get CRC usageGET /metrics/crc
Get CRC Port usage.
documented - Get CRC usage (account)GET /accounts/{accountId}/metrics/crc
Get CRC port usage for the account.
documented - Get IM metricsGET /metrics/im
Get IM metrics.
documented - Get IM metrics (account)GET /accounts/{accountId}/metrics/im
Get metrics for Zoom IM.
documented - Get Zoom RoomGET /metrics/zoomrooms/{zoomroomId}
Get Zoom Room details.
documented - Get Zoom Room detail (account)GET /accounts/{accountId}/metrics/zoomrooms/{zoomroomId}
Get a Zoom Room detail.
documented - Get meeting detail (account)GET /accounts/{accountId}/metrics/meetings/{meetingID}
Get metrics for a specific meeting.
documented - Get meeting metricsGET /metrics/meetings/{meetingID}
Get metrics for a specific meeting.
documented - Get participant QoSGET /metrics/meetings/{meetingID}/participants/{participantId}/qos
Get QoS for a participant.
documented - Get participant QoS (account)GET /accounts/{accountId}/metrics/meetings/{meetingID}/participants/{participantId}/qos
Get QoS for a meeting participant.
documented - Get webinar (account)GET /metrics/webinars/{webinarID}
Get webinar metrics.
documented - Get webinar detail (account)GET /accounts/{accountId}/metrics/webinars/{webinarID}
Get metrics for a specific webinar.
documented - Get webinar participant QoSGET /accounts/{accountId}/metrics/webinars/{webinarID}/participants/{participantId}/qos
Get QoS for a webinar participant.
documented - Get webinar participant QoSGET /metrics/webinars/{webinarID}/participants/{participantId}/qos
Get QoS for a webinar participant.
documented - List Zoom Rooms (account)GET /accounts/{accountId}/metrics/zoomrooms
List Zoom Rooms metrics for the account.
documented - List Zoom Rooms (account)GET /metrics/zoomrooms
List Zoom Rooms metrics for the account.
documented - List all meeting metrics (global)GET /metrics/meetings
List meeting metrics (globally).
documented - List meeting participants (account)GET /accounts/{accountId}/metrics/meetings/{meetingID}/participants
List participants for a specific meeting.
documented - List meeting participants metricsGET /metrics/meetings/{meetingID}/participants
List participants metrics for a meeting.
documented - List meetings (account-level)GET /accounts/{accountId}/metrics/meetings
List meeting metrics for an account.
documented - List participant QoS (account)GET /accounts/{accountId}/metrics/meetings/{meetingID}/participants/qos
List QoS for meeting participants.
documented - List participants QoSGET /metrics/meetings/{meetingID}/participants/qos
List QoS for meeting participants.
documented - List participants sharingGET /metrics/meetings/{meetingID}/participants/sharing
List participants sharing and recording details.
documented - List participants sharingGET /accounts/{accountId}/metrics/meetings/{meetingID}/participants/sharing
List participants sharing and recording details for a meeting.
documented - List webinar participant QoSGET /accounts/{accountId}/metrics/webinars/{webinarID}/participants/qos
List QoS for webinar participants.
documented - List webinar participant QoSGET /metrics/webinars/{webinarID}/participants/qos
List QoS for webinar participants.
documented - List webinar participantsGET /metrics/webinars/{webinarID}/participants
List webinar participants.
documented - List webinar participants (account)GET /accounts/{accountId}/metrics/webinars/{webinarID}/participants
List webinar participants.
documented - List webinar participants sharingGET /metrics/webinars/{webinarID}/participants/sharing
List webinar participants sharing.
documented - List webinar participants sharingGET /accounts/{accountId}/metrics/webinars/{webinarID}/participants/sharing
List webinar participants sharing and recording details.
documented - List webinars (account)GET /accounts/{accountId}/metrics/webinars
List webinar metrics for an account.
documented - List webinars (account)GET /metrics/webinars
List webinar metrics for an account.
documented
IM · 15
- Add IM group membersPOST /accounts/{accountId}/im/groups/{groupId}/members
Add members to an IM group.
documented - Add IM group members (admin)POST /im/groups/{groupId}/members
Add members to an IM group.
documented - Create IM groupPOST /accounts/{accountId}/im/groups
Create an IM group.
documented - Create IM group (admin)POST /im/groups
Create an IM group.
documented - Delete IM group (admin)DELETE /im/groups/{groupId}
Delete an IM group.
documented - Delete IM group memberDELETE /accounts/{accountId}/im/groups/{groupId}/members/{memberId}
Delete a member from an IM group.
documented - Delete IM group member (admin)DELETE /im/groups/{groupId}/members/{memberId}
Delete a member from an IM group.
documented - Get IM groupGET /accounts/{accountId}/im/groups/{groupId}
Get an IM group by groupId.
documented - Get IM group (admin)GET /im/groups/{groupId}
Get an IM group by groupId.
documented - List IM group membersGET /accounts/{accountId}/im/groups/{groupId}/members
List members of an IM group.
documented - List IM group members (admin)GET /im/groups/{groupId}/members
List members of an IM group.
documented - List IM groupsGET /accounts/{accountId}/im/groups
List IM groups under a master account.
documented - List IM groups (admin)GET /im/groups
List IM groups for the admin account.
documented - Update IM groupPATCH /accounts/{accountId}/im/groups/{groupId}
Update an IM group.
documented - Update IM group (admin)PATCH /im/groups/{groupId}
Update an IM group.
documented
Admin · 13
- Add addon planPOST /accounts/{accountId}/plans/addons
Add an addon plan for a sub account.
documented - Create sub accountPOST /accounts
Create a sub account under the master account.
documented - Disassociate sub accountDELETE /accounts/{accountId}
Disassociate a sub account from the master account.
documented - Get billing infoGET /accounts/{accountId}/billing
Retrieve billing information for a sub account.
documented - Get sub accountGET /accounts/{accountId}
Retrieve a sub account by accountId.
documented - Get sub account settingsGET /accounts/{accountId}/settings
Retrieve settings for a sub account.
documented - List sub account plansGET /accounts/{accountId}/plans
Retrieve plan information for a sub account.
documented - List sub accountsGET /accounts
List all sub accounts under the master account.
documented - Subscribe plansPOST /accounts/{accountId}/plans
Subscribe plans for a sub account.
documented - Update addon planPUT /accounts/{accountId}/plans/addons
Update an addon plan for a sub account.
documented - Update base planPUT /accounts/{accountId}/plans/base
Update the base plan for a sub account.
documented - Update billing infoPATCH /accounts/{accountId}/billing
Update billing information for a sub account.
documented - Update sub account optionsPATCH /accounts/{accountId}/options
Update options for a sub account.
documented
Groups · 9
- Add group membersPOST /accounts/{accountId}/groups/{groupId}/members
Add members to a group.
documented - Create groupPOST /accounts/{accountId}/groups
Create a new group under the master account.
documented - Delete groupDELETE /accounts/{accountId}/groups/{groupId}
Delete a group.
documented - Delete group memberDELETE /accounts/{accountId}/groups/{groupId}/members/{memberId}
Delete a member from a group.
documented - Get groupGET /accounts/{accountId}/groups/{groupId}
Get a specific group by groupId.
documented - List group membersGET /accounts/{accountId}/groups/{groupId}/members
List members of a group.
documented - List group members (admin)GET /accounts/{accountId}/groups/{groupId}/members
List members of a group for an admin account.
documented - List groupsGET /accounts/{accountId}/groups
List all groups under the master account.
documented - Update groupPATCH /accounts/{accountId}/groups/{groupId}
Update group properties.
documented
Billing · 7
- Add addon planPOST /accounts/{accountId}/plans/addons
Add an addon plan for a sub account.
documented - Get billing infoGET /accounts/{accountId}/billing
Retrieve billing information for a sub account.
documented - List sub account plansGET /accounts/{accountId}/plans
Retrieve plan information for a sub account.
documented - Subscribe plansPOST /accounts/{accountId}/plans
Subscribe plans for a sub account.
documented - Update addon planPUT /accounts/{accountId}/plans/addons
Update an addon plan for a sub account.
documented - Update base planPUT /accounts/{accountId}/plans/base
Update the base plan for a sub account.
documented - Update billing infoPATCH /accounts/{accountId}/billing
Update billing information for a sub account.
documented
Accounts · 6
- Create sub accountPOST /accounts
Create a sub account under the master account.
documented - Disassociate sub accountDELETE /accounts/{accountId}
Disassociate/delete a sub account from the master account.
documented - Get sub accountGET /accounts/{accountId}
Retrieve a sub account by accountId.
documented - Get sub account settingsGET /accounts/{accountId}/settings
Retrieve settings for a sub account.
documented - List sub accountsGET /accounts
List all sub accounts under the master Zoom account.
documented - Update sub account optionsPATCH /accounts/{accountId}/options
Update options for a sub account.
documented
IM Chat · 4
- Get IM chat session messagesGET /im/chat/sessions/{sessionId}
Retrieve IM chat messages for a session.
documented - Get IM chat session messages (admin)GET /im/chat/sessions/{sessionId}
Retrieve IM chat messages for a session.
documented - List IM chat sessionsGET /im/chat/sessions
Retrieve IM chat sessions (admin).
documented - List IM chat sessions (admin)GET /im/chat/sessions
List IM chat sessions.
documented