Airtable Connection
See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Airtable connector.
Airtable is a versatile cloud-based tool that integrates the functionality of spreadsheets and databases, making it ideal for a wide range of applications.
This topic describes how to authenticate to Airtable and configure any necessary connection properties in the Airtable connection connector.
Connection Configuration
Each connection property available in the Airtable connector is explained below.
Connection Name
The name of the connection to be created should be provided. This is the name that will display on the list of available connections.
Auth Scheme
The type of authentication to use when connecting to Airtable.
Possible Values
API Key
If API Key is selected, additional configuration parameter will get listed.
Api Key
ApiKey of the currently authenticated user.
Personal Access Token
Set this to use Personal Access Token authentication.
If Personal Access Token is selected, additional configuration parameters will get listed.
OAuth Access Token
The Personal Access Token for authentication.
OAuth PKCE
Set this to use OAuth PKCE authentication.
If OAuth PKCE is selected, additional configuration parameters will get listed.
Client ID
The client ID assigned when you register your application with an OAuth authorization server.
Client Secret
The client secret assigned when you register your application with an OAuth authorization server.
Refresh Token
The OAuth refresh token for the corresponding OAuth access token.
Base Id
Id of the base. This property is not required when the Metadata API is enabled, but specifying it restricts the metadata that will be retrieved.
Base Name
The schema to use - which corresponds to the name of the Base in Airtable.
This property is only used when the Metadata API is enabled with Auth Scheme as PersonalAccessToken or OAuthPKCE.
Table Names
Comma separated table names of the specified base. The tables can be viewed in either the Airtable UI or from https://airtable.com/api.
View Names
Comma separated view names of the views. These are the individual views under each table as displayed in the UI.
Enable Metadata API
Enabling the Metadata API gives you read-only access to a list of your bases, tables and fields, and changes the behavior of the connector for all operations and queries.
If enabled, the connector will reference Airtable tables, views and fields for all operations and queries by their unique ID.
Enabling the MetadataAPI requires the schema.bases:read scope for Personal Access Token and OAuth PKCE authentication.
Advanced Configuration
Use Simple Names
Setting to true will simplify the names of tables and columns returned. It will enforce a naming scheme such that only alphanumeric characters and the underscore are valid for the displayed table and column names. Any nonalphanumeric characters will be converted to an underscore.
After entering all the details, click on the TEST button.
If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.
Click on the CREATE button to save the changes.
If the details are incorrect or the server is down, you will get a message “Connection unavailable”.
If you have any feedback on Gathr documentation, please email us!