View as Markdown
Nutshell icon

Nutshell ACTION

Search Leads

Search leads in Nutshell. Returns records in the existing lead output format. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Nutshell account once, then configure and run Search Leads 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: "nutshell-search-leads",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    nutshell: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    limit: 10,
  },
})

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 Leads inputs
Property Type Description
query Query string
Free-text search string mapped to the REST q query parameter.
Optional
limit Limit integer
Maximum number of records to return (min 1, max 1000).
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
nutshell-search-leads
Version
1.0.0
App
Nutshell
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes