Airtable integration (deprecated)

Legacy feature

You are viewing documentation about the legacy backend integrations feature for connecting to external data sources. See the migration guide for how to move to new data queries.

Airtable is a relational database that is accessible to many users due to its similarities to spreadsheets.

Setup

When adding an Airtable integration, you’ll need to grant Plasmic access to your Airtable base.

Data queries

Operation	Description	Result in `$steps`
Fetch row by ID	Fetches a row from a table given its ID.	`SingleRowResult`
Fetch rows by IDs	Fetches rows from a table given their IDs.	`ManyRowsResult`
Query for rows	Queries rows from a table. Results can be filtered, sorted, and paginated.	`ManyRowsResult`

Backend operations

Operation	Description	Result in `$steps`
Create row	Creates a row on a table.	`SingleRowResult`
Create rows	Creates rows on a table.	`ManyRowsResult`
Update row	Updates a row on a table given its ID.	`SingleRowResult`
Delete row	Deletes a row on a table given its ID.	`SingleRowResult`
Delete rows	Deletes rows on a table given their IDs.	`ManyRowsResult`

Result types

`SingleRowResult`

Copy

{
  "data": { "ID": 1, "Name": "User 1" },
  "schema": {
    "id": "Users",
    "fields": [
      { "id": "ID", "type": "number", "readOnly": false },
      { "id": "Name", "type": "string", "readOnly": false }
    ]
  }
}

For users familiar with TypeScript, you can view the most up-to-date schema here.

`ManyRowsResult`

Copy

{
  "data": [
    { "ID": 1, "Name": "User 1" },
    { "ID": 2, "Name": "User 2" }
  ],
  "schema": {
    "id": "Users",
    "fields": [
      { "id": "ID", "type": "number", "readOnly": false },
      { "id": "Name", "type": "string", "readOnly": false }
    ]
  },
  "paginate": {
    "pageSize": 20,
    "pageIndex": 0
  }
}

The paginate field is only set if the data query was paginated.

For users familiar with TypeScript, you can view the most up-to-date schema here.

Is this page helpful?

NoYes