View as Markdown
Grist icon

Grist ACTION

Find Records

Searches for records in a specified table. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Grist account once, then configure and run Find 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: "grist-find-records",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    grist: { authProvisionId: "apn_xxxxxxx" },
    docId: "Document ID",
    tableId: "Table ID",
  },
})

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.

Find Records inputs
Property Type Description
docId Document ID string
The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Required
tableId Table ID string
The ID of the table to operate on.
Required Dynamic
filter Filter string
This is a JSON object mapping column names to arrays of allowed values. For example, to filter column pet for values cat and dog, the filter would be {"pet": ["cat", "dog"]}. Multiple columns can be filtered. For example the filter for pet being either cat or dog, AND size being either tiny or outrageously small, would be {"pet": ["cat", "dog"], "size": ["tiny", "outrageously small"]}
Optional
limit Limit integer
Return at most this number of rows. A value of 0 is equivalent to having no limit.
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
grist-find-records
Version
0.0.3
App
Grist
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes