Skip to main content

Airtable Component

Manage items (records) in an Airtable Base

Component key: airtable

Description#

Airtable is a spreadsheet-database hybrid, with the features of a database but applied to a spreadsheet.

This component allows you to list, create, delete, and update records in an Airtable Base.

Information about Airtable can be found on their documentation site.

Authorization Notes#

The Airtable component uses API key authentication. You can obtain an API key by following the Airtable Support Guide.

Actions#

Create Record#

Create a record in an Airtable Base | key: createRecord

InputKeyNotesExample

Base

string
/ Required
baseIdAn Airtable base contains all of the information you need for a particular project or collection.tblUNWexampleY49YH

Record Fields

string
/ Required
recordFieldsA record is the base equivalent of a row in a spreadsheet.

Table Name

string
/ Required
tableNameProvide the name of the table you would like to access.myExampleTable

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

Output Example Payload#

{  "data": [    {      "id": "ExampleRecordId",      "fields": {        "RecordKey": "RecordValue"      },      "createdTime": "2021-08-06T05:00:00.000Z"    }  ]}

Delete Records#

List records inside an Airtable Base | key: deleteRecord

InputKeyNotesExample

Base

string
/ Required
baseIdAn Airtable base contains all of the information you need for a particular project or collection.tblUNWexampleY49YH

Record Ids

string
/ Required
recordsIn each field, place a key value pair (JavaScript Object) that resembles a table record.

Table Name

string
/ Required
tableNameProvide the name of the table you would like to access.myExampleTable

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

Output Example Payload#

{  "data": [    0  ]}

Get Record#

Retrieve a record by id from an Airtable Base | key: getRecord

InputKeyNotesExample

Base

string
/ Required
baseIdAn Airtable base contains all of the information you need for a particular project or collection.tblUNWexampleY49YH

Record Id

string
/ Required
recordWithin Airtable, each record has a unique identifier known as a Record ID. If you are familiar with Entity-Relationship Diagrams or ERDs, then the record id would be the primary key.rec6r4kNmGDk5D52F

Table Name

string
/ Required
tableNameProvide the name of the table you would like to access.myExampleTable

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

Output Example Payload#

{  "data": {    "id": "ExampleRecordId",    "fields": {      "RecordKey": "RecordValue"    },    "createdTime": "2021-08-06T05:00:00.000Z"  }}

List Records#

List records inside an Airtable Base | key: listRecords

InputKeyNotesExample

Base

string
/ Required
baseIdAn Airtable base contains all of the information you need for a particular project or collection.tblUNWexampleY49YH

Max Records

data
maxRecordsProvide a number of elements you would like to be returned.6

Table Name

string
/ Required
tableNameProvide the name of the table you would like to access.myExampleTable

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

Output Example Payload#

{  "data": [    {      "id": "ExampleRecordId",      "fields": {        "RecordKey": "RecordValue"      },      "createdTime": "2021-08-08T05:00:00.000Z"    }  ]}

Update Record#

Update a record's content inside an Airtable Base | key: updateRecord

InputKeyNotesExample

Base

string
/ Required
baseIdAn Airtable base contains all of the information you need for a particular project or collection.tblUNWexampleY49YH

Record Id

string
/ Required
recordWithin Airtable, each record has a unique identifier known as a Record ID. If you are familiar with Entity-Relationship Diagrams or ERDs, then the record id would be the primary key.rec6r4kNmGDk5D52F

Record Fields

string
/ Required
recordFieldsA record is the base equivalent of a row in a spreadsheet.

Table Name

string
/ Required
tableNameProvide the name of the table you would like to access.myExampleTable

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
API Keyapi_keyAPI authorization based on an API key

API Key |  api_key

Output Example Payload#

{  "data": [    {      "id": "ExampleRecordId",      "fields": {        "RecordKey": "RecordValue"      },      "createdTime": "2001-08-06T05:00:00.000Z"    }  ]}