Skip to main content

Airtable

This page contains the setup guide and reference information for the Airtable source connector.

Prerequisites

  • An active Airtable account
  • Personal Access Token with the following scopes:
    • data.records:read
    • data.recordComments:read
    • schema.bases:read

Setup guide

Step 1: Set up Airtable

For Airbyte Open Source:

  1. Go to https://airtable.com/create/tokens to create new token. Generate new Token

  2. Add following scopes:

    • data.records:read
    • data.recordComments:read
    • schema.bases:read

    Add Scopes

  3. Select required bases or allow access to all available and press the Create Token button. Add Bases

  4. Save token from the popup window.

Step 2: Set up Airtable connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.

  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.

  3. On the Set up the source page, enter the name for the Airtable connector and select Airtable from the Source type dropdown.

  4. You can use OAuth or a Personal Access Token to authenticate your Airtable account. We recommend using OAuth for Airbyte Cloud.

    • To authenticate using OAuth, select OAuth2.0 from the Authentication dropdown click Authenticate your Airtable account to sign in with Airtable, select required workspaces you want to sync and authorize your account.
    • To authenticate using a Personal Access Token, select Personal Access Token from the Authentication dropdown and enter the Access Token for your Airtable account.
      info

      When using OAuth, you may see a 400 or 401 error causing a failed sync. You can re-authenticate your Airtable connector to solve the issue temporarily. We are working on a permanent fix that you can follow here.

  5. Click Set up source.

For Airbyte OSS:

  1. Navigate to the Airbyte Open Source dashboard
  2. In the left navigation bar, click Sources. In the top-right corner, click +new source.
  3. On the Set up the source page, enter the name for the Airtable connector and select Airtable from the Source type dropdown.
  4. Select Personal Access Token from the Authentication dropdown and enter the Access Token for your Airtable account.
  5. Click Set up source.

Note on changed table names and deleted tables

Please keep in mind that if you start syncing a table via Airbyte, then rename it in your Airtable account, the connector will not continue syncing that table until you reset your connection schema and select it again. At that point, the table will begin syncing to a table with the new name in the destination. This is because there is no way for Airtable to tell Airbyte which tables have been renamed. Similarly, if you delete a table that was previously syncing, the connector will stop syncing it.

Supported sync modes

The airtable source connector supports the following sync modes:

Supported Tables

This source allows you to pull all available tables and bases using Metadata API for a given authenticated user. In case you rename or add a column to any existing table, you will need to recreate the source to update the Airbyte catalog.

Performance Considerations

See information about rate limits here.

Data type map

Integration TypeAirbyte TypeNullable
multipleAttachmentsstringYes
autoNumberstringYes
barcodestringYes
buttonstringYes
checkboxbooleanYes
singleCollaboratorstringYes
countnumberYes
createdBystringYes
createdTimedatetime, format: date-timeYes
currencynumberYes
emailstringYes
datestring, format: dateYes
durationnumberYes
lastModifiedBystringYes
lastModifiedTimedatetime, format: date-timeYes
multipleRecordLinksarray with stringsYes
multilineTextstringYes
multipleCollaboratorsarray with stringsYes
multipleSelectsarray with stringsYes
numbernumberYes
percentnumberYes
phoneNumberstringYes
ratingnumberYes
richTextstringYes
singleLineTextstringYes
externalSyncSourcestringYes
urlstringYes
formulastring, number or array with anyYes
lookuparray with anyYes
multipleLookupValuesarray with anyYes
rolluparray with anyYes
  • All the fields are nullable by default, meaning that the field could be empty.
  • The array with any - represents the classic array with one of the other Airtable data types inside, such as:
    • string
    • number/integer
    • nested lists/objects

Reference

Config fields reference

Field
Type
Property name
object
credentials

Changelog

VersionDatePull RequestSubject
4.2.02024-03-1936267Pin airbyte-cdk version to ^0
4.1.62024-02-1235149Manage dependencies with Poetry.
4.1.52023-10-1931599Base image migration: remove Dockerfile and use the python-connector-base image
4.1.42023-10-1931360Update docstings
4.1.32023-10-1331360Update error message for invalid permissions
4.1.22023-10-1031215Exclude bases without permission
4.1.12023-10-1031119Add user-friendly error message when refresh token has expired
4.1.02023-10-1031044Add source table name to output records
4.0.02023-10-0931181Additional schema processing for the FORMULA schema type: Convert to simple data types
3.0.12023-05-1025946Skip stream if it does not appear in catalog
3.0.02023-03-2022704Fix for stream name uniqueness
2.0.42023-03-1524093Update spec and doc
2.0.32023-02-0222311Fix for singleSelect types when discovering the schema
2.0.22023-02-0122245Fix for empty result object when discovering the schema
2.0.12023-02-0122224Fixed broken API Key authentication
2.0.02023-01-2721962Added casting of native Airtable data types to JsonSchema types
1.0.22023-01-2520934Added OAuth2.0 authentication support
1.0.12023-01-1021215Fix field names
1.0.02022-12-2220846Migrated to Metadata API for dynamic schema generation
0.1.32022-10-2618491Improve schema discovery logic
0.1.22022-04-3012500Improve input configuration copy
0.1.12021-12-068425Update title, description fields in spec