View as Markdown
Pipedrive icon

Pipedrive ACTION

Search Leads

Search for leads by name or email. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Pipedrive 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: "pipedrive-search-leads",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pipedrive: { authProvisionId: "apn_xxxxxxx" },
    term: "Search Term",
    exactMatch: true,
  },
})

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
term Search Term string
The search term to look for. Minimum 2 characters (or 1 if using exact_match).
Required
exactMatch Exact Match boolean
When enabled, only full exact matches against the given term are returned. It is not case sensitive.
Optional
fields Search Fields string[]
An array containing fields to perform the search from. Defaults to all of them.
Optional
personId Person ID integer
Will filter leads by the provided Person ID
Optional Dynamic
organizationId Organization ID integer
Will filter leads by the provided Organization ID
Optional Dynamic
includeFields Include fields string
Supports including optional fields in the results which are not provided by default.
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
pipedrive-search-leads
Version
0.0.11
App
Pipedrive
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes