View as Markdown
Airtable icon

Airtable ACTION

Search Records

Find records in a table using an Airtable formula, or a Search Field + Search Value pair. Search Formula takes precedence when provided; otherwise Search Field and Search Value must both be set. Use List Tables first to look up the table's field names. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Airtable account once, then configure and run Search Records 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-search-records",
  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.

Search Records 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
searchFormula Search Formula string
An Airtable formula to filter records by, e.g. FIND('test-1', {Tags}) to find records where Tags includes test-1, or {Status} = "Won" for an exact match. Takes precedence over Search Field + Search Value when set.
Optional
fieldName Search Field string
The field to match against Search Value, e.g. Status. Use together with Search Value as a simpler alternative to Search Formula. Use the List Tables action to look up the table's field names.
Optional
value Search Value string
The value to match against Search Field, e.g. Won. For a checkbox field, use true or false; for a number field, a numeric value.
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-search-records
Version
1.0.0
App
Airtable
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes