Airtable Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Airtable Version Support

The connector leverages the Airtable Web API to enable bidirectional access to Airtable tables and views.

Establish a Connection

Connect to Airtable

The connector 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.

Authenticate 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

An embedded OAuth application is provided 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:

• InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
• 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 connector opens Airtable's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

1. The connector obtains an access token from Airtable and uses it to request data.
2. The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Create a Custom OAuth App

When To Create a Custom OAuth Application

A custom OAuth application embeds OAuth Application credentials with branding that can be used when connecting via a desktop application.

You may choose to use your own OAuth Application credentials when you want to:

• Control branding of the Authentication Dialog
• Control the redirect URI that the application redirects the user to after the user authenticates
• Customize the permissions that you are requesting from the user

Create an OAuth App

Perform the following steps to generate an OAuth app and its associated credentials:

1. Log in to your user account.
2. Navigate to the OAuth app creation page.
3. Click Register an OAuth integration.
4. Give the OAuth application a descriptive name.
5. Specify a callback URL, which can be any localhost URL (such as http://localhost:33333), in the OAuth redirect URL field.
6. Under Scopes, specify the following scopes:
   • data.records:read
   • data.records:write
   • schema.bases:read
7. Under Developer details, you can optionally specify a Client secret. While not required, generating a client secret can enhance security.
8. Copy and save the Client ID and, if generated, the Client secret from the Developer details section. You will use these later in the OAuthClientId and OAuthClientSecret connection properties.
9. Click Save changes.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Airtable connector.

User Defined Views

The connector supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats. For further information, see the SSLServerCert property under "Connection String Options".

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector offloads as much of the SELECT statement processing as possible to Airtable and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Log

For an overview of configuration settings that can be used to refine logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

User Defined Views

The Airtable connector supports the use of user defined views: user-defined virtual tables whose contents are decided by a preconfigured query. User defined views are useful in situations where you cannot directly control the query being issued to the driver; for example, when using the driver from Jitterbit.

Use a user defined view to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User defined views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This user defined view configuration file is formatted so that each root element defines the name of a view, and includes a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

In order to avoid a view's name clashing with an actual entity in the data model, user defined views are exposed in the UserViews schema by default. To change the name of the schema used for UserViews, reset the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a user defined view called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a user defined view that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Data Model

The Airtable connector models Airtable bases as easy-to-use SQL databases with tables, views, and stored procedures. Live connectivity to these objects means any changes to your Airtable account are immediately reflected when using the connector.

The Information schema Views section, which lists read-only SQL tables, contains samples of what you might have access to in your Airtable account.

The views included with the connector Information schema are:

The connector exposes each Airtable base as a separate schema. SampleBase is an example of a base schema.

Information

The Information schema contains views related to Airtable users, bases, groups, collaborators, and tables. The stored procedures allow you to download attachments and manage OAuth access.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Airtable Connector Views

Bases

Retrieves a list of all bases the authenticated user has access to in Airtable, including their identifiers, names, and associated permissions.

View-Specific Information

SELECT Examples

SELECT * FROM [Information].[Bases]

Columns

GroupCollaborators

Retrieves a list of collaborators in a specific Airtable group, including their identifiers, display names, permission levels, and whether base access is granted directly or inherited from workspace permissions.

View-Specific Information

-- Retrieve all group collaborators
SELECT * FROM [Information].[GroupCollaborators];

-- Filter collaborators by base ID
SELECT * FROM [Information].[GroupCollaborators]

WHERE BaseId = 'appWJ6DP3C7Guh9fS';

Columns

GroupMembers

Retrieves a list of members belonging to a specific Airtable user group, including their unique identifiers and associated group information.

View-Specific Information

-- Retrieve all group members
SELECT * FROM [Information].[GroupMembers];

-- Retrieve member IDs by group

SELECT GroupId, ID FROM [Information].[GroupMembers];

Columns

Groups

Retrieves a list of user groups within an Airtable workspace, including their unique identifiers and display names.

View-Specific Information

-- Retrieve all groups
SELECT * FROM [Information].[Groups];

-- Retrieve group IDs and names

SELECT Id, DisplayName FROM [Information].[Groups];

Columns

IndividualCollaborators

Retrieves a list of individual collaborators for Airtable bases and workspaces, including their identifiers, contact details, permission levels, and whether base access is granted directly or inherited from workspace permissions.

View-Specific Information

-- Retrieve all individual collaborators
SELECT * FROM [Information].[IndividualCollaborators];

-- Filter collaborators by base ID
SELECT * FROM [Information].[IndividualCollaborators]

WHERE BaseId = 'appWJ6DP3C7Guh9fS';

Columns

Tables

Retrieves a list of tables available in Airtable bases, including their identifiers, names, descriptions, primary fields, associated fields, and related views.

View-Specific Information

SELECT Examples

SELECT * FROM [Information].[Tables]

SELECT * FROM [Information].[Tables] WHERE BaseId = 'appWJ6DP3C7Guh9fS'

Columns

Users

Retrieves a list of Airtable users, including their identifiers, status, names, creation dates, and associated groups.

View-Specific Information

-- Retrieve all users
SELECT * FROM [Information].[Users]

-- Retrieve user emails and roles

SELECT Id, Email, Role FROM [Information].[Users];

Columns

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Airtable.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Airtable, along with an indication of whether the procedure succeeded or failed.

Airtable Connector Stored Procedures

DownloadAttachment

Downloads an attachment from a table by providing the table name or ID (depending on the DisplayObjectIds connection property) and attachment ID.

Input

Result Set Columns

GetOAuthAccessToken

Retrieve the OAuth access token to be used for authentication with Airtable using OAuth.

Input

Result Set Columns

GetOAuthAuthorizationURL

Generate the OAuth authorization URL used for authentication with Airtable using OAuth.

Input

Result Set Columns

RefreshOAuthAccessToken

Exchanges a refresh token for a new access token.

Input

Result Set Columns

SampleBase

Airtable exposes each base as a separate schema, where the schema corresponds to the structure of that individual base. Within a schema, each table in the base appears as its own entity, with fields represented as columns that preserve their data types. This is a sample base schema.

Tables

The connector models the data in Airtable as a list of tables in a relational database that can be queried using standard SQL statements.

Airtable Connector Tables

SampleTable

Provides a randomly selected sample table from a random Airtable base, containing a range of field types to demonstrate different column configurations and data formats.

Columns

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Airtable Connector Views

SampleTable_Attachments

A child view of the SampleTable table, automatically generated to display the contents of attachment-type fields. This view provides detailed metadata for each file attached to records in SampleTable, including file properties and thumbnail information.

Columns

SampleTable_Collaborators

A child view of the SampleTable table, automatically generated to display the contents of collaborator-type fields. This view provides detailed information about each collaborator assigned to records in SampleTable, including their names and email addresses.

Columns

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Airtable.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Airtable, along with an indication of whether the procedure succeeded or failed.

Airtable Connector Stored Procedures

CreateSchema

Creates a schema file for a specified Airtable table or view, allowing its structure and metadata to be saved for use in integrations or development workflows.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The connector checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the connector.

Input

Result Set Columns

DownloadAttachment

Download an attachment from a table by providing the table name or ID (depending on the DisplayObjectIds connection property) and attachment ID.

Input

Result Set Columns

GetOAuthAccessToken

Retrieve the OAuth access token to be used for authentication with Airtable using OAuth.

Input

Result Set Columns

GetOAuthAuthorizationURL

Generate the OAuth authorization URL used for authentication with Airtable using OAuth.

Input

Result Set Columns

RefreshOAuthAccessToken

Exchanges a refresh token for a new access token.

Input

Result Set Columns

SyncCSV

Synchronizes raw CSV data into a designated Sync API table in Airtable, allowing bulk data import through a specified file path, input stream, or Base64-encoded content.

Input

Result Set Columns

UploadAttachment

Uploads a file to an attachment field in Airtable by specifying the target record’s identifier and the attachment field’s name or unique identifier. The file can be provided from a local path, an input stream, or as Base64-encoded data.

Input

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Airtable:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the SampleTable_1 table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='SampleTable_1'

Columns

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateSchema stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CreateSchema' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'CreateSchema' AND IncludeResultColumns='True'

Columns

Pseudo-Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the SampleTable_1 table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='SampleTable_1'

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

OAuth

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

Specifies the type of authentication to use when connecting to Airtable.

Possible Values

PersonalAccessToken, OAuthPKCE

Data Type

string

Default Value

OAuthPKCE

Remarks

Airtable provides two authentication mechanisms to access its API:

• OAuthPKCE is intended for clients who cannot securely store a client's secret. It enables OAuth 2.0 authentication with Airtable using the Proof Key for Code Exchange (PKCE) flow. When this property is set to OAuthPKCE, DisplayValue is required.
• PersonalAccessToken uses the Token obtained from Airtable to ensure secure access to Airtable's API.

Token

The Personal Access Token for authenticating to Airtable. This token can be generated through the Airtable user interface.

Data Type

string

Default Value

""

Remarks

The PAT can be generated from https://airtable.com/create/tokens.

OAuth

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

OFF

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for logging in users, exchanging their credentials for an OAuth access token to be used for authentication, and providing limited access to applications.

Airtable supports the following options for initiating OAuth access:

1. OFF: No automatic OAuth flow initiation. The OAuth flow is handled entirely by the user, who will take action to obtain their OAuthAccessToken. Note that with this setting the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.
2. GETANDREFRESH: The OAuth flow is handled entirely by the connector. If a token already exists, it is refreshed when necessary. If no token currently exists, it will be obtained by prompting the user to login.
3. REFRESH: The user handles obtaining the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate. After the user logs in, the connector handles the refresh of the OAuth Access Token.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration. It is also required if an embedded OAuth application is not available for the driver. When an embedded OAuth application is available, this value may already be provided by the connector and not require manual entry.

This value is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can typically find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication will fail, and the server may return an invalid_client or unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application. It may be referred to as the client secret, application secret, or consumer secret.

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments. Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

Data Type

string

Default Value

%APPDATA%\Airtable Data Provider\OAuthSettings.txt

Remarks

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

• Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
• Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\Airtable Data Provider\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory.

Default values vary, depending on the user's operating system.

• Windows (ODBC and Power BI): registry://%DSN%
• Windows: %APPDATA%Airtable Data Provider\OAuthSettings.txt
• Mac: %APPDATA%//Airtable Data Provider/OAuthSettings.txt
• Linux: %APPDATA%//Airtable Data Provider/OAuthSettings.txt

Loading Credentials Via Memory Storage

Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.

Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

• **memory://**: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
• **registry://**: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://Airtable` connector Data Source`, orregistry://%DSN%``.
• %DSN%: The name of the DSN you are connecting with.
• Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

CallbackURL

Identifies the URL users return to after authenticating to Airtable via OAuth. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you Configured the custom OAuth application.

Scope

Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.

Data Type

string

Default Value

""

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested. When InitiateOAuth is set to either REFRESH or OFF, you can use either this property or the Scope input to change which scopes are requested.

OAuthVerifier

Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.

Data Type

string

Default Value

""

PKCEVerifier

The PKCE code verifier generated from executing the GetOAuthAuthorizationUrl stored procedure for PKCE authentication schemes.

Data Type

string

Default Value

""

Remarks

The Proof Key for Code Exchange code verifier generated from executing the GetOAuthAuthorizationUrl stored procedure for PKCE authentication schemes. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the PKCEVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier and PKCEVerifier. When you connect, the connector exchanges the OAuthVerifier and PKCEVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier and PKCEVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

Specifies the OAuth refresh token used to request a new access token after the original has expired.

Data Type

string

Default Value

""

Remarks

The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.

The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessToken stored procedure if you prefer to manage the refresh manually.

When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.

The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, use OAuthTokenTimestamp.

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Data Type

string

Default Value

%APPDATA%\Airtable Data Provider\Schema

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\Airtable Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Schema

Restricts access to data within the specified schema.

Data Type

string

Default Value

""

Remarks

By default, the connector exposes all Airtable Bases as separate schemas. To restrict access to a specific schema, set this property to the desired schema name. This limits access to only that schema's objects, such as tables, views, and procedures.
In addition to all Airtable Bases, a static schema named Information is available. This schema allows querying static tables such as Bases, Tables, Users and more.
When DisplayObjectIds is set to TRUE, the value of Schema must be set to the Airtable Base id, not the name.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

ArrayOutputFormat

An optional override for the column value output format of elements that are arrays of primitive values.

Possible Values

AGGREGATE, DELIMITED

Data Type

string

Default Value

AGGREGATE

Remarks

The ArrayOutputFormat property determines how the column values of elements that are arrays of primitive values are displayed in the output.
If set to AGGREGATE, the output will show a single, combined value representing the entire array. If set to DELIMITED, the values will be formatted as a string, with individual elements separated by commas or semicolons.

DisplayObjectIds

A boolean value that determines whether the names of schemas, tables, views, and columns are substituted with their respective internal IDs.

Data Type

bool

Default Value

false

Remarks

By default, the API response returns field objects with their field names as keys.
When DisplayObjectIds is set to TRUE, the API responds with field objects identified by their unique field IDs.

This property is useful for retrieving the unique identifiers that Airtable assigns to tables, fields, and views. This ensures reliable API integrations, schema mapping, and automation.

DisplayValue

Determines how the field values are returned by the Airtable API.

Possible Values

FormattedValue, DisplayText

Data Type

string

Default Value

FormattedValue

Remarks

By default, the DisplayValue property returns values based on their data types.
When the value is set to DisplayText, values are returned as plain text strings displayed in the UI. This is useful for rendering formatted output. All columns that support value formatting will be pushed with data type STRING.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

Pagesize

The maximum number of records per page the provider returns when requesting data from Airtable.

Data Type

int

Default Value

100

Remarks

When processing a query, instead of requesting all of the queried data at once from Airtable, the connector can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the connector requests per page.

Note that setting large page sizes may improve overall query execution time, but doing so causes the connector to use more memory when executing queries and risks triggering a timeout.

PathDelimiter

Determines the character used as a delimiter for building column names based on paths.

Data Type

string

Default Value

.

Remarks

If your column names contain the '.' character, choose a different character not present in any column names. This is important because using the same character can cause problems with INSERT and UPDATE statements.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
    "MyView": {
        "query": "SELECT * FROM SampleTable_1 WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }

}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.

UseSimpleNames

Specifies whether or not simple names should be used for tables and columns.

Data Type

bool

Default Value

false

Remarks

Airtable tables and can use special characters in names that are normally not allowed in standard databases. UseSimpleNames makes the connector easier to use with traditional database tools.

Setting UseSimpleNames to True simplifies the names of columns returned. It also enforces a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed column names.

Notes:

• Any non-alphanumeric characters are converted to underscores.
• If the column or table names exceed 128 characters in length they are truncated to 128 characters to comply with SQL Server standards.

ValueDelimiter

Indicates what separator to use when pushing values of an array as a single string.

Data Type

string

Default Value

,

Remarks

The default format for array elements is a comma-separated string when ArrayOutputFormat is set to DELIMITED. Modifying ValueDelimiter changes the separator to any character of your choice, providing flexibility in the presentation of the array elements.