View as Markdown
Airtable icon

Airtable ACTION

List Records in View

Retrieve records from a view, optionally sorting and filtering results. Use List Tables to look up a table's view IDs. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Airtable account once, then configure and run List Records in View from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "airtable_oauth-list-records-in-view",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    airtable_oauth: { authProvisionId: "apn_xxxxxxx" },
    baseId: "Base",
    tableId: "Table",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Records in View inputs
Property Type Description
baseId Base string
The ID of the base to use, e.g. appXXXXXXXXXXXXXX. Use List Bases to look one up.
Required
tableId Table string
The ID of the table to use, e.g. tblXXXXXXXXXXXXXX. Use List Tables to look one up.
Required
viewId View string
The ID of the view to use, e.g. viwXXXXXXXXXXXXXX. Use List Tables to look up a table's views.
Required
sortFieldId Sort by Field string
Optionally provide a field ID to sort results by, e.g. fldXXXXXXXXXXXXXX. Use List Tables to look up a table's field IDs. To sort by multiple fields, use Filter by Formula instead.
Optional
sortDirection Sort: Direction string
If sorting by a field, which direction to sort by.
Optional
maxRecords Max Records integer
The maximum number of records to return. Leave blank to retrieve all records.
Optional
filterByFormula Filter by Formula string
Optionally provide a formula (see info on the documentation) 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, use NOT({Name} = '').
Optional
returnFieldsByFieldId Return Fields By ID boolean
If set to true, the returned field objects will have the field ID as the key, instead of the field name.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
airtable_oauth-list-records-in-view
Version
0.0.15
App
Airtable
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes