Testing Zoom APIs
Each Zoom API endpoint includes a testing tool widget within the Zoom API Reference Docs. This tool aims to provide you a means of testing Zoom APIs with ease and convenience without having to switch between documentation and a testing tool to gain an understanding of API capabilities and responses.
Test Request Widget
The widget is located within the “Send a Test Request” section in the documentation of each API endpoint.
The Request URL and the HTTP Request Method are pre-filled based on the resource and the request type and cannot be edited. Most Zoom APIs support OAuth tokens for authentication and will require you to generate an OAuth token before making API calls to the Zoom Service.
To retrieve this access token, you must first create an OAuth app on the Marketplace.
For testing purposes, you do not need to publish this app. You should however add this URL as your Redirect URL and also Whitelist URL: “https://marketplace.zoom.us/docs/oauth/callback/success”. This applies only while you test using the Test Request Widget within our API reference docs. You will also need valid credentials for the app as well as the Scopes required for each API.
Example Test Request
For instance, to make a List Users API call, follow the following steps:
Create an OAuth app on the Marketplace and provide basic information. If an admin level scope is required, create an account level OAuth app (recommended). Otherwise, a user-managed app is sufficient. If you already have an existing unpublished OAuth app, skip to step 2.
In the “Scopes” page, add the required scope. In this case, you should add
user:read:adminScope so that your app can request users’ authorization to view their information.
In your app, add the following URL as your Redirect URL and to your list of Whitelist URLs:
In the Test Request Widget, click the “Get Access Token” button. Provide your app’s Development Client ID and Secret that are listed on the app’s “App Credentials” page. After providing this information, click the “Get Access Token” button. An OAuth access token will then be retrieved that can be used to make requests.
Since the List Users API does not require a request body, additional request information is not needed. Optionally, you can provide the value for the query parameters in the “Query” window of the widget to filter the response section. Click the “Send” button to make the request.
The response body will be displayed in the “Body” window as shown below:
The first place to look for help is on our Developer Forum, where Zoom Marketplace Developers can ask questions for public answers.
If you can’t find the answer in the Developer Forum or your request requires sensitive information to be relayed, please email us at firstname.lastname@example.org.