Ironclad ACTION
List Record ID Options
Returns one page of Ironclad records as
{label, value} pairs (where value is the record ID). Call this before using the links, parent, or children fields in Create Record to find valid record IDs. Search Records is the primary way to find a record by attribute values; use this action only to page through the full list or when resolving a record ID field directly. Results are 0-indexed by page; if the response contains the maximum number of items, increment page and call again to fetch more. Example return: [{"label": "Acme NDA", "value": "rec_abc123"}, ...]. See the documentation- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Ironclad account once, then configure and run List Record ID Options 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: "ironclad-list-record-id-options",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
ironclad: { authProvisionId: "apn_xxxxxxx" },
page: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "ironclad-list-record-id-options",
"configured_props": {
"ironclad": { "authProvisionId": "apn_xxxxxxx" },
"page": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "ironclad",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "ironclad-list-record-id-options",
arguments: {
page: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
page Page | integer | The 0-indexed page of results to retrieve. Increment and call again if the previous response contained the maximum number of items. Required |
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
- ironclad-list-record-id-options
- Version
- 0.0.3
- App
- Ironclad
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗