Configure a Connection Profile

From the CData ribbon, click Get Data and select From Airtable connection/s to launch the CData Query window. To setup a new connection, you will have to click the New Airtable Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to Airtable

The add-in requests tables and views from Airtable. There is one optional connection property available: Schema.

The Schema property limits the shown tables and views to a particular base. If limitation is desired, set this property to the name of the schema that you want to use. (This corresponds to the name of the Base in Airtable.)

In addition to all Airtable Bases, a static schema named Information is also available. This schema enables the querying of static tables such as Bases, Tables, and Users. If DisplayObjectIds is set to True, you must set the value of Schema to the Airtable Base id, not the name.

Authenticating to Airtable

You can authenticate to Airtable using either a Personal Access Token or OAuth PKCE.

Personal Access Token

First, generate a personal access token, if you have not done so already:

1. Log in to your user account.
2. Navigate to the token creation page.
3. Click Create new token.
4. Under Scopes, click Add a scope to add each of the following:
   • data.records:read
   • data.records:write
   • schema.bases:read
5. Under Access, add all the workspaces and bases that you want the token to have access to.
6. Click Create token to generate the token. Copy and save the generated token, as it will only be shown once.

Next, set the following:

• AuthScheme: PersonalAccessToken.
• Token: The value of the personal access token that you generated earlier.

OAuth PKCE

Set AuthScheme to OAuthPKCE.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId (custom applications only): The client Id assigned when you registered your application.
• OAuthClientSecret (custom applications only): The client secret assigned when you registered your application. Specifying this value is optional if a value was not generated during the OAuth custom application creation process.
• CallbackURL (custom application only): The redirect URI defined when you registered your application. For example: http://localhost:3333

When you connect, the add-in opens Airtable's OAuth endpoint in your default browser. Log in and grant permissions to the application. The add-in refreshes the access token automatically when it expires.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Airtable you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

• Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
• Using the Excel Add-In: Find other ways to interact with Airtable data, such as using the available CData Excel Functions.