Zoom Connector for Alteryx : List meetings via SQL

Integrate Alteryx and Zoom
Integrate Alteryx and Zoom

Learn how to list meetings using the Zoom Connector for Alteryx. This connector enables you to read and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required. We'll walk you through the exact setup.

Let's dive in!

Create data source using Zoom ODBC Driver

  1. Download and install ODBC PowerPack (if you haven't already).

  2. Search for odbc and open the ODBC Data Sources (64-bit):

    Open ODBC Data Source
  3. Create a User data source (User DSN) based on the ZappySys API Driver driver:

    ZappySys API Driver
    Create new User DSN for 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
  4. 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:

    ZoomDSN
    Zoom
    ODBC DSN Template Selection
  5. 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):

    1. Go to the Zoom App Marketplace and sign in with your Zoom account.
    2. From the top navigation bar, open the Develop dropdown and select Build App.
    3. In the What kind of app are you creating window, select General App, click the Create button.
    4. Enter a name for your app and select the app type.
      (E.g. Zoom-General App)
    5. Click Create to continue.
    6. In the Redirect URL for OAuth field, enter the following URI and add it to the allow list:
      https://zappysys.com/oauth/
    7. Copy your Client ID and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
    8. 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
      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
      Master-Level
      • 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
    9. That’s it! After adding the scopes, click Continue to complete the process.
    10. 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.
    11. You’re done!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to User Credentials (Access Your Data) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    ZoomDSN
    Zoom
    User Credentials (Access Your Data) [OAuth]
    https://api.zoom.us/v2
    Required 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
    ODBC DSN OAuth Connection Configuration
    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):

    1. Go to the Zoom App Marketplace and sign in with your Zoom account.
    2. From the top navigation bar, open the Develop dropdown and select Build App.
    3. In the What kind of app are you creating window, select Server to Server OAuth App, click the Create button.
    4. Enter a name for your app and select the app type.
      (E.g. Basic OAuth App)
    5. Click Create to continue.
    6. Copy your Account ID, Client ID, and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
    7. In the Information window, enter the company name, developer name, and email address, then click Continue.
    8. 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
      Master-Level
      • 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
    9. That’s it! After adding the scopes, click Continue to complete the process.
    10. In the ZappySys API Component/Driver UI, enter your Zoom app Account ID, Client ID, and Client Secret, then click Test Connection.
    11. You’re done!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to App Credentials (Access Account Level Data) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    ZoomDSN
    Zoom
    App Credentials (Access Account Level Data) [OAuth]
    https://api.zoom.us/v2
    Required 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
    ODBC DSN OAuth Connection Configuration
    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)

    1. Go to Zoom Marketplace Portal and sign in there.
    2. Once you successfully login then select "Build App" option from Develop dropdown from top left on the page.
    3. Click on Create button of OAuth panel section of page.
    4. Enter the name for your application and choose app type (Recommneded "Account-Level App") option for your API
    5. Then proceed with clicking Create button.
    6. In Redirect URL for OAuth enter this https://zappysys.com/oauth/ as Redirect URI and add it to allow lists.
    7. Copy Client ID and Client Secret here and paste it into Connection Manager Required Paramters section in respective place holders
    8. 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 :admin suffix 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
    9. Click Generate Token button on Connection Manager UI to generate tokens.
    10. That's it!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to User Credentials (Access Your Data) - With Legacy Scopes [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    ZoomDSN
    Zoom
    User Credentials (Access Your Data) - With Legacy Scopes [OAuth]
    https://api.zoom.us/v2
    Required 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
    ODBC DSN OAuth Connection Configuration

  6. Then go to Preview tab to start building a SQL query.

  7. Once you do that, proceed by opening Query Builder:

    ZappySys API Driver - Zoom
    Read and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.
    ZoomDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API
  8. Then simply select the List Meetings endpoint (action).

  9. Continue by configuring the Required parameters. You can also set optional parameters too.

  10. Move on by hitting Preview Data button to preview the results.

  11. If you see the results you need, simply copy the generated query:

    List Meetings
    Optional Parameters
    Meeting Type scheduled
    UserId me
    PageSize 300
    Advanced Properties
    NextUrlAttributeOrExpr $.next_page_token
    NextUrlSuffix next_page_token=<%nextlink%>
    SELECT * FROM Meetings 
    WITH(
      UserId ='me' -- enter user id or email
    )
    Query Builder
  12. Click OK to use built SQL query and close the Query Builder.

  13. 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 Alteryx:

    ZappySys API Driver - Zoom
    Read and write Zoom data effortlessly. Integrate, manage, and automate meetings, users, accounts, and invitations — almost no coding required.
    ZoomDSN
    SELECT * FROM Meetings 
    WITH(
      UserId ='me' -- enter user id or email
    )
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole 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).

Let's not stop here and explore SQL query examples, including how to use them in Stored Procedures and Views (virtual tables) in the next steps.

Zoom SQL query examples

Use these SQL queries in your Alteryx data source:

Read meetings

Reads scheduled meetings for a specific user. This list includes meeting topics, start times, and join URLs. Use UserId='me' for the current user or provide a specific user email/ID.

The Meetings table is the primary way to access meeting schedules and details.

SELECT * FROM Meetings 
WITH(
  UserId ='me' -- enter user id or email
)

list_meetings endpoint belongs to Meetings table(s), and can therefore be used via those table(s).

Create SQL view in ODBC data source

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table
  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"
    ZappySys Driver - Execute Custom Virtual Table Query

List meetings in Alteryx via SQL view

  1. Open Alteryx Designer.

  2. First, verify your DCM Settings to ensure you can access ODBC drivers. Go to Options > User Settings > Edit User Settings.

    If DCM Mode is set to DCM Only, change it to DCM Optional if you would like to access the legacy Generic ODBC Connection.

    Alteryx DCM User Settings for ODBC access
    After changing this setting, you may need to click Save and restart the connection window for the "Generic ODBC" icon to appear.
  3. Drag an Input Data tool onto your Alteryx canvas.

    Drag Input Data tool onto Alteryx canvas
  4. In the Configuration pane, click Set Up a Connection.

    Set Up a Connection in Alteryx Input Data configuration
  5. Note for DCM Users: If your environment has DCM (Data Connection Manager) enabled, the classic "Generic ODBC" icon may be hidden. To find it, select Data sources on the left and type "ODBC" in the search bar.

  6. Once the ODBC window opens, click Connect Asset and select your ZoomDSN DSN from the list.

    Connect Asset and select ODBC DSN in Alteryx
    Ensure you have configured a 64-bit System DSN in the Windows ODBC Data Source Administrator before this step.
  7. After selecting your DSN, configure your SQL Query in the Input Data tool configuration:

    Configure SQL Query in Alteryx Input Data tool
  8. To save your data, drag an Output Data tool and connect it to the Input Data tool.

  9. Configure the Output Data tool to write to a CSV file:

    Configure Output Data to CSV in Alteryx
  10. Press Run (Ctrl+R) to execute the workflow. Verify the results in the Results Window at the bottom.

    Run Alteryx workflow and view results

Advanced topics

Creating SQL stored procedures

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver. Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    
    ZappySys Driver - Create Custom Stored Procedure
  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';
    ZappySys Driver - Execute Custom Stored Procedure

Conclusion

And there you have it — a complete guide on how to list meetings in Alteryx without writing complex code. All of this was powered by Zoom ODBC Driver, which handled the REST API pagination and authentication for us automatically.

Download the trial 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):

More actions supported by Zoom Connector

Got another use case in mind? We've documented the exact setups for a variety of essential Zoom operations directly in Alteryx, so you can skip the trial and error. Find your next step-by-step guide below:

More Zoom integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications