Pipedrive ACTION
Search persons
Searches all Persons by
name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found Persons can be filtered by Organization ID. See the Pipedrive API docs here- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Pipedrive account once, then configure and run Search persons 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-persons",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
pipedrive: { authProvisionId: "apn_xxxxxxx" },
term: "Search Term",
fields: ["Search Fields"],
},
})
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": "pipedrive-search-persons",
"configured_props": {
"pipedrive": { "authProvisionId": "apn_xxxxxxx" },
"term": "Search Term",
"fields": ["Search Fields"]
}
}'// 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": "pipedrive",
},
},
},
)
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: "pipedrive-search-persons",
arguments: {
term: "Search Term",
fields: ["Search Fields"],
},
})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 |
|---|---|---|
term Search Term | string | The search term to look for. Minimum 2 characters (or 1 if using exact_match). Required |
fields Search Fields | string[] | An array containing fields to perform the search from. Defaults to all of them. Optional |
exactMatch Exact Match | boolean | When enabled, only full exact matches against the given term are returned. It is not case sensitive. Optional |
organizationId Organization ID | integer | Will filter Deals by the provided Organization ID. The upper limit of found Deals associated with the Organization is 2000. Optional Dynamic |
includeFields Include Fields | string | Supports including optional fields in the results which are not provided by default. Optional |
start Pagination Start | integer | Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter. Optional |
limit Limit | integer | Items shown per page Optional |
includeAllCustomFields Include All Custom Fields | boolean | When enabled, all custom fields will be included in the 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
- pipedrive-search-persons
- Version
- 0.1.26
- App
- Pipedrive
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗