Zoom API
API Description
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API Description
Endpoints 155
Accounts
- GETList sub accounts
/accounts?page_size=30&page_number=1List all the sub accounts under the master account - POSTCreate a sub account
/accountsCreate a sub account under the master account. <aside>Your account must be a master account and have this privilege to create sub account. Zoom only assigns… - GETRetrieve a sub account
/accounts/:accountIdRetrieve a sub account under the master account. <aside>Your account must be a master account and have this privilege to read sub accounts. Zoom only assigns… - DELETEDisassociate an account
/accounts/:accountIdDisassociate a sub account from the master account. This will leave the account intact but the sub account will not longer be associated with the master… - PATCHUpdate a sub account's options
/accounts/:accountId/optionsUpdate a sub account's options under the master account - GETRetrieve a sub account's settings
/accounts/:accountId/settingsRetrieve a sub account's settings under the master account - PATCHUpdate a sub account's settings
/accounts/:accountId/settingsUpdate a sub account's settings under the master account - GETRetrieve a sub account's managed domains
/accounts/:accountId/managed_domainsRetrieve a sub account's managed domains under the master account
Billing
- GETRetrieve billing information for a sub account
/accounts/:accountId/billingRetrieve billing information for a sub account under the master account - PATCHUpdate billing information for a sub account
/accounts/:accountId/billingUpdate billing information for a sub account under the master account <aside>Only for the sub account which is a paid account and paid by master account</aside> - GETRetrieve plan information for a sub account
/accounts/:accountId/plansRetrieve plan information for a sub account under the master account <aside>Only for the sub account which is paid by master account</aside> - POSTSubscribe plans for a sub account
/accounts/:accountId/plansSubscribe plans for a sub account of the master account <aside>Can only subscribe plans for the sub account which is a free account and paid by master… - PUTUpdate a base plan for a sub account
/accounts/:accountId/plans/baseUpdate a base plan for a sub account <aside>Can only update a base plan for the sub account which is a paid account and paid by master account</aside> - PUTUpdate an additional plan for sub account
/accounts/:accountId/plans/addonsUpdate an additional plan for sub account<aside>Can only update an Additional plan for the sub account which is a paid account and paid by master… - POSTAdd an additional plan for sub account
/accounts/:accountId/plans/addonsAdd an additional plan for sub account <aside>Can only add an Additional plan for the sub account which is a paid account and paid by master account</aside>
Users
- GETList Users
/users?status=active&page_size=30&page_number=1List users on your account - POSTCreate a user
/usersCreate a user on your account - GETRetrieve a user
/users/:userId?login_type=0Retrieve a user on your account - DELETEDelete a user
/users/:userId?action=disassociate&transfer_email=string&transfer_meeting=true&transfer_webinar=true&transfer_recording=trueDelete a user on your account - PATCHUpdate a user
/users/:userIdUpdate a user on your account - GETList a user's assistants
/users/:userId/assistantsList a user's assistants - POSTAdd assistants
/users/:userId/assistantsAdd assistants to a user - DELETEDelete a user's assistants
/users/:userId/assistantsDelete all of a user'sassitants - DELETEDelete a user's assistant
/users/:userId/assistants/:assistantIdDelete one of a user's assistants - GETList a user's schedulers
/users/:userId/schedulersList a user's schedulers - DELETEDelete a user's schedulers
/users/:userId/schedulersDelete all of a user'schedulers - DELETEDelete a user's scheduler
/users/:userId/schedulers/:schedulerIdDelete one of a user's schedulers - POSTUpload a user's picture
/users/:userId/pictureUpload a user's profile picture - GETRetrieve a user's settings
/users/:userId/settings?login_type=0Retrieve a user's settings - PATCHUpdate a user's settings
/users/:userId/settingsUpdate a user's settings - PUTUpdate a user's status
/users/:userId/statusUpdate a user's status - PUTUpdate a user's password
/users/:userId/passwordUpdate a user's password - GETRetrieve a user's permissions
/users/:userId/permissionsRetrieve a user's permissions - GETRetrieve a user's token
/users/:userId/token?type=tokenRetrieve a user's token - DELETERevoke a user's SSO token
/users/:userId/tokenRevoke a user's SSO token - PUTUpdate a user's email
/users/:userId/emailUpdate a user's email - GETVerify a user's zpk (Deprecated
/users/zpk?zpk=stringCheck if the zpk is expired. The zpk is used to authenticate a user. - GETCheck a user's email
/users/email?email=stringCheck if the user email exists - GETCheck a user's personal meeting room name
/users/vanity_name?vanity_name=stringCheck if the user's personal meeting room name exists
Meetings
- GETList meetings
/users/:userId/meetings?type=live&page_size=30&page_number=1List meetings for a user - POSTCreate a meeting
/users/:userId/meetingsCreate a meeting for a user <aside>The expiration time of start_url is two hours. But for API users, the expiration time is 90 days.</aside> - GETRetrieve a meeting
/meetings/:meetingIdRetrieve a meeting's details - DELETEDelete a meeting
/meetings/:meetingId?occurrence_id=stringDelete a meeting - PATCHUpdate a meeting
/meetings/:meetingIdUpdate a meeting's details - PUTUpdate a meeting's status
/meetings/:meetingId/statusUpdate a meeting's status - GETRetrieve meeting invitation
/meetings/:meetingId/invitationRetrieve a meeting invitation - GETList a meeting's registrants
/meetings/:meetingId/registrants?occurrence_id=string&status=approved&page_size=30&page_number=1List registrants of a meeting - POSTAdd a meeting registrant
/meetings/:meetingId/registrants?occurrence_ids=stringRegister a participant for a meeting - PUTUpdate a meeting registrant's status
/meetings/:meetingId/registrants/status?occurrence_id=stringUpdate a meeting registrant's status - PATCHUpdate a meeting live stream
/meetings/:meetingId/livestreamUpdate a meeting's live stream - PATCHUpdate a meeting live stream status
/meetings/:meetingId/livestream/statusUpdate a meeting's live stream status - GETRetrieve past meeting details
/past_meetings/:meetingUUIDRetrieve ended meeting details - GETRetrieve past meeting participants
/past_meetings/:meetingUUID/participants?page_size=30&next_page_token=stringRetrieve ended meeting participants - GETList of ended meeting instances
/past_meetings/:meetingId/instancesList of ended meeting instances - GETList a meeting's polls
/meetings/:meetingId/pollsList polls of a meeting - POSTCreate a meeting's poll
/meetings/:meetingId/pollsCreate a poll for a meeting - GETRetrieve a meeting's poll
/meetings/:meetingId/polls/:pollIdRetrieve a meeting's poll - PUTUpdate a meeting's poll
/meetings/:meetingId/polls/:pollIdUpdate a meeting's poll - DELETEDelete a meeting's Poll
/meetings/:meetingId/polls/:pollIdDelete a meeting's Poll
Webinars
- GETList webinars
/users/:userId/webinars?page_size=30&page_number=1List webinars for a user - POSTCreate a webinar
/users/:userId/webinarsCreate a webinar for a user <aside>The expiration time of start_url is two hours. But for API users, the expiration time is 90 days.</aside> - GETRetrieve a webinar
/webinars/:webinarIdRetrieve a webinar - DELETEDelete a webinar
/webinars/:webinarId?occurrence_id=stringDelete a webinar - PATCHUpdate a webinar
/webinars/:webinarIdUpdate a webinar - PUTUpdate a webinar's status
/webinars/:webinarId/statusUpdate a webinar's status - GETList a webinar's panelists
/webinars/:webinarId/panelistsList panelists for a webinar - POSTAdd a webinar panelist
/webinars/:webinarId/panelistsAdd panelist to webinar - DELETERemove a webinar's panelists
/webinars/:webinarId/panelistsRemove all panelists from a webinar - DELETERemove a webinar panelist
/webinars/:webinarId/panelists/:panelistIdRemove a panelist from a webinar - GETList a webinar's registrants
/webinars/:webinarId/registrants?occurrence_id=string&status=approved&page_size=30&page_number=1List registrants for a webinar - POSTAdd a webinar registrant
/webinars/:webinarId/registrants?occurrence_ids=stringAdd a registrant for a webinar - PUTUpdate a webinar registrant's status
/webinars/:webinarId/registrants/status?occurrence_id=stringUpdate a webinar registrant's status - GETList of ended webinar instances
/past_webinars/:webinarId/instancesList of ended webinar instances - GETList a webinar's polls
/webinars/:webinarId/pollsList polls of a webinar - POSTCreate a webinar's poll
/webinars/:webinarId/pollsCreate a poll for a webinar - GETRetrieve a webinar's poll
/webinars/:webinarId/polls/:pollIdRetrieve a webinar's poll - PUTUpdate a webinar's poll
/webinars/:webinarId/polls/:pollIdUpdate a webinar's poll - DELETEDelete a webinar's Poll
/webinars/:webinarId/polls/:pollIdDelete a webinar's Poll
Groups
- GETList groups
/groupsList groups under your account - POSTCreate a group
/groupsCreate a group under your account - GETRetrieve a group
/groups/:groupIdRetrieve a group under your account - DELETEDelete a group
/groups/:groupIdDelete a group under your account - PATCHUpdate a group
/groups/:groupIdUpdate a group under your account - GETList a group's members
/groups/:groupId/members?page_size=30&page_number=1List a group's members under your account - POSTAdd group members
/groups/:groupId/membersAdd members to a group under your account - DELETEDelete a group member
/groups/:groupId/members/:memberIdDelete a member from a group under your account
IM Groups
- GETList IM Groups
/im/groupsList IM groups under your account - POSTCreate an IM Group
/im/groupsCreate a IM Group under your account - GETRetrieve an IM Group
/im/groups/:groupIdRetrieve an IM Group under your account - DELETEDelete an IM Group
/im/groups/:groupIdDelete an IM Group under your account - PATCHUpdate an IM Group
/im/groups/:groupIdUpdate an IM Group under your account - GETList an IM Group's members
/im/groups/:groupId/members?page_size=30&page_number=1List an IM Group's members under your account - POSTAdd IM Group members
/im/groups/:groupId/membersAdd members to an IM Group under your account - DELETEDelete an IM Group member
/im/groups/:groupId/members/:memberIdDelete a member from an IM Group under your account
IM Chat
- GETRetrieve IM Chat sessions
/im/chat/sessions?from=2024-01-01&to=2024-01-01&page_size=30&next_page_token=stringRetrieve IM Chat sessions for a specified period <aside>This API only supports oauth2.</aside> - GETRetrieve IM Chat messages
/im/chat/sessions/:sessionId?from=2024-01-01&to=2024-01-01&page_size=30&next_page_token=stringRetrieve IM Chat messages for a specified period <aside>This API only supports oauth2.</aside>
Cloud Recording
- GETList all the recordings
/users/:userId/recordings?from=2024-01-01&to=2024-01-01&page_size=30&next_page_token=string&mc=false&trash=falseList all the recordings - GETRetrieve a meeting’s all recordings
/meetings/:meetingId/recordingsRetrieve a meeting’s all recordings - DELETEDelete a meeting's recordings
/meetings/:meetingId/recordings?action=trashDelete a meeting's recordings - DELETEDelete one meeting recording file
/meetings/:meetingId/recordings/:recordingId?action=trashDelete one meeting recording file - PUTRecover a meeting's recordings
/meetings/:meetingId/recordings/statusRecover a meeting's recordings - PUTRecover a single recording
/meetings/:meetingId/recordings/:recordingId/statusRecover a single recording - GETRetrieve a meeting recording's settings
/meetings/:meetingId/recordings/settingsRetrieve a meeting recording's settings - PATCHUpdate a meeting recording's settings
/meetings/:meetingId/recordings/settingsUpdate a meeting recording's settings
Reports
- GETRetrieve daily report
/report/daily?year=0&month=0Retrieve daily report for one month, can only get daily report for recent 6 months - GETRetrieve hosts report
/report/users?type=active&from=2024-01-01&to=2024-01-01&page_size=30&page_number=1Retrieve active or inactive hosts report for a specified period - GETRetrieve meetings report
/report/users/:userId/meetings?from=2024-01-01&to=2024-01-01&page_size=30&next_page_token=stringRetrieve ended meetings report for a specified period - GETRetrieve meeting details report
/report/meetings/:meetingIdRetrieve ended meeting details report - GETRetrieve meeting participants report
/report/meetings/:meetingId/participants?page_size=30&next_page_token=stringRetrieve ended meeting participants report - GETRetrieve meeting polls report
/report/meetings/:meetingId/pollsRetrieve ended meeting polls report - GETRetrieve webinar details report
/report/webinars/:webinarIdRetrieve ended webinar details report - GETRetrieve webinar participants report
/report/webinars/:webinarId/participants?page_size=30&next_page_token=stringRetrieve ended webinar participants report - GETRetrieve webinar polls report
/report/webinars/:webinarId/pollsRetrieve ended webinar polls report - GETRetrieve webinar Q&A report
/report/webinars/:webinarId/qaRetrieve ended webinar Q&A report - GETRetrieve telephone report
/report/telephone?type=1&from=2024-01-01&to=2024-01-01&page_size=30&page_number=1Retrieve telephone report for a specified period <aside>Toll Report option would be removed.</aside>. - GETRetrieve cloud recording usage report
/report/cloud_recording?from=2024-01-01&to=2024-01-01Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports for the most recent period of 6 months. The date gap…
Dashboards
- GETList meetings
/metrics/meetings?type=live&from=2024-01-01&to=2024-01-01&page_size=30&next_page_token=stringList live meetings or past meetings for a specified period - GETRetrieve meeting detail
/metrics/meetings/:meetingId?type=liveRetrieve live or past meetings detail - GETRetrieve meeting participants
/metrics/meetings/:meetingId/participants?type=live&page_size=30&next_page_token=stringRetrieve live or past meetings participants - GETRetrieve meeting participant QOS
/metrics/meetings/:meetingId/participants/:participantId/qos?type=liveRetrieve live or past meetings participant quality of service - GETList meeting participants QOS
/metrics/meetings/:meetingId/participants/qos?type=live&page_size=1&next_page_token=stringRetrieve list of live or past meetings participants quality of service - GETRetrieve sharing/recording details of meeting participant
/metrics/meetings/:meetingId/participants/sharing?type=live&page_size=30&next_page_token=stringRetrieve sharing/recording details of live or past meetings participant - GETList webinars
/metrics/webinars?type=live&from=2024-01-01&to=2024-01-01&page_size=30&next_page_token=stringList live webinars or past webinars for a specified period - GETRetrieve webinar detail
/metrics/webinars/:webinarId?type=liveRetrieve live or past webinars detail - GETRetrieve webinar participants
/metrics/webinars/:webinarId/participants?type=live&page_size=30&next_page_token=stringRetrieve live or past webinar participants - GETRetrieve webinar participant QOS
/metrics/webinars/:webinarId/participants/:participantId/qos?type=liveRetrieve live or past webinar participant quality of service - GETList webinar participant QOS
/metrics/webinars/:webinarId/participants/qos?type=live&page_size=1&next_page_token=stringRetrieve list of live or past webinar participants quality of service - GETRetrieve sharing/recording details of webinar participant
/metrics/webinars/:webinarId/participants/sharing?type=live&page_size=30&next_page_token=stringRetrieve sharing/recording details of live or past webinar participant - GETList Zoom Rooms
/metrics/zoomrooms?page_size=30&page_number=1List all zoom rooms on account - GETRetrieve Zoom Room
/metrics/zoomrooms/:zoomroomId?from=2024-01-01&to=2024-01-01&page_size=30&page_number=1Retrieve zoom room on account - GETRetrieve CRC Port Usage
/metrics/crc?from=2024-01-01&to=2024-01-01Get CRC Port usage hour by hour for a specified time period <aside class='notice'>We will report a maximum of one month. For example, if "from" is set to… - GETRetrieve IM
/metrics/im?from=2024-01-01&to=2024-01-01&page_size=30&next_page_token=stringRetrieve metrics of Zoom IM
Webhooks
- PATCHSwitch webhook version
/webhooks/optionsSwitch webhook version - GETList webhooks
/webhooksList webhooks for a account - POSTCreate a webhook
/webhooksCreate a webhook for a account - GETRetrieve a webhook
/webhooks/:webhookIdRetrieve a webhook - DELETEDelete a webhook
/webhooks/:webhookIdDelete a webhook - PATCHUpdate a webhook
/webhooks/:webhookIdUpdate a webhook
TSP
- GETRetrieve account's TSP information
/tspRetrieve TSP information on account level - PATCHUpdate account's TSP information
/tspUpdate TSP information on account level - GETList user's TSP accounts
/users/:userId/tspList user's TSP accounts - POSTAdd a user's TSP account
/users/:userId/tspAdd a user's TSP account - GETRetrieve a user's TSP account
/users/:userId/tsp/:tspIdRetrieve a user's TSP account - DELETEDelete a user's TSP account
/users/:userId/tsp/:tspIdDelete a user's TSP account - PATCHUpdate a TSP account
/users/:userId/tsp/:tspIdUpdate a user's TSP account
PAC
- GETList user's PAC accounts
/users/:userId/pacList user's PAC accounts
Devices
- GETList H.323/SIP Devices.
/h323/devicesList H.323/SIP Devices on your Zoom account. - POSTCreate a H.323/SIP Device
/h323/devicesCreate a H.323/SIP Device on your Zoom account - DELETEDelete a H.323/SIP Device
/h323/devices/:deviceIdDelete a H.323/SIP Device on your Zoom account - PATCHUpdate a H.323/SIP Device
/h323/devices/:deviceIdUpdate a H.323/SIP Device on your Zoom account
TrackingField
- GETList Tracking Fields.
/v2/tracking_fieldsList Tracking Fields on your Zoom account. - POSTCreate a Tracking Field
/v2/tracking_fieldsCreate a Tracking Field on your Zoom account - GETRetrieve a tracking field
/v2/tracking_fields/:fieldIdRetrieve a tracking field - DELETEDelete a Tracking Field
/v2/tracking_fields/:fieldIdDelete a Tracking Field on your Zoom account - PATCHUpdate a Tracking Field
/v2/tracking_fields/:fieldIdUpdate a Tracking Field on your Zoom account
API details
- Base URL
https://api.zoom.us/v2- Authentication
- An API key in the access_token query parameter
- Operations
- 155 operations on 103 pathsGET 80DELETE 23POST 21PATCH 18PUT 13
- Main resources
- Users 24Meetings 20Webinars 19Dashboards 16Reports 12Accounts 8Cloud Recording 8Groups 8IM Groups 8Billing 7
- Response formats
application/jsonapplication/xml- Description format
- Swagger 2.0, API version
2.0.0 - Links
- Documentation · OpenAPI document · Support
- Listed from
- Zoom's published OpenAPI description (zoom/api) (Apache-2.0)
How to test the Zoom API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Zoom API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the access_token query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List sub accounts” (GET /accounts?page_size=30&page_number=1), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Zoom API?
API Description It is listed under Communication and has 155 endpoints.
Who publishes the Zoom API?
It is listed from Zoom's public API description (an OpenAPI document), not published by Zoom on Swastik Codes. Anyone who controls zoom.us can claim the profile by adding a DNS TXT record.
What is the base URL of the Zoom API?
Requests go to https://api.zoom.us/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Zoom API?
With an API key in the access_token query parameter.
How many endpoints does the Zoom API have?
155 operations on 103 paths (80 GET, 23 DELETE, 21 POST, 18 PATCH, 13 PUT). The largest groups are Users, Meetings, Webinars, Dashboards.
Is forking the Zoom API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.