Airtable is a powerful cloud-based platform that combines the functionality of a database with the simplicity of a spreadsheet. It allows users to create flexible databases for organizing, storing, and collaborating on information.
With Airtable, you can:
- Create custom databases: Build tailored solutions for project management, content calendars, inventory tracking, and more
- Visualize data: View your information as a grid, kanban board, calendar, or gallery
- Automate workflows: Set up triggers and actions to automate repetitive tasks
- Integrate with other tools: Connect with hundreds of other applications through native integrations and APIs
In Aptlystar, the Airtable integration enables your agents to interact with your Airtable bases programmatically. This allows for seamless data operations like retrieving information, creating new records, and updating existing data - all within your agent workflows. Use Airtable as a dynamic data source or destination for your agents, enabling them to access and manipulate structured information as part of their decision-making and task execution processes.
Integrates Airtable into the workflow. Can list bases, list tables (with schema), and create, get, list, update, upsert, or delete records. Can also be used in trigger mode to trigger a workflow when an update is made to an Airtable table.
List all bases the authenticated user has access to
| Parameter | Type | Required | Description |
|---|
offset | string | No | Pagination offset for retrieving additional bases |
| Parameter | Type | Description |
|---|
bases | array | Array of Airtable bases with id, name, and permissionLevel |
↳ id | string | Base ID (starts with "app") |
↳ name | string | Base name |
↳ permissionLevel | string | Permission level (none, read, comment, edit, create) |
metadata | json | Pagination and count metadata |
↳ offset | string | Offset for next page of results |
↳ totalBases | number | Number of bases returned |
List all tables and their schema in an Airtable base
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
| Parameter | Type | Description |
|---|
tables | array | List of tables in the base with their schema |
↳ id | string | Table ID (starts with "tbl") |
↳ name | string | Table name |
↳ description | string | Table description |
↳ primaryFieldId | string | ID of the primary field |
↳ fields | array | List of fields in the table |
↳ id | string | Field ID (starts with "fld") |
↳ name | string | Field name |
↳ type | string | Field type (singleLineText, multilineText, number, checkbox, singleSelect, multipleSelects, date, dateTime, attachment, linkedRecord, etc.) |
↳ description | string | Field description |
↳ options | json | Field-specific options (choices, etc.) |
metadata | json | Base info and count metadata |
↳ baseId | string | The base ID queried |
↳ totalTables | number | Number of tables in the base |
Read records from an Airtable table
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
tableId | string | Yes | Table ID (starts with "tbl") or table name |
maxRecords | number | No | Maximum number of records to return (default: all records) |
filterFormula | string | No | Formula to filter records (e.g., "({Field Name} = 'Value')") |
| Parameter | Type | Description |
|---|
records | array | Array of retrieved Airtable records |
↳ id | string | Record ID |
↳ createdTime | string | Record creation timestamp |
↳ fields | json | Record field values |
metadata | json | Operation metadata including pagination offset and total records count |
↳ offset | string | Pagination offset for next page |
↳ totalRecords | number | Number of records returned |
Retrieve a single record from an Airtable table by its ID
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
tableId | string | Yes | Table ID (starts with "tbl") or table name |
recordId | string | Yes | Record ID to retrieve (starts with "rec", e.g., "recXXXXXXXXXXXXXX") |
| Parameter | Type | Description |
|---|
record | json | Retrieved Airtable record |
↳ id | string | Record ID |
↳ createdTime | string | Record creation timestamp |
↳ fields | json | Record field values |
metadata | json | Operation metadata |
↳ recordCount | number | Number of records returned (always 1) |
Write new records to an Airtable table
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
tableId | string | Yes | Table ID (starts with "tbl") or table name |
records | json | Yes | Array of records to create, each with a fields object |
fields | string | No | No description |
| Parameter | Type | Description |
|---|
records | array | Array of created Airtable records |
↳ id | string | Record ID |
↳ createdTime | string | Record creation timestamp |
↳ fields | json | Record field values |
metadata | json | Operation metadata |
↳ recordCount | number | Number of records created |
Update an existing record in an Airtable table by ID
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
tableId | string | Yes | Table ID (starts with "tbl") or table name |
recordId | string | Yes | Record ID to update (starts with "rec", e.g., "recXXXXXXXXXXXXXX") |
fields | json | Yes | An object containing the field names and their new values |
| Parameter | Type | Description |
|---|
record | json | Updated Airtable record |
↳ id | string | Record ID |
↳ createdTime | string | Record creation timestamp |
↳ fields | json | Record field values |
metadata | json | Operation metadata |
↳ recordCount | number | Number of records updated (always 1) |
↳ updatedFields | array | List of field names that were updated |
Update multiple existing records in an Airtable table
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
tableId | string | Yes | Table ID (starts with "tbl") or table name |
records | json | Yes | Array of records to update, each with an id and a fields object |
| Parameter | Type | Description |
|---|
records | array | Array of updated Airtable records |
↳ id | string | Record ID |
↳ createdTime | string | Record creation timestamp |
↳ fields | json | Record field values |
metadata | json | Operation metadata |
↳ recordCount | number | Number of records updated |
↳ updatedRecordIds | array | List of updated record IDs |
Update existing records or create new ones in an Airtable table, matching on the specified merge fields
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
tableId | string | Yes | Table ID (starts with "tbl") or table name |
records | json | Yes | Array of records to upsert, each with a fields object |
fieldsToMergeOn | json | Yes | Array of field names used to match existing records (max 3). A record is updated when all merge fields match, otherwise it is created. Example: ["Name"] |
typecast | boolean | No | When true, Airtable automatically converts string values to the field type |
| Parameter | Type | Description |
|---|
records | array | Array of upserted Airtable records |
↳ id | string | Record ID |
↳ createdTime | string | Record creation timestamp |
↳ fields | json | Record field values |
createdRecords | array | IDs of records that were created |
updatedRecords | array | IDs of records that were updated |
metadata | json | Operation metadata |
↳ recordCount | number | Total number of records returned |
↳ createdCount | number | Number of records created |
↳ updatedCount | number | Number of records updated |
Delete one or more records from an Airtable table by ID
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
tableId | string | Yes | Table ID (starts with "tbl") or table name |
recordIds | json | Yes | Array of record IDs to delete (each starts with "rec", e.g., ["recXXXXXXXXXXXXXX"]). Pass a single-element array to delete one record. |
| Parameter | Type | Description |
|---|
records | array | Array of deleted Airtable records |
↳ id | string | Record ID |
↳ deleted | boolean | Whether the record was deleted |
metadata | json | Operation metadata |
↳ recordCount | number | Number of records deleted |
↳ deletedRecordIds | array | List of deleted record IDs |
Get the schema of all tables, fields, and views in an Airtable base
| Parameter | Type | Required | Description |
|---|
baseId | string | Yes | Airtable base ID (starts with "app", e.g., "appXXXXXXXXXXXXXX") |
| Parameter | Type | Description |
|---|
tables | json | Array of table schemas with fields and views |
metadata | json | Operation metadata including total tables count |
