Airtable Sync integration: Sync API

Click the + Add or import option next to the last table in the base. Then, click on the more sources... option at the bottom of that drop-down.

Next, you'll see a popover menu where you can either scroll to the Sync API feature or search it by clicking the Find a source option.

This will open up the Sync API configuration window. Once you are ready, click Set up to move to the next screen. If you haven't set up a personal access token with data.records:write and schema.bases:write scopes before, then you can click Create a token → to generate one. Otherwise, you can use a previously configured token in the cURL request. You'll want to click the COPY button and configure the API request before you can proceed with additional sync setup steps.

Note

You'll want to replace the ${PERSONAL ACCESS TOKEN} portion of the cURL request we provide with a PAT that is configured with the relevant scope described above. 

Once you've successfully sent the first API request to this endpoint the "Waiting to receive API request..." message will change to "✓ API request received" and you'll be able to click Next.

There are three main sections to complete before creating the synced table. The first section allows you to: 

1. Choose which fields from the example CSV you sent via API request to sync into Airtable. Choosing All fields will also allow additional columns in the CSV to be added in the future. Choosing Specific fields will only allow those fields to sync into Airtable in the future. 

2. You can drag the fields around to order them. 

3. Finally, clicking the drop-down in each field will allow you to choose the field type of each column from the CSV. 

There are 10 field types that we support in the field customization step:

In this section of the setup process, you'll choose a field that will act as the primary key for the table of data that you are generating. This provides Airtable with the logic to ensure that the correct records in Airtable are updated, created, or prevented from being duplicated. Common industry-standard examples for this include:

• Name fields that will always be unique

• Electronic Identifier Serial Publication codes (EISPs)

• Unique Product Identifiers (UPIs), Electronic Product Codes (EPCs), or Universal Product Codes (UPCs)

• International eBook Identifier Numbers (IEINs) or International Standard Book Numbers (ISBNs)

• Stock keeping units (SKUs)

• Bates numbering or European Case Law Identifiers (ECLIs)

Not every case will match the examples above, so use your best judgment to choose the unique identifier for your situation. Click the Select an option drop-down menu and choose a field that will uniquely identify records.

Once you are satisfied with the sync setup, click the Create table button. Depending upon the size of the initial CSV sent to Airtable, this may take a moment.

Once the table has been created, it's a good idea to look through the table and make sure everything looks correct. If you do need to make any changes now or in the future, then click the drop-down menu next to the name of your synced table and then choose the Update sync configuration option.

No, this integration will not work with API keys. Airtable has introduced personal access tokens that are used instead.

• The CSV data can contain up to 10k rows, 500 columns, and the HTTP request's size is limited to 2 MB.

• There is a rate limit of 1 request, per 10 minutes, per base for this endpoint.

Yes, you can find that here.

Not directly. The Sync API integration supports the following field types:

Single line text, Email, Long text field, Number, Date, Duration, Phone number, Currency, URL, and Percent.

Right now, likely the best workaround is to sync publicly accessible image URLs to a single text field and then configure an automation to append attachment URLs to an additional attachment field. There is a community thread where you can find more information about this workaround here.