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

# Airtable (Personal Access Token)

## Overview

<CardGroup cols={3}>
  <Card title="Pre-built tooling" icon="screwdriver-wrench" href="#pre-built-tooling" />

  <Card title="Pre-built integrations" icon="square-check" href="#pre-built-integrations" />

  <Card title="Access requirements" icon="triangle-exclamation" href="#access-requirements" />

  <Card title="Setup guide" icon="rocket" href="#setup-guide" />

  <Card title="Useful links" icon="circle-info" href="#useful-links" />

  <Card title="API gotchas" icon="biohazard" href="#api-gotchas" />
</CardGroup>

## Pre-built tooling

<AccordionGroup>
  <Accordion title="✅ Authorization">
    | Tools                             | Status |
    | --------------------------------- | ------ |
    | Pre-built authorization (API Key) | ✅      |
    | Pre-built authorization UI        | ✅      |
    | Custom authorization UI           | ✅      |
    | End-user authorization guide      | ✅      |
    | Expired credentials detection     | ✅      |
  </Accordion>

  <Accordion title="✅ Read & write data">
    | Tools                                     | Status                         |
    | ----------------------------------------- | ------------------------------ |
    | Pre-built integrations                    | ✅                              |
    | API unification                           | ✅                              |
    | 2-way sync                                | ✅                              |
    | Webhooks from Nango on data modifications | ✅                              |
    | Real-time webhooks from 3rd-party API     | 🚫 (time to contribute: \<48h) |
    | Proxy requests                            | ✅                              |
  </Accordion>

  <Accordion title="✅ Observability & data quality">
    | Tools                   | Status |
    | ----------------------- | ------ |
    | HTTP request logging    | ✅      |
    | End-to-end type safety  | ✅      |
    | Data runtime validation | ✅      |
    | OpenTelemetry export    | ✅      |
    | Slack alerts on errors  | ✅      |
    | Integration status API  | ✅      |
  </Accordion>

  <Accordion title="✅ Customization">
    | Tools                              | Status                         |
    | ---------------------------------- | ------------------------------ |
    | Create or customize use-cases      | ✅                              |
    | Pre-configured pagination          | 🚫 (time to contribute: \<48h) |
    | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
    | Per-customer configurations        | ✅                              |
  </Accordion>
</AccordionGroup>

### Bases

| Function name            | Description                                                  | Type                                         | Source code                                                                                                                     |
| ------------------------ | ------------------------------------------------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `create-base`            | Create a new Airtable base in a workspace.                   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/create-base.ts)            |
| `get-base-collaborators` | Retrieve collaborators and permissions for an Airtable base. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/get-base-collaborators.ts) |
| `list-bases`             | List Airtable bases accessible to the authenticated user.    | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/list-bases.ts)             |

### Comments

| Function name    | Description                               | Type                                         | Source code                                                                                                             |
| ---------------- | ----------------------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `create-comment` | Create a comment on an Airtable record.   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/create-comment.ts) |
| `delete-comment` | Delete a comment from an Airtable record. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/delete-comment.ts) |
| `list-comments`  | List comments on an Airtable record.      | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/list-comments.ts)  |
| `update-comment` | Update a comment on an Airtable record.   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/update-comment.ts) |

### Fields

| Function name  | Description                              | Type                                         | Source code                                                                                                           |
| -------------- | ---------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `create-field` | Create a new field on an Airtable table. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/create-field.ts) |
| `update-field` | Update metadata for an Airtable field.   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/update-field.ts) |

### Metadata

| Function name     | Description                                                         | Type                                         | Source code                                                                                                              |
| ----------------- | ------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `get-base-schema` | Retrieve Airtable base schema metadata including tables and fields. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/get-base-schema.ts) |

### Records

| Function name           | Description                                                                   | Type                                         | Source code                                                                                                                    |
| ----------------------- | ----------------------------------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `batch-create-records`  | Create multiple Airtable records in one request.                              | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/batch-create-records.ts)  |
| `batch-delete-records`  | Delete multiple Airtable records by record ID.                                | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/batch-delete-records.ts)  |
| `batch-replace-records` | Replace multiple Airtable records in one request.                             | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/batch-replace-records.ts) |
| `batch-update-records`  | Update multiple Airtable records in one request.                              | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/batch-update-records.ts)  |
| `create-record`         | Create a single Airtable record in a table.                                   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/create-record.ts)         |
| `delete-record`         | Delete a single Airtable record by record ID.                                 | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/delete-record.ts)         |
| `get-record`            | Retrieve a single Airtable record by record ID.                               | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/get-record.ts)            |
| `list-records`          | List Airtable records from a table with view, filter, and pagination options. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/list-records.ts)          |
| `replace-record`        | Replace a single Airtable record.                                             | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/replace-record.ts)        |
| `update-record`         | Update fields on a single Airtable record.                                    | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/update-record.ts)         |
| `upload-attachment`     | Upload an attachment into a record's attachment field.                        | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/upload-attachment.ts)     |
| `upsert-records`        | Update or insert Airtable records using performUpsert match fields.           | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/upsert-records.ts)        |

### Tables

| Function name  | Description                            | Type                                         | Source code                                                                                                           |
| -------------- | -------------------------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `create-table` | Create a new table in an Airtable base | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/create-table.ts) |
| `update-table` | Update metadata for an Airtable table. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/update-table.ts) |

### Users

| Function name   | Description                                                            | Type                                         | Source code                                                                                                            |
| --------------- | ---------------------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `get-user-info` | Retrieve information about the authenticated Airtable user and scopes. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/get-user-info.ts) |

### Views

| Function name | Description                               | Type                                         | Source code                                                                                                         |
| ------------- | ----------------------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `list-views`  | List views available in an Airtable base. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/list-views.ts) |

### Webhooks

| Function name               | Description                                               | Type                                         | Source code                                                                                                                        |
| --------------------------- | --------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `create-webhook`            | Create an Airtable webhook on a base.                     | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/create-webhook.ts)            |
| `delete-webhook`            | Delete an Airtable webhook from a base.                   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/delete-webhook.ts)            |
| `list-webhook-payloads`     | List delivered payload batches for an Airtable webhook.   | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/list-webhook-payloads.ts)     |
| `list-webhooks`             | List webhooks configured on an Airtable base.             | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/list-webhooks.ts)             |
| `refresh-webhook`           | Refresh an Airtable webhook expiration before it expires. | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/refresh-webhook.ts)           |
| `set-webhook-notifications` | Enable or disable notifications for an Airtable webhook.  | [Action](/guides/functions/action-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/actions/set-webhook-notifications.ts) |

### Others

| Function name | Description                                            | Type                                           | Source code                                                                                                     |
| ------------- | ------------------------------------------------------ | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `bases`       | Sync Airtable bases visible to the authenticated user. | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/syncs/bases.ts)    |
| `records`     | Sync Airtable records for a specific base and table.   | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/syncs/records.ts)  |
| `tables`      | Sync Airtable table schemas across bases in scope.     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/syncs/tables.ts)   |
| `views`       | Sync Airtable views for bases and tables in scope.     | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/syncs/views.ts)    |
| `webhooks`    | Sync Airtable webhooks configured on bases in scope    | [Sync](/guides/functions/syncs/sync-functions) | [🔗 Github](https://github.com/NangoHQ/integration-templates/blob/main/integrations/airtable/syncs/webhooks.ts) |

## Access requirements

| Pre-Requisites    | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account  | ❓      |         |
| Paid test account | ❓      |         |
| Partnership       | ❓      |         |
| App review        | ❓      |         |
| Security audit    | ❓      |         |

## Setup guide

*No setup guide yet.*

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/airtable-pat.mdx)</Note>

## Useful links

* [Generate an Airtable Personal Access Token](https://airtable.com/create/tokens/new)
* [Airtable Authentication](https://airtable.com/developers/web/guides/personal-access-tokens#using-personal-access-tokens)
* [Personal Access Token Scopes](https://airtable.com/developers/web/api/scopes)
* [API Rate Limiting](https://airtable.com/developers/web/api/rate-limits)
* [Web API docs (their REST API)](https://airtable.com/developers/web/api/introduction)
* [SCIM API docs (their REST SCIM API)](https://airtable.com/developers/web/api/scim-overview)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/airtable-pat.mdx)</Note>

## API gotchas

* Airtable (Personal Access Token) uses API\_KEY auth mode with `authorization: Bearer API_KEY` in the request header to access different endpoints.

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/airtable-pat.mdx)</Note>

## Going further

<Card title="Connect to Airtable (Personal Access Token)" icon="link" href="/integrations/all/airtable-pat/connect" horizontal>
  Guide to connect to Airtable (Personal Access Token) using Connect UI
</Card>