View as Markdown
Softr icon

Softr ACTION

List Records

Retrieve a list of all records in a table. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Softr account once, then configure and run List 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: "softr-list-records",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    softr: { authProvisionId: "apn_xxxxxxx" },
    databaseId: "Database 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.

List Records inputs
Property Type Description
databaseId Database ID string
The ID of the Softr database (e.g., aBcDeFgHiJ). Use the List Databases action to get the ID of a database.
Required
tableId Table ID string
The ID of the table within the database (e.g., kLmNoPqRsT). Use the List Tables action to get the ID of a table.
Required
fieldNames Field Names boolean
If true, use field names as keys in the response fields object instead of field IDs.
Optional
viewId View ID string
The ID of the view to fetch (e.g., mNoPqRsT56). Use the List Table Views action to get the ID of a view.
Optional
limit Limit integer
The maximum number of records to return
Optional
offset Offset integer
The number of records to skip before returning results
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
softr-list-records
Version
0.0.1
App
Softr
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes