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

# Airtable

> Integrate your application with the Airtable API

## 🚀 Quickstart

Connect to Airtable with Nango and see data flow in 2 minutes.

<Steps>
  <Step title="Create the integration">
    In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Airtable*.
  </Step>

  <Step title="Authorize Airtable">
    Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Airtable. Later, you'll let your users do the same directly from your app.
  </Step>

  <Step title="Call the Airtable API">
    Let's make your first request to the Airtable API (fetch records from a table). Replace the placeholders below with your [secret key](https://app.nango.dev/dev/environment-settings), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

    <Tabs>
      <Tab title="cURL">
        ```bash theme={null}
        curl "https://api.nango.dev/proxy/v0/meta/bases" \
          -H "Authorization: Bearer <NANGO-SECRET-KEY>" \
          -H "Provider-Config-Key: <INTEGRATION-ID>" \
          -H "Connection-Id: <CONNECTION-ID>"
        ```
      </Tab>

      <Tab title="Node">
        Install Nango's backend SDK with `npm i @nangohq/node`. Then run:

        ```typescript theme={null}
        import { Nango } from '@nangohq/node';

        const nango = new Nango({ secretKey: '<NANGO-SECRET-KEY>' });

        const res = await nango.get({
            endpoint: '/v0/meta/bases',
            providerConfigKey: '<INTEGRATION-ID>',
            connectionId: '<CONNECTION-ID>'
        });

        console.log(res.data);
        ```
      </Tab>
    </Tabs>

    Or fetch credentials with the [Node SDK](/reference/sdks/node#get-a-connection-with-credentials) or [API](/reference/api/connection/get).

    ✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.
  </Step>

  <Step title="Implement Nango in your app">
    Follow our [Auth implementation guide](/guides/primitives/auth) to integrate Nango in your app.

    To obtain your own production credentials, follow the setup guide linked below.
  </Step>
</Steps>

## 📚 Airtable Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Airtable OAuth app](/api-integrations/airtable/how-to-register-your-own-airtable-api-oauth-app)\
  Register an OAuth app with Airtable and obtain credentials to connect it to Nango

Official docs: [Airtable Web API Documentation](https://airtable.com/developers/web/api/introduction)

## 🧩 Pre-built syncs & actions for Airtable

Enable them in your dashboard. Extend and customize to fit your needs.

### Others

| 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-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)               |
| `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)            |
| `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)              |
| `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)             |
| `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)              |
| `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-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)            |
| `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)             |
| `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)            |
| `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)    |
| `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)           |
| `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)                |
| `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)             |
| `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)                |
| `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)             |
| `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)              |
| `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)                |
| `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)           |
| `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)            |
| `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) |
| `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)            |
| `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)              |
| `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)             |
| `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)              |
| `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)            |
| `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)                    |

***