View as Markdown
nocodb icon

nocodb ACTION

List Records in Table Matching Criteria

This action lists all rows in a table. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's nocodb account once, then configure and run List Records in Table Matching Criteria 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: "nocodb-list-records-matching-criteria",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nocodb: { authProvisionId: "apn_xxxxxxx" },
    workspaceId: "Workspace ID",
    projectId: "Project 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.

List Records in Table Matching Criteria inputs
Property Type Description
workspaceId Workspace ID string
The ID of a workspace
Required Dynamic
projectId Project ID string
The ID of the project
Required Dynamic
tableId Table ID string
The ID of the table
Required Dynamic
fields Fields string[]
Fields that will be fetched See the docs here
Optional Dynamic
sort Sort string[]
Order in which the data will be fetched See the docs here
Optional Dynamic
where Where string
Complicated where conditions See the docs here
Optional
limit Limit integer
Maximum records that will be fetched
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
nocodb-list-records-matching-criteria
Version
0.0.9
App
nocodb
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes