> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Airtable

> Airtable merges spreadsheet functionality with database power, enabling teams to organize projects, track tasks, and collaborate through customizable views, automation, and integra

Airtable merges spreadsheet functionality with database power, enabling teams to organize projects, track tasks, and collaborate through customizable views, automation, and integrations for data management

`airtable` · **26 tools** · **6 triggers**

## Connect it

```bash theme={"theme":"github-dark"}
run auth airtable
run auth airtable --scope team    # shared with the organization
```

Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one.

## Use it

```bash theme={"theme":"github-dark"}
run airtable          # common commands
run airtable --all    # every command
```

```ts theme={"theme":"github-dark"}
import { airtable } from "@boxd/run";
```

## Common tools

| Tool                                  | What it does                                                                                                                                      |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `create-multiple-records`             | DEPRECATED: Use AIRTABLE\_CREATE\_RECORDS instead. Creates multiple new records in a specified Airtable table.                                    |
| `create-record`                       | DEPRECATED: Use CreateRecords instead. Creates a new record in a specified Airtable table; field values must conform to the table's column types. |
| `create-record-from-natural-language` | Creates a new record in an Airtable table from a natural language description.                                                                    |
| `create-records`                      | Tool to create multiple records (up to 10) in a specified Airtable table.                                                                         |
| `get-base-schema`                     | Retrieves the detailed schema for a specified Airtable base, including its tables, fields, field types, and configurations, using the `baseId`.   |
| `get-record`                          | Retrieves a specific record from an Airtable table by its record ID.                                                                              |
| `list-bases`                          | Retrieves all Airtable bases accessible to the authenticated user, which may include an 'offset' for pagination.                                  |
| `update-multiple-records`             | Tool to update up to 10 records in an Airtable table with selective field modifications.                                                          |
| `update-multiple-records-put`         | Tool to destructively update multiple records in Airtable using PUT, clearing unspecified fields.                                                 |
| `update-record`                       | Modifies specified fields of an existing record in an Airtable base and table; the base, table, and record must exist.                            |
| `update-record-put`                   | Updates an existing record in an Airtable base using PUT method.                                                                                  |

<Accordion title="All 26 tools" icon="list">
  | Tool                                  | What it does                                                                                                                                                |
  | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | `create-base`                         | Creates a new Airtable base with specified tables and fields within a workspace.                                                                            |
  | `create-comment`                      | Tool to create a comment on a specific Airtable record. Use when adding comments to records, mentioning collaborators using @\[userId] syntax, or...        |
  | `create-field`                        | Creates a new field within a specified table in an Airtable base.                                                                                           |
  | `create-multiple-records`             | DEPRECATED: Use AIRTABLE\_CREATE\_RECORDS instead. Creates multiple new records in a specified Airtable table.                                              |
  | `create-record`                       | DEPRECATED: Use CreateRecords instead. Creates a new record in a specified Airtable table; field values must conform to the table's column types.           |
  | `create-record-from-natural-language` | Creates a new record in an Airtable table from a natural language description.                                                                              |
  | `create-records`                      | Tool to create multiple records (up to 10) in a specified Airtable table.                                                                                   |
  | `create-table`                        | Creates a new table within a specified existing Airtable base, allowing definition of its name, description, and field structure.                           |
  | `delete-comment`                      | Tool to delete a comment from a record in an Airtable table.                                                                                                |
  | `delete-multiple-records`             | Tool to delete up to 10 specified records from a table within an Airtable base.                                                                             |
  | `delete-record`                       | Permanently deletes a specific record from an existing table within an existing Airtable base.                                                              |
  | `get-attachment-info`                 | Retrieves attachment information from a specific field in an Airtable record.                                                                               |
  | `get-base-schema`                     | Retrieves the detailed schema for a specified Airtable base, including its tables, fields, field types, and configurations, using the `baseId`.             |
  | `get-record`                          | Retrieves a specific record from an Airtable table by its record ID.                                                                                        |
  | `get-user-info`                       | Retrieves information, such as ID and permission scopes, for the currently authenticated Airtable user from the `/meta/whoami` endpoint.                    |
  | `list-bases`                          | Retrieves all Airtable bases accessible to the authenticated user, which may include an 'offset' for pagination.                                            |
  | `list-comments`                       | Tool to list comments on a specific Airtable record. Use when retrieving comments for a record, with optional pagination support for large comment threads. |
  | `list-records`                        | Tool to list records from an Airtable table with filtering, sorting, and pagination.                                                                        |
  | `update-comment`                      | Tool to update an existing comment on a specific Airtable record.                                                                                           |
  | `update-field`                        | Updates a field's name or description in an Airtable table. Use this action to modify field metadata without changing the field's type or options.          |
  | `update-multiple-records`             | Tool to update up to 10 records in an Airtable table with selective field modifications.                                                                    |
  | `update-multiple-records-put`         | Tool to destructively update multiple records in Airtable using PUT, clearing unspecified fields.                                                           |
  | `update-record`                       | Modifies specified fields of an existing record in an Airtable base and table; the base, table, and record must exist.                                      |
  | `update-record-put`                   | Updates an existing record in an Airtable base using PUT method.                                                                                            |
  | `update-table`                        | Updates the name, description, and/or date dependency settings of a table in Airtable.                                                                      |
  | `upload-attachment`                   | Uploads a file attachment to a specified field in an Airtable record.                                                                                       |
</Accordion>

## Triggers (6)

Subscribe with `.on(...)` in a script. A trigger with required configuration takes it as the second argument.

| Trigger               | Needs    | What fires it                                                                 |
| --------------------- | -------- | ----------------------------------------------------------------------------- |
| Base Metadata Changed | nothing  | Triggers when an existing Airtable base changes its name or permission level. |
| Base Schema Changed   | `baseId` | Triggers when tables, fields, or views change in an Airtable base.            |
| User Profile Changed  | nothing  | Triggers when the connected Airtable user's profile information changes.      |
| View Created          | `baseId` | Triggers when a new view is created in an Airtable base.                      |
| View Deleted          | `baseId` | Triggers when a previously known Airtable view is deleted.                    |
| View Metadata Changed | `baseId` | Triggers when an Airtable view changes its name or type.                      |

[Open Airtable in the console →](https://app.boxd.sh/integrations/detail/airtable)
