How to connect to Zoom Data with Squirrel SQL client



Connect to Zoom data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Zoom enables you to execute queries to Zoom data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Zoom data and execute queries.

Add the JDBC Driver for Zoom

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Zoom.
  4. In the Example URL box, enter jdbc:api:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.api.APIDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Zoom Source.
    • Driver: Select the CData JDBC Driver for Zoom.
    • URL: Enter jdbc:api:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    Start by setting the Profile connection property to the location of the Zoom Profile on disk (e.g. C:\profiles\Zoom.apip). Next, set the ProfileSettings connection property to the connection string for Zoom (see below).

    Zoom API Profile Settings

    To authenticate to Zoom, you can use the OAuth standard to connect to your own data or to allow other users to connect to their data.

    First you will need to create an OAuth app. To do so, navigate to https://marketplace.zoom.us/develop/create and click Create under the OAuth section. Select whether or not the app will be for individual users or for the entire account, and uncheck the box to publish the app. Give the app a name and click Create. You will then be given your Client Secret and Client ID

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to OAuth.
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
    • OAuthClientID: Set this to the OAuth Client ID that is specified in your app settings.
    • OAuthClientSecret: Set this to the OAuth Client Secret that is specified in your app settings.
    • CallbackURL: Set this to the Redirect URI you specified in your app settings.

    Below is a typical connection string:

    jdbc:api:Profile=C:\profiles\Zoom.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=GETANDREFRESH
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Zoom Data

After the metadata has loaded, a new tab for the Zoom data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT Id, JobTitle FROM MeetingRegistrants WHERE State = 'NC'

Ready to get started?

Connect to live data from Zoom with the API Driver

Connect to Zoom