How to integrate Zoom using PowerShell
Learn how to quickly and efficiently connect Zoom with PowerShell for smooth data access.
Read and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required. You can do it all using the high-performance Zoom ODBC Driver for PowerShell (often referred to as the Zoom Connector). We'll walk you through the entire setup.
Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.
Create data source using Zoom ODBC Driver
Step-by-step instructions
To get data from Zoom using PowerShell, we first need to create an ODBC data source. We will later read this data in PowerShell. Perform these steps:
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ZappySys API Driver driver:
ZappySys API Driver
- Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
- Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Zoom" from the list of Popular Connectors. If "Zoom" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
ZoomDSNZoom
-
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Zoom authentication
OAuth App must be created under Admin Console > Channel > API > Settings. [API reference]
Follow the steps below to create a Zoom OAuth app and obtain the required credentials (Client ID and Client Secret):
- Go to the Zoom App Marketplace and sign in with your Zoom account.
- From the top navigation bar, open the Develop dropdown and select Build App.
- In the What kind of app are you creating window, select General App, click the Create button.
- Enter a name for your app and select the app type.
(E.g. Zoom-General App) - Click Create to continue.
- In the Redirect URL for OAuth field, enter the following URI and add it to the allow list:
https://zappysys.com/oauth/ - Copy your Client ID and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
- From the Scopes window, please add the appropriate Granular scopes. You can search for the scopes listed below and enable them as needed.
Scope Levels:- User-Level: Grants access only to the authenticated user’s data. Suitable for apps where users connect with their own Zoom account.
- Admin-Level: Grants access to data across all users in the account, provided the user has admin permissions. Best for organization-wide apps.
- Master-Level: Grants access at the highest level, typically for apps that need full account control (including sub-accounts). Requires Master Account credentials.
Recommended Scopes:
User-Level- user:read:settings
- meeting:read:list_meetings
- meeting:read:meeting
- meeting:read:list_registrants
- meeting:read:past_meeting
- meeting:read:list_registration_questions
- webinar:read:list_webinars
- webinar:read:webinar
- webinar:read:list_registrants
- report:read:user
- user:read:settings:admin
- user:write:user:admin
- meeting:read:list_meetings:admin
- meeting:read:meeting:admin
- meeting:read:list_registrants:admin
- meeting:read:past_meeting:admin
- meeting:read:list_registration_questions:admin
- user:read:list_users:admin
- webinar:read:list_webinars:admin
- webinar:read:webinar:admin
- webinar:read:list_registrants:admin
- report:read:user:admin
- user:read:settings:master
- meeting:read:list_meetings:master
- meeting:read:meeting:master
- meeting:read:list_registrants:master
- user:read:list_users:master
- webinar:read:list_webinars:master
- webinar:read:webinar:master
- webinar:read:list_registrants:master
- report:read:user:master
- That’s it! After adding the scopes, click Continue to complete the process.
- In the ZappySys API Component/Driver UI, enter your Zoom app Client ID and Client Secret, then click Generate Token to obtain the access tokens.
- You’re done!
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
User Credentials (Access Your Data) [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Press Generate Token button to generate the tokens.
- Finally, hit OK button:
ZoomDSNZoomUser Credentials (Access Your Data) [OAuth]https://api.zoom.us/v2Required Parameters Client Id Fill-in the parameter... Client Secret Fill-in the parameter... Redirect Url Fill-in the parameter... Token Url Fill-in the parameter... Authorization Url Fill-in the parameter... Optional Parameters Retry Mode RetryWhenStatusCodeMatch Retry Status Code 429 Retry Count Max 5 Retry Multiply Wait Time True
Zoom authentication
Server-to-Server OAuth authentication method that lets applications access the Zoom API directly without user login or consent, using a Client ID and Secret to generate short-lived tokens. [API reference]
Follow the steps below to create a Zoom OAuth app and obtain the required credentials (Client ID and Client Secret):
- Go to the Zoom App Marketplace and sign in with your Zoom account.
- From the top navigation bar, open the Develop dropdown and select Build App.
- In the What kind of app are you creating window, select Server to Server OAuth App, click the Create button.
- Enter a name for your app and select the app type.
(E.g. Basic OAuth App) - Click Create to continue.
- Copy your Account ID, Client ID, and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
- In the Information window, enter the company name, developer name, and email address, then click Continue.
- From the Scopes window, please add the appropriate Granular scopes. You can search for the scopes listed below and enable them as needed.
Scope Levels:- Admin-Level: Grants access to data across all users in the account, provided the user has admin permissions. Best for organization-wide apps.
- Master-Level: Grants access at the highest level, typically for apps that need full account control (including sub-accounts). Requires Master Account credentials.
Recommended Scopes:
Admin-Level- user:read:settings:admin
- user:write:user:admin
- meeting:read:list_meetings:admin
- meeting:read:meeting:admin
- meeting:read:list_registrants:admin
- meeting:read:past_meeting:admin
- meeting:read:list_registration_questions:admin
- user:read:list_users:admin
- webinar:read:list_webinars:admin
- webinar:read:webinar:admin
- webinar:read:list_registrants:admin
- report:read:user:admin
- user:read:settings:master
- meeting:read:list_meetings:master
- meeting:read:meeting:master
- meeting:read:list_registrants:master
- user:read:list_users:master
- webinar:read:list_webinars:master
- webinar:read:webinar:master
- webinar:read:list_registrants:master
- report:read:user:master
- That’s it! After adding the scopes, click Continue to complete the process.
- In the ZappySys API Component/Driver UI, enter your Zoom app Account ID, Client ID, and Client Secret, then click Test Connection.
- You’re done!
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
App Credentials (Access Account Level Data) [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ZoomDSNZoomApp Credentials (Access Account Level Data) [OAuth]https://api.zoom.us/v2Required Parameters Account Id Fill-in the parameter... Client Id Fill-in the parameter... Client Secret Fill-in the parameter... Token Url Fill-in the parameter... Optional Parameters Retry Mode RetryWhenStatusCodeMatch Retry Status Code 429 Retry Count Max 5 Retry Multiply Wait Time True
Zoom authentication
OAuth App must be created under Admin Console > Channel > API > Settings. [API reference]
Perform the following steps to get the Zoom OAuth credentials (i.e. Client ID and Client Secret)
- Go to Zoom Marketplace Portal and sign in there.
- Once you successfully login then select "Build App" option from Develop dropdown from top left on the page.
- Click on Create button of OAuth panel section of page.
- Enter the name for your application and choose app type (Recommneded "Account-Level App") option for your API
- Then proceed with clicking Create button.
- In Redirect URL for OAuth enter this https://zappysys.com/oauth/ as Redirect URI and add it to allow lists.
- Copy Client ID and Client Secret here and paste it into Connection Manager Required Paramters section in respective place holders
- Add appropiate scopes from the Scopes menu option to the right side of page for your API as below :
NOTE: If you need to read/write data for all users (not just 'me') then add
:adminsuffix in the scope (e.g.meeting:read:admin)- meeting:read
- meeting:write
- user:read
- user:write
- user_info:read
- meeting:read
- chat_channel:read
- chat_channel:write
- chat_contact:read
- chat_message:read
- chat_message:write
- contact:read
- pac:read
- pac:write
- phone:read
- phone:write
- phone_call_control:read
- phone_call_control:write
- phone_call_log:read
- phone_call_log:write
- phone_e911:read
- phone_recording:read
- phone_recording:write
- phone_sms:read
- phone_sms:write
- phone_voicemail:read
- phone_voicemail:write
- recording:read
- recording:write
- tsp:read
- tsp:write
- user:read
- user:write
- user_info:read
- user_zak:read
- webinar:read
- webinar:write
- report:read:user
- Click Generate Token button on Connection Manager UI to generate tokens.
- That's it!
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
User Credentials (Access Your Data) - With Legacy Scopes [OAuth] - Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Press Generate Token button to generate the tokens.
- Finally, hit OK button:
ZoomDSNZoomUser Credentials (Access Your Data) - With Legacy Scopes [OAuth]https://api.zoom.us/v2Required Parameters ClientId Fill-in the parameter... ClientSecret Fill-in the parameter... RedirectUrl Fill-in the parameter... TokenUrl Fill-in the parameter... AuthorizationUrl Fill-in the parameter... Optional Parameters Scope RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429 RetryCountMax 5 RetryMultiplyWaitTime True
-
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - ZoomRead and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.ZoomDSN
-
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in PowerShell to retrieve data from Zoom. Hit OK button to use this query in the next step.
SELECT * FROM Meetings WITH( UserId ='me' -- enter user id or email )
Some parameters configured in this window will be passed to the Zoom API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in PowerShell:
ZappySys API Driver - ZoomRead and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.ZoomDSNSELECT * FROM Meetings WITH( UserId ='me' -- enter user id or email )
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHEREclause,LIMITkeyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Zoom API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Zoom servers). -
Click OK to finish creating the data source.
Video Tutorial
Read Zoom data in PowerShell
Sometimes, you need to quickly access and work with your Zoom data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:
Viewing data in a terminal- Quickly peek at Zoom data
- Monitor data constantly in your console
- Export data to a CSV file so that it can be sliced and diced in Excel
- Export data to a JSON file so that it can ingested by other processes
- Export data to an HTML file for user-friendly view and easy sharing
- Create a schedule to make it an automatic process
- Store data internally for analysis or for further ETL processes
- Create a schedule to make it an automatic process
- Integrate data with other systems via external APIs
In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!
Reading individual fields
-
Open your favorite PowerShell IDE (we are using Visual Studio Code).
-
Use this code snippet to read the data using
ZoomDSNdata source:"DSN=ZoomDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=ZoomDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual Zoom fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }Access specific Zoom table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]DataTable.Rowsproperty in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in Zoom. -
To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:
You can also use even a simpler command inside the terminal, e.g.:. 'C:\Users\john\Documents\dsn.ps1'
Retrieving all fields
However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:
Again, for your convenience, here is the whole PowerShell script:
# Configure connection string and query
$connectionString = "DSN=ZoomDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Display data in the console
foreach ($row in $table.Rows) {
$line = ""
foreach ($column in $table.Columns) {
$value = $row[$column.ColumnName]
# Let's handle NULL values
if ($value -is [DBNull])
{
$value = "(NULL)"
}
$line += $value + "`t"
}
Write-Host $line
}
LIMIT keyword in the query, e.g.:
SELECT * FROM Customers LIMIT 10
Using a full ODBC connection string
In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - ZoomRead and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.ZoomDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then just paste the connection string into your script:
- You are good to go! The script will execute the same way as using a DSN.
Have in mind that a full connection string has length limitations.
Proceed to the next step to find out the details.
Handling limitations of using a full connection string
Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:
"Connection string exceeds maximum allowed length of 1024"
But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:
- Open your ODBC data source.
- Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
- Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
- Continue by pasting the copied connection string into a newly created file and save it.
-
Finally, the last step! Just construct a shorter ODBC connection string using this format:
DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt - Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.
Write Zoom data to a file in PowerShell
Save data to a CSV file
Export data to a CSV file so that it can be sliced and diced in Excel:
# Configure connection string and query
$connectionString = "DSN=ZoomDSN"
$query = "SELECT * FROM Customers"
# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable
# Fill the table with data
$adapter.Fill($table)
# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force
Save data to a JSON file
Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force
Save data to an HTML file
Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):
# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force
ConvertTo-Csv, ConvertTo-Json, and ConvertTo-Html for other data manipulation scenarios.
Optional: Centralized data access via ZappySys Data Gateway
In some situations, you may need to provide Zoom data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.
This configuration provides two primary advantages:
-
Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
-
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.
| Data Gateway |
Local ODBC
data source
|
|
|---|---|---|
| Simple configuration | ||
| Installation | Single machine | Per machine |
| Connectivity | Local and remote | Local only |
| Connections limit | Limited by License | Unlimited |
| Central data access | ||
| Central access control | ||
| More flexible cost |
To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in PowerShell (client-side) to connect to it.
Let's not wait and get going!
Create Zoom data source in the gateway
In this section we will create a data source for Zoom in the Data Gateway. Let's follow these steps to accomplish that:
-
Search for
gatewayin the Windows Start Menu and open ZappySys Data Gateway Configuration:
-
Go to the Users tab and follow these steps to add a Data Gateway user:
- Click the Add button
-
In the Login field enter a username, e.g.,
john - Then enter a Password
- Check the Is Administrator checkbox
- Click OK to save
-
Now we are ready to add a data source:
- Click the Add button
- Give the Data source a name (have it handy for later)
- Then select Native - ZappySys API Driver
- Finally, click OK
ZoomDSNZappySys API Driver
-
When the ZappySys API Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the Zoom ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:
-
Open ODBC data source configuration and click Copy settings:
ZappySys API Driver - ZoomRead and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.ZoomDSN
-
The window opens, telling us the connection string was successfully copied to the clipboard:
-
Then go to Data Gateway configuration and in data source configuration window click Load settings:
ZoomDSNZappySys API Driver - Configuration [Version: 2.0.1.10418]ZappySys API Driver - ZoomRead and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.ZoomDSN
-
Once a window opens, just paste the settings by pressing
CTRL+Vor by clicking right mouse button and then Paste option.
-
Open ODBC data source configuration and click Copy settings:
-
Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:
- This will initially allow all inbound traffic.
- Click Edit IP filters to restrict access to specific IP addresses or ranges.
-
Crucial Step: After creating or modifying the data source, you must:
- Click the Save button to persist your changes.
- Hit Yes when prompted to restart the Data Gateway service.
This ensures all changes are properly applied:
Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.
Create ODBC data source to connect to the gateway
In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from PowerShell. To achieve that, let's perform these steps:
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:
ODBC Driver 17 for SQL Server
If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version. -
Then set a Name for the data source (e.g.
Gateway) and the address of the Data Gateway:ZappySysGatewayDSNlocalhost,5000
Make sure you separate the hostname and port with a comma, e.g.localhost,5000. -
Proceed with the authentication part:
- Select SQL Server authentication
-
In the Login ID field enter the user name you created in the Data Gateway, e.g.,
john - Set Password to the one you configured in the Data Gateway
-
Then set the default database property to
ZoomDSN(the one we used in the Data Gateway):ZoomDSNZoomDSN
Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step). -
Continue by checking the Trust server certificate option:
-
Once you do that, test the connection:
-
If the connection is successful, everything is good:
-
Done!
We are ready to move to the final step. Let's do it!
Access data in PowerShell via the gateway
Finally, we are ready to read data from Zoom in PowerShell via the Data Gateway. Follow these final steps:
-
Go back to PowerShell.
-
Use this code snippet to read the data using
ZappySysGatewayDSNdata source:"DSN=ZappySysGatewayDSN"
For your convenience, here is the whole PowerShell script:
# Configure connection string and query $connectionString = "DSN=ZappySysGatewayDSN" $query = "SELECT * FROM Customers" # Instantiate OdbcDataAdapter and DataTable $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString) $table = New-Object System.Data.DataTable # Fill the table with data $adapter.Fill($table) # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab $format = "{0}`t{1}`t{2}`t{3}" # Display data in the console foreach ($row in $table.Rows) { # Construct line based on the format and individual Zoom fields $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"]) Write-Host $line }Access specific Zoom table field using this code snippet:
You will find more info on how to manipulate$field = $row["ColumnName"]DataTable.Rowsproperty in Microsoft .NET reference.For demonstration purposes we are using sample tables which may not be available in Zoom. -
Read the data the same way we discussed at the beginning of this article.
-
That's it!
Now you can connect to Zoom data in PowerShell via the Data Gateway.
john and your password.
Supported Zoom Connector actions
Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Zoom operations directly in PowerShell, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:
- GET Current User (Me)
- Get Meeting By Id
- GET Settings
- Get Webinar Settings
- Get Webinar Settings By Id
- List Meeting Registrants
- List Meetings
- List Meetings (All Users)
- List Past Meetings (All Users)
- List Registration Questions
- List Users
- List Webinar Registrants
- List Webinars
- Past Meeting
- Make Generic REST API Request
- Make Generic REST API Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Zoom in PowerShell and integrate data without writing complex code — all of this was powered by Zoom ODBC Driver.
Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):