← Airtable

List Records with Airtable API

Pipedream makes it easy to connect APIs for Airtable and + 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
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,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. Configure baseId
    3. Configure tableId
    4. Optional- Configure 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.1.0
Key:airtable-list-records

Code

const common = require("../common.js");
const commonList = require("../common-list.js");

module.exports = {
  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.1.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.
baseId$.airtable.baseId
tableId$.airtable.tableId
Sort: FieldsortFieldId$.airtable.fieldId

Optionally select a field to sort results. To sort by multiple fields, use the Filter by Forumla field.

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.

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.