Pipedrive Connector

Source API Docs API Changelog Connector Changelog

Description

Pipedrive is a sales-focused customer relationship management tool. This component enables management of leads, companies, activities, and more.

API Documentation

Connections

OAuth 2.0

key: oauth2

Create a connection of type OAuth 2.0 to authenticate against the Pipedrive API.

Prerequisites

A Pipedrive sandbox account. Sign up via the Pipedrive Developers Corner.
Access to the Pipedrive Developer Hub to create and manage OAuth apps.

Setup Steps

Navigate to the Pipedrive Developer Hub.
Click Create an App and Select Public app.
Fill in the minimal required fields. Be sure to include the OAuth 2.0 Callback URL: https://oauth2.prismatic.io/callback
Update the Access scopes to grant the app access to the necessary types of data. Reference the Marketplace scopes and permissions explanations for information on what permissions the integration might need.
Click Save.
After saving, the OAuth & Access scopes section will include the Client ID and Client Secret for the app.

Note that the Pipedrive app must be submitted for review if "Yes" was selected on the "Intent to publish app" page during app creation.

Configure the Connection

Authorization URL: The OAuth 2.0 authorization URL. Defaults to https://oauth.pipedrive.com/oauth/authorize.
Token URL: The OAuth 2.0 token URL. Defaults to https://oauth.pipedrive.com/oauth/token.
Client ID: Enter the Client ID from the Pipedrive OAuth app.
Client Secret: Enter the Client Secret from the Pipedrive OAuth app.

Save the integration and the connection will be ready to authenticate against Pipedrive.

Pipedrive Custom Redirect URIs

For Pipedrive apps intended to be public and published in the Pipedrive marketplace, Pipedrive has additional stipulations for how app installation occurs. Reference the App installation flows documentation.

When a user within Pipedrive selects the app and clicks Install, Pipedrive requires that the Callback URL handle an auth code without a state search parameter in the URL.

Outside of this flow, the state variable is used to map an auth code to a config variable. When a user clicks Connect in the integration, they visit a Pipedrive consent screen and are redirected to the callback URL with search parameters ?code=[SOME AUTH CODE]&state=SW5example. The platform then exchanges that auth code for an access token, and saves that access token to the config variable with the SW5example ID.

With the Pipedrive installation flow, a custom endpoint must be supplied that captures and handles an auth code that potentially has no state attached to it (yet).

At a high level, the following is required:

Create a custom endpoint within the app that can receive code and optional state search parameters.
Save the code off to secure temporary browser storage:
- If the user is a guest of the app, encourage them to sign up.
- If the user is registered but not logged in, have them log in.
- If the user is logged in, continue.
Once a user is authenticated in the app with a Pipedrive auth code, programmatically create a customer (if needed) and programmatically deploy an unconfigured instance to the customer (assuming they do not have an instance of the Pipedrive integration already).
Look up the unconfigured instance's connection config variable's ID. Make a GET request to the callback URL with search parameters ?code=[SOME AUTH CODE]&state=SW5.... where state represents the config variable's ID. This will start the auth code exchange process.
Invoke configureInstance() with the unconfigured instance's ID to open a config wizard. The connection will be "active" from the previous step and the user will be able to continue through the config flow.

Update the integration's authorize URL

Note that Pipedrive only allows one Callback URL, which must be the custom endpoint (above), and must match redirect_uri in the authorization URL if a user initiates connection from the marketplace.

The redirect_uri in the authorize URL must be overridden to point to the custom endpoint.

Open the config variable in the integration designer and edit the Authorize URL from https://oauth.pipedrive.com/oauth/authorize to something like https://oauth.pipedrive.com/oauth/authorize?redirect_uri=https://example.com/your/callback/endpoint.

Input	Notes	Example
Authorization URL	OAuth 2.0 Authorization URL for Pipedrive authentication.	https://oauth.pipedrive.com/oauth/authorize
Client ID	The Client ID from the Pipedrive OAuth app. Find this in Settings > Developer Hub.	abc123def456
Client Secret	The Client Secret from the Pipedrive OAuth app. Keep this value secure.
Scopes	Space-delimited OAuth permission scopes.
Token URL	OAuth 2.0 Token URL for Pipedrive authentication.	https://oauth.pipedrive.com/oauth/token

Triggers

New and Updated Records

Checks for new and updated records in a selected Pipedrive resource type on a configured schedule. | key: pollChangesTrigger

Input	Notes	Example
Connection	The Pipedrive connection to use.
Look-back Date	The date the initial sync starts from, in YYYY-MM-DD format. Cannot be a future date. Leave empty to start from the first recurrence with no backfill. When set, the initial sync seeds each record modified on or after this date once, ignoring the trigger's visibility filters.	2026-01-01
Resource Type	The Pipedrive item type to monitor for new and updated records.
Show New Records	When enabled, records created since the last poll are returned in the trigger payload.	true
Show Updated Records	When enabled, records updated since the last poll are returned in the trigger payload.	true

The New and Updated Records polling trigger checks Pipedrive on a configured schedule for records of a selected resource type that were created or updated since the last poll. Unlike webhook-based triggers, polling does not require webhook subscription management and works reliably for low-frequency monitoring scenarios across the full range of Pipedrive resources (Deals, Persons, Organizations, Activities, Notes, Files, Products, Pipelines, Stages, Filters, Activity Types, and Users).

How It Works

On each scheduled execution, the trigger:

Reads the last poll timestamp from the polling state (or uses the current execution time on the first run) and formats it as a Pipedrive-compatible timestamp.
Calls the Pipedrive GET /v1/recents endpoint with the formatted since_timestamp and the selected resource type, walking all paginated results until every recent record has been retrieved.
Partitions the returned records into created and updated buckets by comparing each record's add_time field against the last poll cutoff. Records whose add_time is after the cutoff land in the created bucket, and all others land in the updated bucket. For the Users resource type, the created and modified fields are used in place of add_time.
Persists the current execution time as the new last-poll timestamp for the next run.
Emits the partitioned results in the trigger payload, filtered by the Show New Records and Show Updated Records toggles.

Returned Data

The trigger emits a payload with two arrays, created and updated, each containing record resources of the selected resource type. The shape of each record varies depending on the Resource Type chosen (for example, a Deal record exposes stage_id and pipeline_id, while a Person record exposes contact fields), so refer to the relevant Pipedrive resource schema when mapping fields downstream.

Example Payload

{
  "data": {
    "created": [
      {
        "id": 1,
        "title": "New Deal",
        "status": "open",
        "add_time": "2026-05-20 14:00:00",
        "update_time": "2026-05-20 14:00:00",
        "stage_id": 1,
        "pipeline_id": 1
      }
    ],
    "updated": [
      {
        "id": 2,
        "title": "Existing Deal",
        "status": "open",
        "add_time": "2026-04-01 09:00:00",
        "update_time": "2026-05-20 15:00:00",
        "stage_id": 2,
        "pipeline_id": 1
      }
    ]
  }
}

Fields shown are representative. The full response object includes additional properties.

When to Use Polling vs. Webhooks

Use the New and Updated Records polling trigger when the integration needs to run on a fixed schedule, when webhook subscription management is not desired, or when the volume of changes is low enough that polling latency is acceptable.
Use the Pipedrive Webhook trigger when near real-time delivery is required and the integration can manage subscription lifecycles in Pipedrive directly.

Example Payload for New and Updated Records⤓

Loading…

Webhook

Receive event notifications from Pipedrive. Automatically creates and manages a webhook subscription for the selected event action and object type. | key: pipedriveTrigger

Input	Notes	Example
Connection	The Pipedrive connection to use.
Event Action	The type of action that triggers the webhook.	create
Event Object	The Pipedrive resource type that triggers the webhook.	deal
HTTP Auth Password	The password used for HTTP Basic Auth when Pipedrive calls the subscription URL.
HTTP Auth User	The username used for HTTP Basic Auth when Pipedrive calls the subscription URL.	admin
User ID	The ID of the user that this webhook will be authorized with. A different user's user_id may be used. If not set, the authenticated user's user_id is used. Each webhook event is checked against the user's permissions, so the webhook is only sent if the user has access to the affected object(s). To receive notifications for all events, use a top-level admin user's user_id.	123
Version	The Pipedrive webhook version that controls the payload schema.	2.0

The Webhook trigger subscribes to Pipedrive events and invokes the integration whenever the chosen object changes.

How It Works

When the integration deploys, this trigger calls the Pipedrive POST /webhooks endpoint and registers a subscription pointed at the flow's webhook URL. When the integration is removed, the corresponding webhook is deleted automatically.

Configuration

Use the Event Action and Event Object inputs to scope the subscription. For example, set Event Action to change and Event Object to deal to receive a payload every time any deal is updated. Use * (All) to subscribe to every action or every object.

Webhook Version

Pipedrive supports two webhook payload versions. Version 2.0 is the default as of March 17th, 2025 and is recommended for new integrations. See the Pipedrive webhooks documentation for payload differences.

HTTP Basic Auth (Optional)

If the endpoint requires HTTP Basic Auth, supply the HTTP Auth User and HTTP Auth Password inputs. Pipedrive will include those credentials on each webhook request.

User Context

By default, the webhook is registered under the user that authorized the OAuth connection. This can be overridden by providing a User ID (typically a top-level admin) so that events are checked against that user's permissions and not the connecting user's.

Example Payload for Webhook⤓

Loading…

Data Sources

Select Activity

Select an Activity from a dropdown menu. | key: selectActivity | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Activity⤓

Loading…

Select Deal

Select a Deal from a dropdown menu. | key: selectDeal | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Deal⤓

Loading…

Select File

Select a file from a dropdown menu. | key: selectFile | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select File⤓

Loading…

Select Filter

Select a Filter from a dropdown menu. | key: selectFilter | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Filter⤓

Loading…

Select Lead

Select a Lead from a dropdown menu. | key: selectLead | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Lead⤓

Loading…

Select Organization

Select an Organization from a dropdown menu. | key: selectOrganization | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Organization⤓

Loading…

Select Person

Select a Person from a dropdown menu. | key: selectPerson | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Person⤓

Loading…

Select Pipeline

Select a Pipeline from a dropdown menu. | key: selectPipeline | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Pipeline⤓

Loading…

Select Product

Select a Product from a dropdown menu. | key: selectProduct | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Product⤓

Loading…

Select Stage

Select a Stage from a dropdown menu. | key: selectStage | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select Stage⤓

Loading…

Select User

Select a User from a dropdown menu. | key: selectUser | type: picklist

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Select User⤓

Loading…

Actions

Add Call Log

Adds a call log. | key: addCallLog

Input	Notes	Example
Activity ID	If specified, the existing activity with this ID is converted into a call log using the information provided.	123
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier of the deal linked to this call.	123
Duration	The length of the call, in seconds.	300
End Time	The date and time when the call ended, in UTC. Format: ISO 8601.	2024-01-15T10:35:00Z
From Phone Number	The phone number that originated the call.	+15551234567
Note	The note attached to the call log, formatted as HTML.	<p>Discussed pricing and next steps.</p>
Org ID	The unique identifier of the organization linked to this call.	123
Outcome	The result of the call attempt.	connected
Person ID	The unique identifier of the person linked to this call.	123
Start Time	The date and time when the call started, in UTC. Format: ISO 8601.	2024-01-15T10:30:00Z
Subject	The name of the activity that the call is attached to.	Discovery call with prospect
To Phone Number	The phone number that received the call.	+15557654321
User ID	The unique identifier of the user who owns the call log.	123

Example Payload for Add Call Log⤓

Loading…

Add Deal

Adds a deal. | key: addDeal

Input	Notes	Example
Additional Fields	Optional deal attributes: value, currency, status, dates, probability, visibility.
Connection	The Pipedrive connection to use.
Org ID	The ID of an organization which this deal will be linked to	123
Person ID	The ID of a person which this deal will be linked to	123
Pipeline ID	The ID of the pipeline this deal will be added to	123
Stage ID	The ID of the stage this deal will be added to	123
Title	The display name shown in the Pipedrive deals pipeline.	Q1 Software License Deal

Example Payload for Add Deal⤓

Loading…

Add Deal Follower

Adds a follower to a deal. | key: addDealFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
User ID	The ID of the user to add as a follower of the deal.	123

Example Payload for Add Deal Follower⤓

Loading…

Add Deal Participant

Adds a participant to a deal. | key: addDealParticipant

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Person ID	The ID of the person to add as a participant in the deal.	123

Example Payload for Add Deal Participant⤓

Loading…

Add Deal Product

Adds a product to the deal, eventually creating a new item called a deal-product. | key: addDealProduct

Input	Notes	Example
Comments	Any textual comment associated with this product-deal attachment.	Annual license, billed monthly
Connection	The Pipedrive connection to use.
Discount Percentage	The discount %.	15
Discount Type	The type of discount
Deal ID	The unique identifier for the deal.	123
Is Enabled	Whether the product is enabled on the deal or not	false
Item Price	The price value of the product.	99.99
Product ID	The ID of the product to add to the deal	123
Product Variation ID	The ID of the product variation to use.	123
Quantity	The quantity of the product.	10
Tax	The tax percentage.	10

Example Payload for Add Deal Product⤓

Loading…

Add File

Uploads and adds a new file to a deal, person, organization, product, activity, or lead. | key: addFile

Input	Notes	Example
Connection	The Pipedrive connection to use.
Entity ID	The numerical ID of the deal, person, org, product or activity, or UUID of the lead to associate this file with.	123
Entity Type	The type of entity to attach the file to
File	The file to upload - either string contents or a binary file
File Name	The name of the file to upload.	contract.pdf

Example Payload for Add File⤓

Loading…

Add Lead

Adds a lead. | key: addLead

Input	Notes	Example
Additional Fields	Optional lead attributes.
Connection	The Pipedrive connection to use.
Label IDs	The IDs of the lead labels which will be associated with the lead.	3cde3b05-035c-ae14-dcfc-172bd8000d08
Organization ID	The ID of an organization which this lead will be linked to.	123
Owner ID	The ID of the user which will be the owner of the created lead.	123
Person ID	The ID of a person which this lead will be linked to.	123
Title	A short descriptive title for the lead.	Enterprise software inquiry

Example Payload for Add Lead⤓

Loading…

Add Lead Label

Adds a lead label. | key: addLeadLabel

Input	Notes	Example
Color	The display color used to identify the label in the Pipedrive UI.	green
Connection	The Pipedrive connection to use.
Name	The display name for the lead label.	Hot

Example Payload for Add Lead Label⤓

Loading…

Add Organization

Adds an organization. | key: addOrganization

Input	Notes	Example
Add Time	The optional creation date & time of the organization in UTC.	2024-01-15T10:30:00Z
Connection	The Pipedrive connection to use.
Name	The display name used to identify the organization in Pipedrive.	Acme Corporation
Owner ID	The ID of the user who will be marked as the owner of this organization	123
Visible To	Controls which users can see this record. 1 = owner only, 3 = owner's group, 5 = owner's group and sub-groups, 7 = entire company.

Example Payload for Add Organization⤓

Loading…

Add Organization Follower

Adds a follower to an organization. | key: addOrganizationFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
User ID	The ID of the user to add as a follower of the organization.	123

Example Payload for Add Organization Follower⤓

Loading…

Add Person

Adds a person. | key: addPerson

Input	Notes	Example
Add Time	The optional creation date & time of the person in UTC.	2024-01-15T10:30:00Z
Connection	The Pipedrive connection to use.
Contact Information	Email, phone, visibility, and marketing preferences.
Name	The full name used to identify this person in Pipedrive.	John Doe
Org ID	The ID of the organization this person will belong to	123
Owner ID	The ID of the user who will be marked as the owner of this person	123

Example Payload for Add Person⤓

Loading…

Add Person Follower

Adds a follower to a person. | key: addPersonFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
User ID	If supplied, only persons owned by the specified user are returned.	123

Example Payload for Add Person Follower⤓

Loading…

Add Pipeline

Adds a new pipeline. | key: addPipeline

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal Probability	Whether deal probability is disabled or enabled for this pipeline	false
Name	A human-readable label that identifies the pipeline.	Sales Pipeline

Example Payload for Add Pipeline⤓

Loading…

Add Product

Adds a product. | key: addProduct

Input	Notes	Example
Code	The product code	PROD-001
Connection	The Pipedrive connection to use.
Name	The name of the product	Professional Software License
Owner ID	The ID of the user who will be marked as the owner of this product	123
Prices	An array of objects, each containing: "currency" (string), "price" (number), "cost" (number, optional), "overhead_cost" (number, optional)	`[ { "product_id": 1, "price": 5, "currency": "EUR", "cost": 2, "direct_cost": 1, "notes": "this is a note" } ]`
Tax	The tax percentage	10
Unit	The unit in which this product is sold	license
Visible To	Controls which users can see this record. 1 = owner only, 3 = owner's group, 5 = owner's group and sub-groups, 7 = entire company.

Example Payload for Add Product⤓

Loading…

Add Product Follower

Adds a follower to a product. | key: addProductFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123
User ID	The ID of the user to add as a follower of the product.	123

Example Payload for Add Product Follower⤓

Loading…

Add Stage

Adds a new stage. | key: addStage

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal Probability	The success probability percentage of the deal.	75
Name	A human-readable label that identifies the stage within a pipeline.	Qualified Lead
Pipeline ID	The ID of the pipeline to add stage to.	123
Rotten Days	The number of days the deals not updated in this stage would become rotten.	30
Rotten Flag	Whether deals in this stage can become rotten	false

Example Payload for Add Stage⤓

Loading…

Create Webhook

Creates a new webhook. | key: createWebhook

Input	Notes	Example
Connection	The Pipedrive connection to use.
Event Action	The type of action that triggers the webhook.	create
Event Object	The Pipedrive resource type that triggers the webhook.	deal
HTTP Auth Password	The password used for HTTP Basic Auth when Pipedrive calls the subscription URL.
HTTP Auth User	The username used for HTTP Basic Auth when Pipedrive calls the subscription URL.	admin
Subscription URL	The URL that Pipedrive will call when a subscribed event occurs.	https://example.com/pipedrive/webhook
User ID	The ID of the user that this webhook will be authorized with. A different user's user_id may be used. If not set, the authenticated user's user_id is used. Each webhook event is checked against the user's permissions, so the webhook is only sent if the user has access to the affected object(s). To receive notifications for all events, use a top-level admin user's user_id.	123
Version	The webhook's version. NB! Webhooks v2 is the default from March 17th, 2025. See this Changelog post for more details.	2.0

Example Payload for Create Webhook⤓

Loading…

Delete Activity

Deletes an activity. | key: deleteActivity

Input	Notes	Example
Connection	The Pipedrive connection to use.
Activity ID	The unique identifier for the activity.	123

Example Payload for Delete Activity⤓

Loading…

Delete Call Log

Deletes a call log. | key: deleteCallLog

Input	Notes	Example
Connection	The Pipedrive connection to use.
Call Log ID	The unique identifier returned when the call log was created.	3cde3b05035cae14dcfc172bd8000d08

Example Payload for Delete Call Log⤓

Loading…

Delete Deal

Deletes a deal. | key: deleteDeal

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123

Example Payload for Delete Deal⤓

Loading…

Delete Deal Field

Deletes a deal field. | key: deleteDealField

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal Field ID	The unique identifier for the deal field.	123

Example Payload for Delete Deal Field⤓

Loading…

Delete Deal Field (V2)

Deletes a deal field. | key: deleteDealFieldV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field Code	The field code of the deal field.	d4de1c1518b4531717c676029a45911c340390a6

Example Payload for Delete Deal Field (V2)⤓

Loading…

Delete Deal Follower

Deletes a follower from a deal. | key: deleteDealFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Follower ID	The ID of the follower relationship to remove from the deal.	123
Deal ID	The unique identifier for the deal.	123

Example Payload for Delete Deal Follower⤓

Loading…

Delete Deal Participant

Deletes a participant from a deal. | key: deleteDealParticipant

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal Participant ID	The ID of the participant of the deal.	123
Deal ID	The unique identifier for the deal.	123

Example Payload for Delete Deal Participant⤓

Loading…

Delete Deal Product

Deletes an attached product from a deal. | key: deleteDealProduct

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Product Attachment ID	The product attachment ID.	123

Example Payload for Delete Deal Product⤓

Loading…

Delete File

Deletes a file. | key: deleteFile

Input	Notes	Example
Connection	The Pipedrive connection to use.
File ID	The unique identifier for the file.	123

Example Payload for Delete File⤓

Loading…

Delete Lead

Deletes a lead. | key: deleteLead

Input	Notes	Example
Connection	The Pipedrive connection to use.
Lead ID	The unique identifier for the lead.	3cde3b05-035c-ae14-dcfc-172bd8000d08

Example Payload for Delete Lead⤓

Loading…

Delete Lead Label

Deletes a lead label. | key: deleteLeadLabel

Input	Notes	Example
Connection	The Pipedrive connection to use.
Lead Label ID	The unique identifier for the lead label.	3cde3b05-035c-ae14-dcfc-172bd8000d08

Example Payload for Delete Lead Label⤓

Loading…

Delete Mail Thread

Deletes a mail thread. | key: deleteMailThread

Input	Notes	Example
Connection	The Pipedrive connection to use.
Mail Thread ID	The unique identifier for the mail thread.	123

Example Payload for Delete Mail Thread⤓

Loading…

Delete Organization

Deletes an organization. | key: deleteOrganization

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123

Example Payload for Delete Organization⤓

Loading…

Delete Organization Follower

Deletes a follower from an organization. | key: deleteOrganizationFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Follower ID	The ID of the follower relationship to remove.	123
Organization ID	The unique identifier for the organization.	123

Example Payload for Delete Organization Follower⤓

Loading…

Delete Person

Deletes a person. | key: deletePerson

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123

Example Payload for Delete Person⤓

Loading…

Delete Person Field

Deletes a person field. | key: deletePersonField

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person Field ID	The unique identifier for the person field.	123

Example Payload for Delete Person Field⤓

Loading…

Delete Person Field (V2)

Deletes a person field. | key: deletePersonFieldV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field Code	The field code of the person field.	d4de1c1518b4531717c676029a45911c340390a6

Example Payload for Delete Person Field (V2)⤓

Loading…

Delete Person Follower

Deletes a follower from a person. | key: deletePersonFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Follower ID	The ID of the follower relationship to remove.	123
Person ID	The unique identifier for the person.	123

Example Payload for Delete Person Follower⤓

Loading…

Delete Person Picture

Deletes a person picture. | key: deletePersonPicture

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123

Example Payload for Delete Person Picture⤓

Loading…

Delete Pipeline

Deletes a pipeline. | key: deletePipeline

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pipeline ID	The unique identifier for the pipeline.	123

Example Payload for Delete Pipeline⤓

Loading…

Delete Product

Deletes a product. | key: deleteProduct

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123

Example Payload for Delete Product⤓

Loading…

Delete Product Field

Deletes a product field. | key: deleteProductField

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product Field ID	The unique identifier for the product field.	123

Example Payload for Delete Product Field⤓

Loading…

Delete Product Field (V2)

Deletes a product field. | key: deleteProductFieldV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field Code	The field code of the product field.	d4de1c1518b4531717c676029a45911c340390a6

Example Payload for Delete Product Field (V2)⤓

Loading…

Delete Product Follower

Deletes a follower from a product. | key: deleteProductFollower

Input	Notes	Example
Connection	The Pipedrive connection to use.
Follower ID	The ID of the relationship between the follower and the product
Product ID	The unique identifier for the product.	123

Example Payload for Delete Product Follower⤓

Loading…

Delete Stage

Deletes a stage. | key: deleteStage

Input	Notes	Example
Connection	The Pipedrive connection to use.
Stage ID	The unique identifier for the stage.	123

Example Payload for Delete Stage⤓

Loading…

Delete Webhook

Deletes a webhook. | key: deleteWebhook

Input	Notes	Example
Connection	The Pipedrive connection to use.
Webhook ID	The unique identifier for the webhook.	123

Example Payload for Delete Webhook⤓

Loading…

Download File

Downloads one file. | key: downloadFile

Input	Notes	Example
Connection	The Pipedrive connection to use.
File ID	The unique identifier for the file.	123

Example Payload for Download File⤓

Loading…

Find Users By Name

Finds users by name. | key: findUsersByName

Input	Notes	Example
Connection	The Pipedrive connection to use.
Search By Email	When set to 1, the term is matched against user email addresses only.	1
Term	The keyword used to match user names or email addresses.	john

Example Payload for Find Users By Name⤓

Loading…

Get Activities

Gets all activities assigned to a particular user. | key: getActivities

Input	Notes	Example
Connection	The Pipedrive connection to use.
Filter ID	The unique identifier of the filter to apply (narrows results when combined with the "user_id" parameter).	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc
Updated Since	If set, only activities with an update_time at or after this timestamp are returned. Format: ISO 8601.	2024-01-01T10:00:00Z
Updated Until	If set, only activities with an update_time at or before this timestamp are returned. Format: ISO 8601.	2024-12-31T23:59:59Z

Example Payload for Get Activities⤓

Loading…

Get Activity

Gets details of an activity. | key: getActivity

Input	Notes	Example
Connection	The Pipedrive connection to use.
Activity ID	The unique identifier for the activity.	123

Example Payload for Get Activity⤓

Loading…

Get Activity Fields

Gets all activity fields. | key: getActivityFields

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Activity Fields⤓

Loading…

Get Activity Fields (V2)

Gets all activity fields. | key: getActivityFieldsV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the requested page is returned.	false
Pagination	Cursor and page-size controls.

Example Payload for Get Activity Fields (V2)⤓

Loading…

Get Activity Types

Gets all activity types. | key: getActivityTypes

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Activity Types⤓

Loading…

Get Call Log

Gets details of a call log. | key: getCallLog

Input	Notes	Example
Connection	The Pipedrive connection to use.
Call Log ID	The unique identifier returned when the call log was created.	3cde3b05035cae14dcfc172bd8000d08

Example Payload for Get Call Log⤓

Loading…

Get Company Addons

Gets all add-ons for a single company. | key: getCompanyAddons

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Company Addons⤓

Loading…

Get Currencies

Gets all supported currencies. | key: getCurrencies

Input	Notes	Example
Connection	The Pipedrive connection to use.
Term	An optional search term matched against the currency's name and/or code.	USD

Example Payload for Get Currencies⤓

Loading…

Get Current User

Gets current user data. | key: getCurrentUser

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Current User⤓

Loading…

Get Deal

Gets details of a deal. | key: getDeal

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123

Example Payload for Get Deal⤓

Loading…

Get Deal Activities

Lists activities associated with a deal. | key: getDealActivities

Input	Notes	Example
Connection	The Pipedrive connection to use.
Done	Whether the activity is done or not	false
Deal ID	The unique identifier for the deal.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Deal Activities⤓

Loading…

Get Deal Field

Gets one deal field. | key: getDealField

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal Field ID	The unique identifier for the deal field.	123

Example Payload for Get Deal Field⤓

Loading…

Get Deal Field (V2)

Gets one deal field. | key: getDealFieldV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field Code	The field code of the deal field.	d4de1c1518b4531717c676029a45911c340390a6

Example Payload for Get Deal Field (V2)⤓

Loading…

Get Deal Fields

Gets all deal fields. | key: getDealFields

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pagination	Offset and page-size controls.

Example Payload for Get Deal Fields⤓

Loading…

Get Deal Fields (V2)

Gets all deal fields. | key: getDealFieldsV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the requested page is returned.	false
Pagination	Cursor and page-size controls.

Example Payload for Get Deal Fields (V2)⤓

Loading…

Get Deal Files

Lists files attached to a deal. | key: getDealFiles

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Include Deleted Files	When enabled, the list of files will also include deleted files
Pagination	Offset, cursor, and page-size controls.
Sort	The field names and sorting mode separated by a comma (e.g. "field_name_1 ASC, field_name_2 DESC").	title ASC, id DESC

Example Payload for Get Deal Files⤓

Loading…

Get Deal Followers

Lists followers of a deal. | key: getDealFollowers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Pagination	Cursor and page-size controls.

Example Payload for Get Deal Followers⤓

Loading…

Get Deal Mail Messages

Lists mail messages associated with a deal. | key: getDealMailMessages

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Pagination	Offset, cursor, and page-size controls.

Example Payload for Get Deal Mail Messages⤓

Loading…

Get Deal Participants

Lists participants of a deal. | key: getDealParticipants

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Pagination	Offset, cursor, and page-size controls.

Example Payload for Get Deal Participants⤓

Loading…

Get Deal Products

Lists products attached to a deal. | key: getDealProducts

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Deal Products⤓

Loading…

Get Deal Users

Lists permitted users for a deal. | key: getDealUsers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123

Example Payload for Get Deal Users⤓

Loading…

Get Deals

Gets all deals. | key: getDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the requested page is returned.	false
Filter ID	The unique identifier of the filter to apply.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc
Stage ID	If supplied, only deals within the specified stage are returned.	123
Status	Filter the response to only include deals matching the selected status.	open

Example Payload for Get Deals⤓

Loading…

Get Deals Summary

Gets a summary of deals. | key: getDealsSummary

Input	Notes	Example
Connection	The Pipedrive connection to use.
Filter ID	The unique identifier of the filter to apply. When set, user_id is not considered.	123
Stage ID	Only deals within the given stage will be returned.	123
Status	Only fetch deals with a specific status
User ID	Only deals matching the given user will be returned.	123

Example Payload for Get Deals Summary⤓

Loading…

Get Deals Timeline

Gets the deals timeline. | key: getDealsTimeline

Input	Notes	Example
Amount	The number of given intervals, starting from "start_date", to fetch	12
Connection	The Pipedrive connection to use.
Exclude Deals	Whether to exclude deals list (1) or not (0)
Field Key	The date field key which deals will be retrieved from	close_time
Filter ID	If supplied, only deals matching the given filter will be returned.	123
Interval	The type of the interval
Pipeline ID	If supplied, only deals matching the given pipeline will be returned.	123
Start Date	The date when the first interval starts	2024-01-01
Totals Convert Currency	The 3-letter currency code of any of the supported currencies.	USD
User ID	If supplied, only deals matching the given user will be returned.	123

Example Payload for Get Deals Timeline⤓

Loading…

Get File Metadata by ID

Gets metadata about one file by ID. | key: getFile

Input	Notes	Example
Connection	The Pipedrive connection to use.
File ID	The unique identifier for the file.	123

Example Payload for Get File Metadata by ID⤓

Loading…

Get Filter

Gets one filter. | key: getFilter

Input	Notes	Example
Connection	The Pipedrive connection to use.
Filter ID	The unique identifier for the filter.	123

Example Payload for Get Filter⤓

Loading…

Get Filters

Gets all filters. | key: getFilters

Input	Notes	Example
Connection	The Pipedrive connection to use.
Type	The resource type whose filters should be returned.	deals

Example Payload for Get Filters⤓

Loading…

Get Lead

Gets one lead. | key: getLead

Input	Notes	Example
Connection	The Pipedrive connection to use.
Lead ID	The unique identifier for the lead.	3cde3b05-035c-ae14-dcfc-172bd8000d08

Example Payload for Get Lead⤓

Loading…

Get Lead Labels

Gets all lead labels. | key: getLeadLabels

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Lead Labels⤓

Loading…

Get Lead Sources

Gets all lead sources. | key: getLeadSources

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Lead Sources⤓

Loading…

Get Leads

Gets all leads. | key: getLeads

Input	Notes	Example
Archived Status	Filtering based on the archived status of a lead
Connection	The Pipedrive connection to use.
Filter ID	The unique identifier of the filter to apply to narrow results.	1
Owner ID	If supplied, only leads matching the given user will be returned.	1
Pagination	Offset and page-size controls.
Sort	The field names and sorting mode separated by a comma (e.g. "field_name_1 ASC, field_name_2 DESC").	title ASC, id DESC

Example Payload for Get Leads⤓

Loading…

Get Mail Message

Gets one mail message. | key: getMailMessage

Input	Notes	Example
Connection	The Pipedrive connection to use.
Mail Message ID	The unique identifier of the mail message to retrieve.	123
Include Body	When set to 1, the full message body is included in the response.	1

Example Payload for Get Mail Message⤓

Loading…

Get Mail Thread

Gets one mail thread. | key: getMailThread

Input	Notes	Example
Connection	The Pipedrive connection to use.
Mail Thread ID	The unique identifier for the mail thread.	123

Example Payload for Get Mail Thread⤓

Loading…

Get Mail Thread Messages

Gets all mail messages of a mail thread. | key: getMailThreadMessages

Input	Notes	Example
Connection	The Pipedrive connection to use.
Mail Thread ID	The unique identifier for the mail thread.	123

Example Payload for Get Mail Thread Messages⤓

Loading…

Get Mail Threads

Gets mail threads. | key: getMailThreads

Input	Notes	Example
Connection	The Pipedrive connection to use.
Folder	The mailbox folder whose threads should be returned.	inbox
Pagination	Offset and page-size controls.

Example Payload for Get Mail Threads⤓

Loading…

Get Note Fields

Gets all note fields. | key: getNoteFields

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Note Fields⤓

Loading…

Get Organization

Gets details of an organization. | key: getOrganization

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123

Example Payload for Get Organization⤓

Loading…

Get Organization Activities

Lists activities associated with an organization. | key: getOrganizationActivities

Input	Notes	Example
Connection	The Pipedrive connection to use.
Done	When true, returns only completed activities	false
Organization ID	The unique identifier for the organization.	123
Pagination	Cursor and page-size controls.

Example Payload for Get Organization Activities⤓

Loading…

Get Organization Deals

Lists deals associated with an organization. | key: getOrganizationDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc
Status	Only fetch deals with a specific status

Example Payload for Get Organization Deals⤓

Loading…

Get Organization Files

Lists files attached to an organization. | key: getOrganizationFiles

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Include Deleted Files	When enabled, the list of files will also include deleted files
Pagination	Offset and page-size controls.
Sort	The field names and sorting mode separated by a comma (e.g. "field_name_1 ASC, field_name_2 DESC").	title ASC, id DESC

Example Payload for Get Organization Files⤓

Loading…

Get Organization Followers

Lists followers of an organization. | key: getOrganizationFollowers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Pagination	Cursor and page-size controls.

Example Payload for Get Organization Followers⤓

Loading…

Get Organization Mail Messages

Lists mail messages associated with an organization. | key: getOrganizationMailMessages

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Pagination	Offset and page-size controls.

Example Payload for Get Organization Mail Messages⤓

Loading…

Get Organization Persons

Lists persons of an organization. | key: getOrganizationPersons

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Pagination	Cursor and page-size controls.

Example Payload for Get Organization Persons⤓

Loading…

Get Organization Updates

Lists updates about an organization. | key: getOrganizationUpdates

Input	Notes	Example
All Changes	Whether to show custom field updates or not.	1
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Items	A comma-separated string for filtering out item specific updates.	deal,activity
Pagination	Offset and page-size controls.

Example Payload for Get Organization Updates⤓

Loading…

Get Organization Users

Lists permitted users for an organization. | key: getOrganizationUsers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123

Example Payload for Get Organization Users⤓

Loading…

Get Organizations

Gets all organizations. | key: getOrganizations

Input	Notes	Example
Connection	The Pipedrive connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the requested page is returned.	false
Filter ID	The unique identifier of the filter to apply.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Organizations⤓

Loading…

Get Permission Set

Gets one permission set. | key: getPermissionSet

Input	Notes	Example
Connection	The Pipedrive connection to use.
Permission Set ID	The unique identifier for the permission set.	123

Example Payload for Get Permission Set⤓

Loading…

Get Permission Set Assignments

Lists permission set assignments. | key: getPermissionSetAssignments

Input	Notes	Example
Connection	The Pipedrive connection to use.
Permission Set ID	The unique identifier for the permission set.	123
Pagination	Offset and page-size controls.

Example Payload for Get Permission Set Assignments⤓

Loading…

Get Permission Sets

Gets all permission sets. | key: getPermissionSets

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Permission Sets⤓

Loading…

Get Person

Gets details of a person. | key: getPerson

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123

Example Payload for Get Person⤓

Loading…

Get Person Activities

Lists activities associated with a person. | key: getPersonActivities

Input	Notes	Example
Connection	The Pipedrive connection to use.
Done	When true, returns only completed activities	false
Person ID	The unique identifier for the person.	123
Pagination	Cursor and page-size controls.

Example Payload for Get Person Activities⤓

Loading…

Get Person Deals

Lists deals associated with a person. | key: getPersonDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc
Status	Only fetch deals with a specific status

Example Payload for Get Person Deals⤓

Loading…

Get Person Field

Gets one person field. | key: getPersonField

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person Field ID	The unique identifier for the person field.	123

Example Payload for Get Person Field⤓

Loading…

Get Person Field (V2)

Gets one person field. | key: getPersonFieldV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field Code	The field code of the person field.	d4de1c1518b4531717c676029a45911c340390a6

Example Payload for Get Person Field (V2)⤓

Loading…

Get Person Field Details

Gets details of a specific field for a person. | key: getPersonFieldDetails

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field ID	The unique identifier of the person field to retrieve details for.	123

Example Payload for Get Person Field Details⤓

Loading…

Get Person Fields

Gets all person fields. | key: getPersonFields

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pagination	Offset and page-size controls.

Example Payload for Get Person Fields⤓

Loading…

Get Person Fields (V2)

Gets all person fields. | key: getPersonFieldsV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the requested page is returned.	false
Pagination	Cursor and page-size controls.

Example Payload for Get Person Fields (V2)⤓

Loading…

Get Person Files

Lists files attached to a person. | key: getPersonFiles

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
Include Deleted Files	When enabled, the list of files will also include deleted files
Pagination	Offset and page-size controls.
Sort	The field names and sorting mode separated by a comma (e.g. "field_name_1 ASC, field_name_2 DESC").	title ASC, id DESC

Example Payload for Get Person Files⤓

Loading…

Get Person Followers

Lists followers of a person. | key: getPersonFollowers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
Pagination	Cursor and page-size controls.

Example Payload for Get Person Followers⤓

Loading…

Get Person Mail Messages

Lists mail messages associated with a person. | key: getPersonMailMessages

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
Pagination	Offset and page-size controls.

Example Payload for Get Person Mail Messages⤓

Loading…

Get Person Products

Lists products associated with a person. | key: getPersonProducts

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
Pagination	Offset and page-size controls.

Example Payload for Get Person Products⤓

Loading…

Get Person Updates

Lists updates about a person. | key: getPersonUpdates

Input	Notes	Example
All Changes	Whether to show custom field updates or not.	1
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
Items	A comma-separated string for filtering out item specific updates.	deal,activity
Pagination	Offset and page-size controls.

Example Payload for Get Person Updates⤓

Loading…

Get Person Users

Lists permitted users for a person. | key: getPersonUsers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123

Example Payload for Get Person Users⤓

Loading…

Get Persons

Gets all persons. | key: getPersons

Input	Notes	Example
Connection	The Pipedrive connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the requested page is returned.	false
Filter ID	The unique identifier of the filter to apply.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Persons⤓

Loading…

Get Pipeline

Gets one pipeline. | key: getPipeline

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pipeline ID	The unique identifier for the pipeline.	123
Totals Convert Currency	The 3-letter currency code of any of the supported currencies.	USD

Example Payload for Get Pipeline⤓

Loading…

Get Pipeline Conversion Statistics

Gets deal conversion rates in a pipeline. | key: getPipelineConversionStatistics

Input	Notes	Example
Connection	The Pipedrive connection to use.
End Date	The end of the period.	2024-12-31
Pipeline ID	The unique identifier for the pipeline.	123
Start Date	The start of the period.	2024-01-01
User ID	The ID of the user whose pipeline metrics statistics to fetch.	123

Example Payload for Get Pipeline Conversion Statistics⤓

Loading…

Get Pipeline Deals

Gets deals in a pipeline. | key: getPipelineDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Filter ID	If supplied, only deals matching the given filter will be returned.	123
Pipeline ID	The unique identifier for the pipeline.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc
Stage ID	If supplied, only deals within the given stage will be returned.	123

Example Payload for Get Pipeline Deals⤓

Loading…

Get Pipeline Movement Statistics

Gets deal movements in a pipeline. | key: getPipelineMovementStatistics

Input	Notes	Example
Connection	The Pipedrive connection to use.
End Date	The end of the period.	2024-12-31
Pipeline ID	The unique identifier for the pipeline.	123
Start Date	The start of the period.	2024-01-01
User ID	The ID of the user whose pipeline movement statistics to fetch.	123

Example Payload for Get Pipeline Movement Statistics⤓

Loading…

Get Pipelines

Gets all pipelines. | key: getPipelines

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Pipelines⤓

Loading…

Get Product

Gets one product. | key: getProduct

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123

Example Payload for Get Product⤓

Loading…

Get Product Deals

Gets deals that a product is attached to. | key: getProductDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123
Pagination	Offset and page-size controls.
Status	Only fetch deals with a specific status

Example Payload for Get Product Deals⤓

Loading…

Get Product Field

Gets one product field. | key: getProductField

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product Field ID	The unique identifier for the product field.	123

Example Payload for Get Product Field⤓

Loading…

Get Product Field (V2)

Gets one product field. | key: getProductFieldV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field Code	The field code of the product field.	d4de1c1518b4531717c676029a45911c340390a6

Example Payload for Get Product Field (V2)⤓

Loading…

Get Product Fields

Gets all product fields. | key: getProductFields

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pagination	Offset and page-size controls.

Example Payload for Get Product Fields⤓

Loading…

Get Product Fields (V2)

Gets all product fields. | key: getProductFieldsV2

Input	Notes	Example
Connection	The Pipedrive connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the requested page is returned.	false
Pagination	Cursor and page-size controls.

Example Payload for Get Product Fields (V2)⤓

Loading…

Get Product Files

Lists files attached to a product. | key: getProductFiles

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123
Include Deleted Files	When enabled, the list of files will also include deleted files
Pagination	Offset and page-size controls.
Sort	The field names and sorting mode separated by a comma (e.g. "field_name_1 ASC, field_name_2 DESC").	title ASC, id DESC

Example Payload for Get Product Files⤓

Loading…

Get Product Followers

Lists followers of a product. | key: getProductFollowers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123
Pagination	Cursor and page-size controls.

Example Payload for Get Product Followers⤓

Loading…

Get Product Users

Lists permitted users for a product. | key: getProductUsers

Input	Notes	Example
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123

Example Payload for Get Product Users⤓

Loading…

Get Products

Gets all products. | key: getProducts

Input	Notes	Example
Connection	The Pipedrive connection to use.
Filter ID	The unique identifier of the filter to apply to narrow results.	123
Ids	An array of integers with the IDs of the products that should be returned in the response	123,456,789
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Products⤓

Loading…

Get Stage

Gets one stage. | key: getStage

Input	Notes	Example
Connection	The Pipedrive connection to use.
Stage ID	The unique identifier for the stage.	123

Example Payload for Get Stage⤓

Loading…

Get Stage Deals

Gets deals in a stage. | key: getStageDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Filter ID	If supplied, only deals matching the given filter will be returned.	123
Stage ID	The unique identifier for the stage.	123
Pagination	Cursor and page-size controls.
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Stage Deals⤓

Loading…

Get Stages

Gets all stages. | key: getStages

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pagination	Cursor and page-size controls.
Pipeline ID	The ID of the pipeline to fetch stages for.	123
Sort By	The field name used to order the results.	title
Sort Direction	The direction in which results are ordered.	asc

Example Payload for Get Stages⤓

Loading…

Get User

Gets one user by ID. | key: getUser

Input	Notes	Example
Connection	The Pipedrive connection to use.
User ID	The unique identifier for the user.	123

Example Payload for Get User⤓

Loading…

Get User Call Logs

Gets all call logs assigned to a particular user. | key: getUserCallLogs

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pagination	Offset and page-size controls.

Example Payload for Get User Call Logs⤓

Loading…

Get User Connections

Gets all user connections. | key: getUserConnections

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get User Connections⤓

Loading…

Get User Followers

Lists followers of a user. | key: getUserFollowers

Input	Notes	Example
Connection	The Pipedrive connection to use.
User ID	The unique identifier for the user.	123
Pagination	Cursor and page-size controls.

Example Payload for Get User Followers⤓

Loading…

Get User Permissions

Lists user permissions. | key: getUserPermissions

Input	Notes	Example
Connection	The Pipedrive connection to use.
User ID	The unique identifier for the user.	123

Example Payload for Get User Permissions⤓

Loading…

Get User Role Assignments

Lists user role assignments. | key: getUserRoleAssignments

Input	Notes	Example
Connection	The Pipedrive connection to use.
User ID	The unique identifier for the user.	123
Pagination	Offset and page-size controls.

Example Payload for Get User Role Assignments⤓

Loading…

Get User Role Settings

Lists user role settings. | key: getUserRoleSettings

Input	Notes	Example
Connection	The Pipedrive connection to use.
User ID	The unique identifier for the user.	123

Example Payload for Get User Role Settings⤓

Loading…

Get User Settings

Lists settings of an authorized user. | key: getUserSettings

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get User Settings⤓

Loading…

Get Users

Gets all users. | key: getUsers

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for Get Users⤓

Loading…

List Files

Lists all files attached to all entities. | key: getFiles

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pagination	Offset and page-size controls.

Example Payload for List Files⤓

Loading…

List Webhooks

Lists all webhooks. | key: listWebhooks

Input	Notes	Example
Connection	The Pipedrive connection to use.

Example Payload for List Webhooks⤓

Loading…

Merge Deals

Merges two deals. | key: mergeDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Merge With ID	The ID of the deal that the deal will be merged with.	456

Example Payload for Merge Deals⤓

Loading…

Merge Organizations

Merges two organizations. | key: mergeOrganizations

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Merge With ID	The ID of the organization that the organization will be merged with.	456

Example Payload for Merge Organizations⤓

Loading…

Merge Persons

Merges two persons. | key: mergePersons

Input	Notes	Example
Connection	The Pipedrive connection to use.
Person ID	The unique identifier for the person.	123
Merge With ID	The ID of the person that will not be overwritten.	456

Example Payload for Merge Persons⤓

Loading…

Raw Request

Sends a raw HTTP request to Pipedrive. | key: rawRequest

Input	Notes	Example
Connection	The Pipedrive connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/files), The base URL is already included (https://api.pipedrive.com). For example, to connect to https://api.pipedrive.com/files, only /files is entered in this field.	/files
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false
API Version	The Pipedrive REST API version used for the request.	v1

Search Deals

Searches deals. | key: searchDeals

Input	Notes	Example
Connection	The Pipedrive connection to use.
Exact Match	When true, only full exact matches against the given term are returned	false
Fields	The deal properties to search in. Provide as a comma-separated list (e.g. custom_fields, notes, title).	custom_fields,notes,title
Include Fields	Supports including optional fields in the results which are not provided by default
Organization ID	Will filter deals by the provided organization ID	123
Pagination	Cursor and page-size controls.
Person ID	Will filter deals by the provided person ID	123
Status	Will filter deals by the provided specific status
Term	The keyword or phrase to match against deal fields.	Software License

Example Payload for Search Deals⤓

Loading…

Search Leads

Searches leads. | key: searchLeads

Input	Notes	Example
Connection	The Pipedrive connection to use.
Exact Match	When enabled, only full exact matches against the given term are returned	false
Fields	The lead properties to search in.
Include Fields	Supports including optional fields in the results which are not provided by default
Organization ID	Will filter leads by the provided organization ID.	123
Pagination	Cursor and page-size controls.
Person ID	Will filter leads by the provided person ID.	123
Term	The keyword or phrase to match against lead fields.	Enterprise software

Example Payload for Search Leads⤓

Loading…

Search Organization

Searches organizations. | key: searchOrganization

Input	Notes	Example
Connection	The Pipedrive connection to use.
Exact Match	When true, only full exact matches against the given term are returned	false
Fields	The organization properties to search in. Provide as a comma-separated list (e.g. address, custom_fields, notes, name).	address,custom_fields,notes,name
Pagination	Cursor and page-size controls.
Term	The keyword or phrase to match against organization fields.	Acme Corporation

Example Payload for Search Organization⤓

Loading…

Search Persons

Searches persons. | key: searchPersons

Input	Notes	Example
Connection	The Pipedrive connection to use.
Exact Match	When true, only full exact matches against the given term are returned	false
Fields	The person properties to search in. Provide as a comma-separated list (e.g. custom_fields, email, notes, phone, name).	custom_fields,email,notes,phone,name
Include Fields	Supports including optional fields in the results which are not provided by default
Organization ID	Will filter persons by the provided organization ID	123
Pagination	Cursor and page-size controls.
Term	The keyword or phrase to match against person fields.	John Doe

Example Payload for Search Persons⤓

Loading…

Set Person Field Value

Sets the value of a specific field for a person. | key: setFieldValueForPerson

Input	Notes	Example
Connection	The Pipedrive connection to use.
Field Key	The internal key of the custom field to update.	abc123def456
Person ID	The unique identifier of the person whose field value is being updated.	123
Value	The value to assign to the custom field.	New value

Example Payload for Set Person Field Value⤓

Loading…

Update Deal

Updates a deal. | key: updateDeal

Input	Notes	Example
Additional Fields	Optional deal attributes.
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Org ID	The ID of an organization which this deal will be linked to	123
Person ID	The ID of a person which this deal will be linked to	123
Pipeline ID	The ID of the pipeline this deal will be added to	123
Stage ID	The ID of the stage this deal will be added to	123

Example Payload for Update Deal⤓

Loading…

Update Deal Product

Updates product attachment details of the deal-product (a product already attached to a deal). | key: updateDealProduct

Input	Notes	Example
Additional Fields	Optional deal product attributes.
Connection	The Pipedrive connection to use.
Deal ID	The unique identifier for the deal.	123
Product Attachment ID	The ID of the deal-product (the ID of the product attached to the deal).	123
Product Variation ID	The ID of the product variation to use.	123

Example Payload for Update Deal Product⤓

Loading…

Update File

Updates the file name or description. | key: updateFile

Input	Notes	Example
Connection	The Pipedrive connection to use.
Description	A text description of the file.	Signed contract for Q1 deal
File ID	The unique identifier for the file.	123
File Name	The new name for the file.	updated-contract.pdf

Example Payload for Update File⤓

Loading…

Update Filter

Updates a filter. | key: updateFilter

Input	Notes	Example
Conditions	The filter conditions, expressed as a JSON object string. Format: JSON.	{"glue":"and","conditions":[]}
Connection	The Pipedrive connection to use.
Filter ID	The unique identifier for the filter.	123
Name	A human-readable label that identifies the filter.	Open Deals

Example Payload for Update Filter⤓

Loading…

Update Lead

Updates a lead. | key: updateLead

Input	Notes	Example
Additional Fields	Optional lead attributes.
Connection	The Pipedrive connection to use.
Lead ID	The unique identifier for the lead.	3cde3b05-035c-ae14-dcfc-172bd8000d08
Label IDs	The IDs of the lead labels which will be associated with the lead.	3cde3b05-035c-ae14-dcfc-172bd8000d08
Organization ID	The ID of an organization which this lead will be linked to.	123
Owner ID	The ID of the user which will be the owner of the created lead.	123
Person ID	The ID of a person which this lead will be linked to.	123
Title	A short descriptive title for the lead.	Enterprise software inquiry

Example Payload for Update Lead⤓

Loading…

Update Lead Label

Updates a lead label. | key: updateLeadLabel

Input	Notes	Example
Color	The display color used to identify the label in the Pipedrive UI.	green
Connection	The Pipedrive connection to use.
Lead Label ID	The unique identifier for the lead label.	3cde3b05-035c-ae14-dcfc-172bd8000d08
Name	The display name for the lead label.	Hot

Example Payload for Update Lead Label⤓

Loading…

Update Organization

Updates an organization. | key: updateOrganization

Input	Notes	Example
Connection	The Pipedrive connection to use.
Organization ID	The unique identifier for the organization.	123
Name	The display name used to identify the organization in Pipedrive.	Acme Corporation
Owner ID	The ID of the user who will be marked as the owner of this organization	123
Visible To	Controls which users can see this record. 1 = owner only, 3 = owner's group, 5 = owner's group and sub-groups, 7 = entire company.

Example Payload for Update Organization⤓

Loading…

Update Person

Updates a person. | key: updatePerson

Input	Notes	Example
Connection	The Pipedrive connection to use.
Contact Information	Email, phone, visibility, and marketing preferences.
Person ID	The unique identifier for the person.	123
Name	The full name used to identify this person in Pipedrive.	John Doe
Org ID	The ID of the organization this person will belong to	123
Owner ID	The ID of the user who will be marked as the owner of this person	123

Example Payload for Update Person⤓

Loading…

Update Pipeline

Updates a pipeline. | key: updatePipeline

Input	Notes	Example
Connection	The Pipedrive connection to use.
Pipeline ID	The unique identifier for the pipeline.	123
Deal Probability	Whether deal probability is disabled or enabled for this pipeline	false
Name	A human-readable label that identifies the pipeline.	Sales Pipeline

Example Payload for Update Pipeline⤓

Loading…

Update Product

Updates a product. | key: updateProduct

Input	Notes	Example
Code	The product code	PROD-001
Connection	The Pipedrive connection to use.
Product ID	The unique identifier for the product.	123
Name	The name of the product	Professional Software License
Owner ID	The ID of the user who will be marked as the owner of this product	123
Prices	An array of objects, each containing: "currency" (string), "price" (number), "cost" (number, optional), "overhead_cost" (number, optional)	`[ { "product_id": 1, "price": 5, "currency": "EUR", "cost": 2, "direct_cost": 1, "notes": "this is a note" } ]`
Tax	The tax percentage	10
Unit	The unit in which this product is sold	license
Visible To	Controls which users can see this record. 1 = owner only, 3 = owner's group, 5 = owner's group and sub-groups, 7 = entire company.

Example Payload for Update Product⤓

Loading…

Update Stage

Updates stage details. | key: updateStage

Input	Notes	Example
Connection	The Pipedrive connection to use.
Deal Probability	The success probability percentage of the deal.	75
Stage ID	The unique identifier for the stage.	123
Name	A human-readable label that identifies the stage within a pipeline.	Qualified Lead
Pipeline ID	The ID of the pipeline to add stage to.	123
Rotten Days	The number of days the deals not updated in this stage would become rotten.	30
Rotten Flag	Whether deals in this stage can become rotten	false

Example Payload for Update Stage⤓

Loading…

Changelog

2026-10-12

List and search actions group their page-size, offset, and cursor inputs into Pagination; Fetch All stays a top-level toggle where applicable
Add Deal, Update Deal, Add Lead, and Update Lead actions group optional attributes into Additional Fields
Update Deal Product groups optional product attributes into Additional Fields
Add Person and Update Person actions group contact details into Contact Information
Added opt-in batching to the New and Updated Records trigger, dispatching each changed record individually or in configured batches; enabling it changes the shape a downstream step receives
Added an optional Look-back Date input for performing an initial sync of records; the backfill begins on the first recurrence, seeds each record once, and ignores the trigger's visibility filters
Added inline action calling support to 50 actions for improved example output during configuration
Added output schemas to 157 actions for improved field mapping during configuration

2026-09-14

Removed the Cancel Recurring Subscription (Deprecated), Delete Subscription (Deprecated), Find Subscription By Deal (Deprecated), Get Subscription (Deprecated), Get Subscription Payments (Deprecated), and Get Deal Persons (Deprecated) actions that are no longer in use. No subscription actions remain on the component

2026-07-29

Added 10 new V2 actions for the Pipedrive Fields API v2 endpoints. V2 actions use cursor-based pagination with Fetch All support and identify fields by Field Code (string key) instead of numeric ID. Existing v1 actions are preserved for backwards compatibility.

Deal fields: Get Deal Fields (V2), Get Deal Field (V2), Delete Deal Field (V2)
Person fields: Get Person Fields (V2), Get Person Field (V2), Delete Person Field (V2)
Product fields: Get Product Fields (V2), Get Product Field (V2), Delete Product Field (V2)
Activity fields: Get Activity Fields (V2)

2026-07-27

Updated list of Event Objects for webhook configuration

2026-05-26

Added New and Updated Records polling trigger powered by the GET /v1/recents endpoint. The trigger monitors a single Pipedrive item type (Deals, Persons, Activities, Organizations, etc.) and separates results into created and updated buckets so integrations can branch on the type of change
Relabeled Webhook trigger label (previously "Webhook Trigger") for consistency

2026-04-30

Various modernizations and documentation updates

2026-03-31

Removed Channels API actions (Add Channel, Delete Channel, Delete Conversation) — Pipedrive removed the Channels API on February 1, 2026

2026-03-16

Various modernizations and documentation updates

2026-03-13

Removed the Debug Request input from all action inputs. Debug logging is now controlled internally and no longer appears as a configurable field in actions.

2026-03-05

Added inline data source for files to enable dynamic dropdown selection

2026-02-26

Added inline data sources for users, products, stages, pipelines, leads, activities, and filters to enable dynamic dropdown selection

2025-10-17

Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup

Pipedrive Connector

Description​

API Documentation​

Connections​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Pipedrive Custom Redirect URIs​

Triggers​

New and Updated Records​

How It Works​

Returned Data​

When to Use Polling vs. Webhooks​

Webhook​

How It Works​

Configuration​

Webhook Version​

HTTP Basic Auth (Optional)​

User Context​

Data Sources​

Select Activity​

Select Deal​

Select File​

Select Filter​

Select Lead​

Select Organization​

Select Person​

Select Pipeline​

Select Product​

Select Stage​

Select User​

Actions​

Add Call Log​

Add Deal​

Add Deal Follower​

Add Deal Participant​

Add Deal Product​

Add File​

Add Lead​

Add Lead Label​

Add Organization​

Add Organization Follower​

Add Person​

Add Person Follower​

Add Pipeline​

Add Product​

Add Product Follower​

Add Stage​

Create Webhook​

Delete Activity​

Delete Call Log​

Delete Deal​

Delete Deal Field​

Delete Deal Field (V2)​

Delete Deal Follower​

Delete Deal Participant​

Delete Deal Product​

Delete File​

Delete Lead​

Delete Lead Label​

Delete Mail Thread​

Delete Organization​

Delete Organization Follower​

Delete Person​

Delete Person Field​

Delete Person Field (V2)​

Delete Person Follower​

Delete Person Picture​

Delete Pipeline​

Delete Product​

Delete Product Field​

Delete Product Field (V2)​

Delete Product Follower​

Delete Stage​

Delete Webhook​

Download File​

Find Users By Name​

Get Activities​

Get Activity​

Description

API Documentation

Connections

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Pipedrive Custom Redirect URIs

Triggers

New and Updated Records

How It Works

Returned Data

When to Use Polling vs. Webhooks

Webhook

How It Works

Configuration

Webhook Version

HTTP Basic Auth (Optional)

User Context

Data Sources

Select Activity

Select Deal

Select File

Select Filter

Select Lead

Select Organization

Select Person

Select Pipeline

Select Product

Select Stage

Select User

Actions

Add Call Log

Add Deal

Add Deal Follower

Add Deal Participant

Add Deal Product

Add File

Add Lead

Add Lead Label

Add Organization

Add Organization Follower

Add Person

Add Person Follower

Add Pipeline

Add Product

Add Product Follower

Add Stage

Create Webhook

Delete Activity

Delete Call Log

Delete Deal

Delete Deal Field

Delete Deal Field (V2)

Delete Deal Follower

Delete Deal Participant

Delete Deal Product

Delete File

Delete Lead

Delete Lead Label

Delete Mail Thread

Delete Organization

Delete Organization Follower

Delete Person

Delete Person Field

Delete Person Field (V2)

Delete Person Follower

Delete Person Picture

Delete Pipeline

Delete Product

Delete Product Field

Delete Product Field (V2)

Delete Product Follower

Delete Stage

Delete Webhook

Download File

Find Users By Name

Get Activities

Get Activity

Get Activity Fields