How to Query Workable Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Workable to query Workable data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Workable data in MySQL Workbench.

Connect to Workable Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Using API Key Authentication

Workable uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Workable account.
2. Navigate to Settings > Integrations > API Access Tokens.
3. Click "Generate API Token".
4. Copy the generated token.

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Workable API Key.
• Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

Example Connection String

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Workable data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Workable from MySQL Workbench

The steps below outline connecting to the virtual Workable database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Workable data.

Connect to Workable through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Workable).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Workable Data

1. Open the connection you just created (CData SQL Gateway for Workable).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Workable data, like SELECT * FROM `CData API Sys`.Accounts;

With access to live Workable data from MySQL Workbench, you can easily work with Workable, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.