View as Markdown
Pipedrive icon

Pipedrive ACTION

List Persons

List persons 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 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-list-persons",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pipedrive: { authProvisionId: "apn_xxxxxxx" },
    filterId: 10,
    personIds: ["Person IDs"],
  },
})

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.

List Persons inputs
Property Type Description
filterId Filter ID integer
The ID of the filter to apply to persons
Optional Dynamic
personIds Person IDs string[]
The IDs of the persons to list (up to 100). Filter ID takes precedence over Person IDs when supplied.
Optional Dynamic
ownerId Owner ID integer
ID of the user who owns the person. If omitted, persons owned by any user are returned. Filter ID takes precedence over Owner ID when supplied.
Optional Dynamic
organizationId Organization ID integer
If supplied, only persons linked to the given organization will be returned. Filter ID takes precedence over Organization ID when supplied.
Optional Dynamic
dealId Deal ID string
If supplied, only persons linked to the given deal will be returned. Filter ID takes precedence over Deal ID when supplied.
Optional Dynamic
updatedSince Updated Since string
If set, only persons 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 persons with an update_time earlier than 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. marketing_status and doi_status can only be included when the user's country is set in Pipedrive.
Optional
customFields Custom Fields string[]
Optional string array of custom field keys to include in the response.
Optional
includeOptionLabels Include Option Labels boolean
When true, single-option and multi-option custom field values include the option labels alongside their IDs. Defaults to false.
Optional
includeLabels Include Labels boolean
When true, the response includes an array of label objects ({ id, label, color }) for each person. Defaults to false.
Optional
limit Limit integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum allowed value is 500.
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-persons
Version
0.0.2
App
Pipedrive
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes