Pipedrive ACTION
List Deals
List deals in your Pipedrive account. See the documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Pipedrive account once, then configure and run List Deals 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-list-deals",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
pipedrive: { authProvisionId: "apn_xxxxxxx" },
filterId: 10,
dealIds: ["Deal IDs"],
},
})
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-list-deals",
"configured_props": {
"pipedrive": { "authProvisionId": "apn_xxxxxxx" },
"filterId": 10,
"dealIds": ["Deal IDs"]
}
}'// 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-list-deals",
arguments: {
filterId: 10,
dealIds: ["Deal IDs"],
},
})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 |
|---|---|---|
filterId Filter ID | integer | The ID of the filter to apply to deals Optional Dynamic |
dealIds Deal IDs | string[] | The IDs of the deals to list. Filter ID takes precedence over Deal IDs when supplied. Optional Dynamic |
ownerId Owner ID | integer | ID of the user who will be marked as the owner of this deal. If omitted, the authorized user ID will be used. However, Filter ID takes precedence over Owner ID when supplied. Optional Dynamic |
personId Person ID | integer | If supplied, only deals matching the given person will be returned. However, Filter ID takes precedence over Person ID when supplied. Optional Dynamic |
organizationId Organization ID | integer | If supplied, only deals matching the given organization will be returned. However, Filter ID takes precedence over Organization ID when supplied. Optional Dynamic |
pipelineId Pipeline ID | integer | If supplied, only deals matching the given pipeline will be returned. However, Filter ID takes precedence over Pipeline ID when supplied. Optional Dynamic |
stageId Stage ID | integer | If supplied, only deals matching the given stage will be returned. However, Filter ID takes precedence over Stage ID when supplied. Optional Dynamic |
status Status | string | Only fetch deals with a specific status Optional |
updatedSince Updated Since | string | If set, only deals with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. Optional |
updatedUntil Updated Until | string | If set, only deals with an update_time earlier than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. Optional |
sortBy Sort By | string | The field to sort by Optional |
sortDirection Sort Direction | string | The direction to sort by Optional |
includeFields Include Fields | string[] | Additional fields to include in the response Optional |
customFields Custom Fields | string[] | Optional comma separated string array of custom fields keys to include Optional |
limit Limit | integer | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. Optional |
cursor Cursor | string | For pagination, the cursor to the next page of results. If not provided, the first page will be returned. 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-list-deals
- Version
- 0.0.4
- App
- Pipedrive
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗