Skip to main content

Airtable

ToolJet can connect to your Airtable account to read and write data. Airtable API key is required to create an Airtable datasource on ToolJet. You can generate API key by visiting Airtable account page.

ToolJet - ToolJet - Datasource Airtable
info

Airtable API has a rate limit, and at the time of writing this documentation, the limit is five(5) requests per second per base. You can read more about rate limits here Airtable API.

tip

This guide assumes that you have already gone throgh Adding a datasource tutorial.

Supported queries:

  • Listing records
  • Retrieving a record
  • Updating a record
  • Deleting a record

Listing records#

This query lists all the records in a table. The results are paginated and each page can have upto 100 records.

Required parameters:

  • Base ID
  • Table name
ToolJet - Airtable Delete Operarion

Optional parameters:

  • Page size - The number of records returned in each request. Must be less than or equal to 100. Default is 100.
  • offset - If there are more records, the response will contain an offset. To fetch the next page of records, include offset in the next request's parameters.

Example response from Airtable:

{
"records": [
{
"id": "recu9xMnUdr2n2cw8",
"fields": {
"Notes": "sdfdsf",
"Name": "dsfdsf"
},
"createdTime": "2021-05-12T14:30:33.000Z"
},
{
"id": "recyIdR7bVdQvmKXa",
"fields": {
"Notes": "sdfdsf",
"Name": "dfds"
},
"createdTime": "2021-05-12T14:30:33.000Z"
},
{
"id": "recAOzdIHaRpvRaGE",
"fields": {
"Notes": "sdfsdfsd",
"Name": "sdfdsf"
},
"createdTime": "2021-05-12T14:30:33.000Z"
}
],
"offset": "recAOzdIHaRpvRaGE"
}

Retrieving a record#

Required parameters:

  • Base ID
  • Table name
  • Record ID
ToolJet - Datasource Airtable Retrieve Operation

Example response from Airtable:

{
"id": "recu9xMnUdr2n2cw8",
"fields": {
"Notes": "sdfdsf",
"Name": "dsfdsf"
},
"createdTime": "2021-05-12T14:30:33.000Z"
}

Updating a record#

Required parameters:

  • Base ID
  • Table name
  • Record ID
ToolJet - Datasource Airtable Update Operarion

Example body:#

ToolJet - Datasource Airtable Update Operarion Body

Click on the run button to run the query.

info

NOTE: Query must be saved before running.

Example response from Airtable:

{
"id": "recu9xMnUdr2n2cw8",
"fields": {
"Notes": "Example Notes",
"Name": "change"
},
"createdTime": "2021-08-08T17:27:17.000Z"
}

Deleting a record#

Required parameters:

  • Base ID
  • Table name
  • Record ID
ToolJet - Airtable Delete Operarion

Click on the run button to run the query.

info

NOTE: Query must be saved before running.

Example response from Airtable:

{
deleted: true
id: "recIKsyZgqI4zoqS7"
}