Open documentation ↗Overview
Video communication, web conferencing, chat, and webinars
Zoom is a social API from zoom.us. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 373 endpoints.
At a glance
- Authentication
- OAuth
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Social
- Base URL
https://api.zoom.us/v2- Version
- 2.0.0
- Endpoints
- 373
- OpenAPI
- Specification ↗
- Spec updated
- 2021-07-02
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.zoom.us/v2/accounts" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://api.zoom.us/v2/accounts", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.zoom.us/v2/accounts",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /accounts | List sub accounts |
| POST | /accounts | Create a sub account |
| GET | /accounts/{accountId} | Get sub account details |
| DELETE | /accounts/{accountId} | Disassociate a sub account |
| GET | /accounts/{accountId}/billing | Get billing information |
| PATCH | /accounts/{accountId}/billing | Update billing information |
| GET | /accounts/{accountId}/billing/invoices | List billing invoices |
| GET | /accounts/{accountId}/billing/invoices/{invoiceId} | Get invoice details |
| GET | /accounts/{accountId}/lock_settings | Get locked settings |
| PATCH | /accounts/{accountId}/lock_settings | Update locked settings |
| GET | /accounts/{accountId}/managed_domains | Get managed domains |
| PATCH | /accounts/{accountId}/options | Update options |
| PUT | /accounts/{accountId}/owner | Update the account owner |
| PATCH | /accounts/{accountId}/phone/settings | Update BYOC settings |
| POST | /accounts/{accountId}/phone/setup | Set up a Zoom Phone account |
| POST | /accounts/{accountId}/phone/sip_trunk/trunks | Assign SIP trunks |
| PATCH | /accounts/{accountId}/phone/sip_trunk/trunks/{sipTrunkId} | Update SIP trunk details |
| GET | /accounts/{accountId}/plans | Get plan Information |
| POST | /accounts/{accountId}/plans | Subscribe plans |
| POST | /accounts/{accountId}/plans/addons | Subscribe additional plan |
| PUT | /accounts/{accountId}/plans/addons | Update an additional plan |
| PATCH | /accounts/{accountId}/plans/addons/status | Cancel additional plans |
| PUT | /accounts/{accountId}/plans/base | Update a base plan |
| PATCH | /accounts/{accountId}/plans/base/status | Cancel a base plan |
| GET | /accounts/{accountId}/plans/usage | Get plan usage |
| GET | /accounts/{accountId}/recordings | List recordings of an account |
| GET | /accounts/{accountId}/settings | Get settings |
| PATCH | /accounts/{accountId}/settings | Update settings |
| POST | /accounts/{accountId}/settings/virtual_backgrounds | Upload virtual background files |
| DELETE | /accounts/{accountId}/settings/virtual_backgrounds | Delete virtual background files |
| GET | /accounts/{accountId}/sip_trunk/callout_countries | List internal call-out countries |
| POST | /accounts/{accountId}/sip_trunk/callout_countries | Add internal call-out countries |
| DELETE | /accounts/{accountId}/sip_trunk/callout_countries/{countryId} | Delete internal call-out country |
| GET | /accounts/{accountId}/sip_trunk/internal_numbers | List internal numbers |
| POST | /accounts/{accountId}/sip_trunk/internal_numbers | Add internal numbers |
| DELETE | /accounts/{accountId}/sip_trunk/internal_numbers/{numberId} | Delete an internal number |
| POST | /accounts/{accountId}/sip_trunk/numbers | Assign numbers |
| DELETE | /accounts/{accountId}/sip_trunk/numbers | Delete all numbers |
| PATCH | /accounts/{accountId}/sip_trunk/settings | Assign SIP trunk configuration |
| GET | /accounts/{accountId}/sip_trunk/trunks | List SIP trunks |
| POST | /accounts/{accountId}/sip_trunk/trunks | Assign SIP trunks |
| DELETE | /accounts/{accountId}/sip_trunk/trunks/{trunkId} | Delete a SIP trunk |
| GET | /accounts/{accountId}/trusted_domains | Get trusted domains |
| PUT | /accounts/{accountId}/users/{userId}/account | Switch a user's account |
| GET | /api/download/billing/invoices/{invoiceId} | Download an invoice file |
| GET | /archive_files | List archived files |
| GET | /chat/channels/{channelId} | Get a channel |
| PATCH | /chat/channels/{channelId} | Update a channel |
| DELETE | /chat/channels/{channelId} | Delete a channel |
| POST | /chat/channels/{channelId}/members/me | Join a channel |
| DELETE | /chat/channels/{channelId}/members/me | Leave a channel |
| DELETE | /chat/channels/{channelId}/members/{memberId} | Remove a member |
| GET | /chat/users/me/contacts | List user's contacts |
| GET | /chat/users/me/contacts/{contactId} | Get user's contact details |
| GET | /chat/users/{userId}/channels | List user's channels |
| POST | /chat/users/{userId}/channels | Create a channel |
| GET | /chat/users/{userId}/channels/{channelId} | Get a channel |
| PATCH | /chat/users/{userId}/channels/{channelId} | Update a channel |
| DELETE | /chat/users/{userId}/channels/{channelId} | Delete a channel |
| GET | /chat/users/{userId}/channels/{channelId}/members | List channel members |
| POST | /chat/users/{userId}/channels/{channelId}/members | Invite channel members |
| DELETE | /chat/users/{userId}/channels/{channelId}/members/{memberId} | Remove a member |
| GET | /chat/users/{userId}/messages | List user's chat messages |
| POST | /chat/users/{userId}/messages | Send a chat message |
| PUT | /chat/users/{userId}/messages/{messageId} | Update a message |
| DELETE | /chat/users/{userId}/messages/{messageId} | Delete a message |
| GET | /contacts | Search company contacts |
| GET | /groups | List groups |
| POST | /groups | Create a group |
| GET | /groups/{groupId} | Get a group |
| PATCH | /groups/{groupId} | Update a group |
| DELETE | /groups/{groupId} | Delete a group |
| GET | /groups/{groupId}/lock_settings | Get locked settings |
| PATCH | /groups/{groupId}/lock_settings | Update locked settings |
| GET | /groups/{groupId}/members | List group members |
| POST | /groups/{groupId}/members | Add group members |
| PATCH | /groups/{groupId}/members/{memberId} | Update a group member |
| DELETE | /groups/{groupId}/members/{memberId} | Delete a group member |
| GET | /groups/{groupId}/settings | Get a group's settings |
| PATCH | /groups/{groupId}/settings | Update a group's settings |
| POST | /groups/{groupId}/settings/virtual_backgrounds | Upload virtual background files |
| DELETE | /groups/{groupId}/settings/virtual_backgrounds | Delete virtual background files |
| GET | /h323/devices | List H.323/SIP devices |
| POST | /h323/devices | Create a H.323/SIP device |
| PATCH | /h323/devices/{deviceId} | Update a H.323/SIP device |
| DELETE | /h323/devices/{deviceId} | Delete a H.323/SIP device |
| POST | /im/chat/messages | Send chatbot messages |
| PUT | /im/chat/messages/{message_id} | Edit a chatbot message |
| DELETE | /im/chat/messages/{message_id} | Delete a chatbot message |
| GET | /im/chat/sessionsdeprecated | Get IM chat sessions |
| GET | /im/chat/sessions/{sessionId}deprecated | Get IM chat messages |
| GET | /im/groups | List IM directory groups |
| POST | /im/groups | Create an IM directory group |
| GET | /im/groups/{groupId} | Retrieve an IM directory group |
| PATCH | /im/groups/{groupId} | Update an IM directory group |
| DELETE | /im/groups/{groupId} | Delete an IM directory group |
| GET | /im/groups/{groupId}/members | List IM directory group members |
| POST | /im/groups/{groupId}/members | Add IM directory group members |
| DELETE | /im/groups/{groupId}/members/{memberId} | Delete an IM directory group member |
| POST | /im/users/me/chat/messagesdeprecated | Send IM messages |
Showing the first 100 of 373 endpoints; the full list is in the documentation.
Questions
Does the Zoom API need an API key?
Yes. The Zoom API uses OAuth authentication; the documentation explains how to get credentials.
Does the Zoom API support HTTPS?
Yes, the Zoom API is served over HTTPS.
How many endpoints does the Zoom API have?
Its OpenAPI description lists 373 endpoints in version 2.0.0. The first 100 are shown on this page.
What are alternatives to the Zoom API?
Other Social APIs include Blogger, Facebook, Twitter, Pinterest, TikTok.
Similar social APIs
Compare alternatives →Blogger
SocialThe Blogger APIs allows client applications to view and update Blogger content
OAuth
Facebook Login, Share on FB, Social Plugins, Analytics and more
OAuth
Read and write Twitter data
OAuth
The world's catalog of ideas
OAuth
TikTok
SocialFetches user info and user's video posts on TikTok platform
OAuth
Twitter API
SocialUse the X API with an all-new Developer Console and consumption-based billing. No fixed monthly costs, no monthly caps.
No auth83 endpoints
Listed from public-apis database (MIT), APIs.guru (CC0).