← Airtable

List Records with Airtable API

Pipedream makes it easy to connect APIs for Airtable and 700+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Records with the Airtable API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to List Records with the Airtable API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the List Records action
    1. Connect your Airtable account
    2. Select a Base
    3. Select a Table
    4. Optional- Select a Sort: Field
    5. Optional- Select a Sort: Direction
    6. Optional- Configure Max Records
    7. Optional- Configure Filter by Formula
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

List Records on Airtable
Description:Retrieve records from a table with automatic pagination. Optionally sort and filter results.
Version:0.2.0
Key:airtable-list-records

Code

import common from "../common.mjs";
import commonList from "../common-list.mjs";

export default {
  key: "airtable-list-records",
  name: "List Records",
  description: "Retrieve records from a table with automatic pagination. Optionally sort and filter results.",
  type: "action",
  version: "0.2.0",
  ...commonList,
  props: {
    ...common.props,
    ...commonList.props,
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
AirtableairtableappThis component uses the Airtable app.
BasebaseIdstringSelect a value from the drop down menu.
TabletableIdstringSelect a value from the drop down menu.
Sort: FieldsortFieldIdstringSelect a value from the drop down menu.
Sort: DirectionsortDirectionstringSelect a value from the drop down menu:{ "label": "Descending", "value": "desc" }{ "label": "Ascending", "value": "asc" }
Max RecordsmaxRecordsinteger

Optionally limit the maximum number of records to return. Leave blank to retrieve all records.

Filter by FormulafilterByFormulastring

Optionally provide a formula used to filter records. The formula will be evaluated for each record, and if the result is not 0, false, "", NaN, [], or #Error! the record will be included in the response. For example, to only include records where Name isn't empty, pass NOT({Name} = '').

Authentication

Airtable uses API keys for authentication. When you connect your Airtable account, Pipedream securely stores the keys so you can easily authenticate to Airtable APIs in both code and no-code steps.

Airtable uses simple token-based authentication. To generate or manage your API key, visit your account settings.

get airtable api key

About Airtable

Looks like a spreadsheet, acts like a database.