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

# Airtable: List Records

Retrieve records from an Airtable base table with filtering and sorting. Use filterByFormula for conditional queries. Supports pagination up to 100 records. Ideal for: data lookups, report generation, fetching CRM data, inventory queries.

![Airtable: List Records logo](https://ai-icon.b3.fun/logo/airtable)
Catalog action Integrations pipedream:airtable

Retrieve records from an Airtable base table with filtering and sorting. Use filterByFormula for conditional queries. Supports pagination up to 100 records. Ideal for: data lookups, report generation, fetching CRM data, inventory queries.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `airtable-list-records` |
| Category | Integrations |
| Connector | `pipedream:airtable` |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `pipedream`, `integration`, `oauth`, `airtable`, `database`, `read`, `query`, `filter`, `list`, `fetch` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `baseId` | `string` | Yes | Airtable base ID \(starts with 'app', e.g., 'appXXXXXXXXXXXXXX'\) |
| `tableId` | `string` | Yes | Table ID or table name |
| `maxRecords` | `number` | No | Maximum number of records to return \(default: 100, max: 100\) |
| `filterByFormula` | `string` | No | Airtable formula to filter records \(e.g., '&#123;Status&#125; = "Active"'\) |
| `sort` | `array` | No | Array of sort objects to specify sort order |
| `view` | `string` | No | View name or ID to use |
| `fields` | `array` | No | Array of field names to return \(returns all fields if omitted\) |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | `boolean` | Yes | Whether the records were retrieved successfully |
| `data` | `object` | No | Airtable API response data |
| `exports` | `object` | No | Exported values from the action |

## Examples

**Workflow node**

```json
{
  "type": "airtable-list-records",
  "payload": {
    "baseId": "example-baseId",
    "tableId": "example-tableId"
  },
  "children": [],
  "connector": {
    "type": "pipedream:airtable",
    "id": "conn_pipedream_airtable"
  }
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/airtable-list-records/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "baseId": "example-baseId",
    "tableId": "example-tableId"
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.