# Airtable API - Database & Records Automation (`alizarin_refrigerator-owner/airtable-api---database-records-automation`) Actor

Automate your Airtable bases with the official API. List, create, update, and delete records. Manage tables and fields. Sync data between Airtable and other systems. Perfect for CRM automation, inventory management, project tracking, and data pipelines.

- **URL**: https://apify.com/alizarin_refrigerator-owner/airtable-api---database-records-automation.md
- **Developed by:** [The Howlers](https://apify.com/alizarin_refrigerator-owner) (community)
- **Categories:** Automation, Integrations, Developer tools
- **Features:** Limited permissions
- **Stats:** 6 total users, 0 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.05 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Airtable API - Database & Records Automation

Automate Airtable bases with the official API. List, create, update, and delete records. Manage tables and fields. Sync data between Airtable and other systems. Perfect for CRM automation, inventory management, and data pipelines.

**BYOK (Bring Your Own Key)**: you provide your own API credentials.

***

### Before You Start

This actor requires your own API credentials to fetch real data.

**Where to get your key:** Airtable personal access token (from airtable.com/create/tokens)

Demo Mode is off by default, so runs with an access token fetch real data. Set demoMode to true to get sample data that shows the output format, no key needed. A run without an access token also returns sample data instead of failing.

***

### Quick Start

#### Test with Demo Mode (no task charges, no API key needed)

```json
{
  "demoMode": true
}
```

#### Run with real data

```json
{
  "demoMode": false,
  "task": "list_records",
  "accessToken": "YOUR_API_KEY_HERE",
  "fields": {},
  "sort": [],
  "maxRecords": 100,
  "tableFields": [],
  "fieldOptions": {},
  "batchRecords": []
}
```

***

### Input Parameters

| Parameter | Type | Default | Required | Description |
|-----------|------|---------|----------|-------------|
| `task` | string | `"list_records"` | Yes\* | Operation to perform |
| `accessToken` | string | - | Yes\* | Airtable personal access token (from airtable.com/create/tokens) |
| `baseId` | string | - | No | Airtable base ID (starts with 'app') |
| `tableIdOrName` | string | - | No | Table ID (starts with 'tbl') or table name |
| `recordId` | string | - | No | Record ID for get/update/delete operations (starts with 'rec') |
| `fieldId` | string | - | No | Field ID for field operations (starts with 'fld') |
| `fields` | object | `{}` | No | Fields object for create/update record operations (JSON) |
| `filterByFormula` | string | - | No | Airtable formula to filter records (e.g., "{Status} = 'Active'") |
| `sort` | array | `[]` | No | Sort records by fields (JSON array: \[{field: 'Name', direction: 'asc'}]) |
| `view` | string | - | No | Airtable view to use for listing records |
| `maxRecords` | integer | `100` | No | Maximum number of records to return |
| `tableName` | string | - | No | Name for new table |
| `tableDescription` | string | - | No | Description for new table |
| `tableFields` | array | `[]` | No | Fields schema for new table (JSON array) |
| `fieldName` | string | - | No | Name for new field |
| `fieldType` | string | - | No | Type for new field |
| `fieldOptions` | object | `{}` | No | Additional options for field (JSON) |
| `batchRecords` | array | `[]` | No | Array of records for batch operations |
| `webhookUrl` | string | - | No | URL to send results to (Zapier, Make, n8n, etc.) |
| `demoMode` | boolean | `false` | No | Run with sample data (no access token required) |

\*Needed for real data. With Demo Mode off and no access token, the run returns sample data.

***

### Pricing

This actor uses **pay-per-event** billing:

| Event | When it is charged | Price |
|-------|--------------------|-------|
| Actor start | Once when the run starts, one event per GB of memory (minimum one). At the default 1 GB of memory a run starts at $0.10 | $0.10 per GB |
| Result | Each item written to the default dataset | $0.00005 |
| List Records | Once per successful list_records query, including one that matches no records | $0.02 |
| Get Record | Once per get_record task that returns the record | $0.01 |
| Create Record | Once per create_record task that Airtable confirms | $0.02 |
| Update Record | Once per update_record task that Airtable confirms | $0.02 |
| Delete Record | Once per delete_record task that Airtable confirms | $0.01 |
| List Tables | Once per list_tables task | $0.01 |
| Get Table | Once per get_table task that finds the table | $0.01 |
| Create Table | Once per create_table task that Airtable confirms | $0.03 |
| List Fields | Once per list_fields task | $0.01 |
| Create Field | Once per create_field task that Airtable confirms | $0.03 |
| Update Field | Once per update_field task that Airtable confirms | $0.02 |
| List Bases | Once per list_bases task | $0.01 |
| Get Base | Once per get_base task | $0.01 |
| Batch Create Records | Per batch of up to 10 records that Airtable creates | $0.05 |
| Batch Update Records | Per batch of up to 10 records that Airtable updates | $0.05 |
| Batch Delete Records | Per batch of up to 10 records that Airtable deletes | $0.05 |

**Demo mode charges no task events.** A demo run still pays the Actor start event and one Result event for its sample row.

A single-record, list or schema task that fails (for example a wrong token or a missing table) charges no task event. Batch tasks are charged one event per batch of up to 10 records as soon as Airtable accepts that batch. If a later batch fails, the batches Airtable already accepted stay charged, those records stay written in Airtable, and the error row reports them as batchesCompletedBeforeError. Every run, including a failed one, pays the Actor start event, and the error row counts as one Result.

If the run reaches its maximum total charge, the remaining batches are not sent to Airtable and the result row lists how many records were skipped.

***

### Troubleshooting

#### I got sample data instead of my records

The run had no access token, so it returned sample data (the row says demoMode: true). Add your Airtable personal access token in the input and keep Demo Mode off to work with your own base.

#### "API error 403" or "Unauthorized"

Your API key is invalid, expired, or doesn't have access to this specific API endpoint. Double-check your key and account permissions.

#### "API error 429" or "Rate limit"

Too many requests. Wait a minute and try again, or reduce the number of items per run.

#### No results or empty dataset

Check the run log for error messages. Common causes:

- Invalid input format (check the examples above)
- API key without proper permissions
- The target data doesn't exist or is too small to track

#### How do I test without an API key?

Enable **Demo Mode** in the input. This returns realistic sample data so you can verify the output format works for your workflow.

***

**Built by John Rippy | [Actor Arsenal](https://actorarsenal.com)**

# Actor input Schema

## `task` (type: `string`):

Operation to perform

## `accessToken` (type: `string`):

Airtable personal access token (from airtable.com/create/tokens)

## `baseId` (type: `string`):

Airtable base ID (starts with 'app')

## `tableIdOrName` (type: `string`):

Table ID (starts with 'tbl') or table name

## `recordId` (type: `string`):

Record ID for get/update/delete operations (starts with 'rec')

## `fieldId` (type: `string`):

Field ID for field operations (starts with 'fld')

## `fields` (type: `object`):

Fields object for create/update record operations (JSON)

## `filterByFormula` (type: `string`):

Airtable formula to filter records (e.g., "{Status} = 'Active'")

## `sort` (type: `array`):

Sort records by fields (JSON array: \[{field: 'Name', direction: 'asc'}])

## `view` (type: `string`):

Airtable view to use for listing records

## `maxRecords` (type: `integer`):

Maximum number of records to return

## `tableName` (type: `string`):

Name for new table

## `tableDescription` (type: `string`):

Description for new table

## `tableFields` (type: `array`):

Fields schema for new table (JSON array)

## `fieldName` (type: `string`):

Name for new field

## `fieldType` (type: `string`):

Type for new field

## `fieldOptions` (type: `object`):

Additional options for field (JSON)

## `batchRecords` (type: `array`):

Array of records for batch operations

## `webhookUrl` (type: `string`):

URL to send results to (Zapier, Make, n8n, etc.)

## `demoMode` (type: `boolean`):

Run with sample data (no access token required)

## Actor input object example

```json
{
  "task": "list_records",
  "fields": {},
  "sort": [],
  "maxRecords": 100,
  "tableFields": [],
  "fieldOptions": {},
  "batchRecords": [],
  "demoMode": false
}
```

# Actor output Schema

## `results` (type: `string`):

Structured response from the Airtable API containing records, tables, fields, or bases depending on the task executed.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "demoMode": false
};

// Run the Actor and wait for it to finish
const run = await client.actor("alizarin_refrigerator-owner/airtable-api---database-records-automation").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "demoMode": False }

# Run the Actor and wait for it to finish
run = client.actor("alizarin_refrigerator-owner/airtable-api---database-records-automation").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "demoMode": false
}' |
apify call alizarin_refrigerator-owner/airtable-api---database-records-automation --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,alizarin_refrigerator-owner/airtable-api---database-records-automation"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/jX5f0yWSrW9iscQFB/builds/ZlhLeqqsMxMnrf3Tu/openapi.json
