![pipedrive icon](/docs/img/components/icons/60/cGlwZWRyaXZl.png) # Pipedrive Connector key: pipedrive[Source](https://github.com/prismatic-io/components/tree/main/components/pipedrive)[API Docs](https://developers.pipedrive.com/docs/api/v1/Deals)[API Changelog](https://developers.pipedrive.com/changelog)[Connector Changelog](#changelog) ## Description[​](#description "Direct link to Description") [Pipedrive](https://www.pipedrive.com/) is a sales-focused customer relationship management tool. This component enables management of leads, companies, activities, and more. #### API Documentation[​](#api-documentation "Direct link to API Documentation") * [Pipedrive API Reference](https://developers.pipedrive.com/docs/api/v1) * [Pipedrive Webhooks Documentation](https://developers.pipedrive.com/docs/api/v1/Webhooks) * [Marketplace Scopes and Permissions](https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations) ## Connections[​](#connections "Direct link to Connections") ### OAuth 2.0[​](#oauth2 "Direct link to OAuth 2.0") **key: oauth2** Create a connection of type **OAuth 2.0** to authenticate against the Pipedrive API. #### Prerequisites[​](#prerequisites "Direct link to Prerequisites") * A Pipedrive sandbox account. Sign up via the [Pipedrive Developers Corner](https://developers.pipedrive.com/). * Access to the Pipedrive [Developer Hub](https://app.pipedrive.com/developer-hub) to create and manage OAuth apps. #### Setup Steps[​](#setup-steps "Direct link to Setup Steps") 1. Navigate to the [Pipedrive Developer Hub](https://app.pipedrive.com/developer-hub). 2. **Click** **Create an App** and **Select** **Public app**. 3. Fill in the minimal required fields. Be sure to include the OAuth 2.0 **Callback URL**: `https://oauth2.prismatic.io/callback` 4. Update the **Access scopes** to grant the app access to the necessary types of data. Reference the [Marketplace scopes and permissions explanations](https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations) for information on what permissions the integration might need. 5. **Click** **Save**. 6. 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[​](#configure-the-connection "Direct link to 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[​](#pipedrive-custom-redirect-uris "Direct link to 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](https://pipedrive.readme.io/docs/app-installation-flows). 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 Pipedrive Settings > Marketplace > Your Apps. | 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[​](#triggers "Direct link to Triggers") ### New and Updated Records[​](#pollchangestrigger "Direct link to 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. | | | 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[​](#how-it-works "Direct link to How It Works") On each scheduled execution, the trigger: 1. 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. 2. 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. 3. 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`. 4. Persists the current execution time as the new last-poll timestamp for the next run. 5. Emits the partitioned results in the trigger payload, filtered by the **Show New Records** and **Show Updated Records** toggles. #### Returned Data[​](#returned-data "Direct link to 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 ```json { "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[​](#when-to-use-polling-vs-webhooks "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/triggers/pollChangesTrigger.json "Download example payload") Loading… *** ### Webhook[​](#pipedrivetrigger "Direct link to 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[​](#how-it-works-1 "Direct link to 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[​](#configuration "Direct link to 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[​](#webhook-version "Direct link to 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](https://developers.pipedrive.com/docs/api/v1/Webhooks) for payload differences. #### HTTP Basic Auth (Optional)[​](#http-basic-auth-optional "Direct link to 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[​](#user-context "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/triggers/pipedriveTrigger.json "Download example payload") Loading… *** ## Data Sources[​](#data-sources "Direct link to Data Sources") ### Select Activity[​](#selectactivity "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectActivity.json "Download example payload") Loading… *** ### Select Deal[​](#selectdeal "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectDeal.json "Download example payload") Loading… *** ### Select File[​](#selectfile "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectFile.json "Download example payload") Loading… *** ### Select Filter[​](#selectfilter "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectFilter.json "Download example payload") Loading… *** ### Select Lead[​](#selectlead "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectLead.json "Download example payload") Loading… *** ### Select Organization[​](#selectorganization "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectOrganization.json "Download example payload") Loading… *** ### Select Person[​](#selectperson "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectPerson.json "Download example payload") Loading… *** ### Select Pipeline[​](#selectpipeline "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectPipeline.json "Download example payload") Loading… *** ### Select Product[​](#selectproduct "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectProduct.json "Download example payload") Loading… *** ### Select Stage[​](#selectstage "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectStage.json "Download example payload") Loading… *** ### Select User[​](#selectuser "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/data-sources/selectUser.json "Download example payload") Loading… *** ## Actions[​](#actions "Direct link to Actions") ### Add Call Log[​](#addcalllog "Direct link to Add Call Log") Adds a call log. | **key: addCallLog** | Input | Notes | Example | | ----------------- | -------------------------------------------------------------------------------------------- | ------- | | Activity ID | If specified, this activity will be converted into a call log, with the information provided | | | Connection | The Pipedrive connection to use. | | | Deal ID | The ID of the deal this call is associated with | | | Duration | The duration of the call in seconds | | | End Time | The date and time of the end of the call in UTC | | | From Phone Number | The number that made the call | | | Note | The note for the call log in HTML format | | | Org ID | The ID of the organization this call is associated with | | | Outcome | Describes the outcome of the call | | | Person ID | The ID of the person this call is associated with | | | Start Time | The date and time of the start of the call in UTC | | | Subject | The name of the activity this call is attached to | | | To Phone Number | The number called | | | User ID | The ID of the owner of the call log | | *** ### Add Deal[​](#adddeal "Direct link to Add Deal") Adds a deal. | **key: addDeal** | Input | Notes | Example | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Add Time | The optional creation date & time of the deal in UTC | 2024-01-15T10:30:00Z | | Connection | The Pipedrive connection to use. | | | Currency | The currency of the deal | USD | | Expected Close Date | The expected close date of the deal | 2024-12-31 | | Lost Reason | The optional message about why the deal was lost (to be used when status = lost) | Budget constraints | | 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 | | Probability | The success probability percentage of the deal | 75 | | Stage ID | The ID of the stage this deal will be added to | 123 | | Status | open = Open, won = Won, lost = Lost, deleted = Deleted | | | Title | The title of the deal | Q1 Software License Deal | | Value | The value of the deal | 5000 | | Visible To | The visibility of the deal. See [Pipedrive API documentation](https://developers.pipedrive.com/docs/api/v1/Deals#addDeal) for more information. | | *** ### Add Deal Follower[​](#adddealfollower "Direct link to 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 | | *** ### Add Deal Participant[​](#adddealparticipant "Direct link to 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 | | *** ### Add Deal Product[​](#adddealproduct "Direct link to 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 | | | Connection | The Pipedrive connection to use. | | | Discount Percentage | The discount % | 0 | | 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 | | | Product ID | The ID of the product to add to the deal | 123 | | Product Variation ID | The ID of the product variation to use | | | Quantity | The quantity of the product | | | Tax | The tax percentage | 0 | *** ### Add File[​](#addfile "Direct link to 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. | | | 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 | | Example Payload for Add File[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/addFile.json "Download example payload") Loading… *** ### Add Lead[​](#addlead "Direct link to Add Lead") Adds a lead. | **key: addLead** | Input | Notes | Example | | ------------------- | -------------------------------------------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Expected Close Date | The date of when the deal which will be created from the lead is expected to be closed | | | Label Ids | The IDs of the lead labels which will be associated with the lead | | | Organization ID | The ID of an organization which this lead will be linked to | | | Owner ID | The ID of the user which will be the owner of the created lead | | | Person ID | The ID of a person which this lead will be linked to | | | Title | The name of the lead | | | Value | The potential value of the lead | | | Visible To | The visibility of the lead | | | Was Seen | A flag indicating whether the lead was seen by someone in the Pipedrive UI | false | *** ### Add Lead Label[​](#addleadlabel "Direct link to Add Lead Label") Adds a lead label. | **key: addLeadLabel** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Color | The color of the label | | | Connection | The Pipedrive connection to use. | | | Name | The name of the lead label | | *** ### Add Organization[​](#addorganization "Direct link to Add Organization") Adds an organization. | **key: addOrganization** | Input | Notes | Example | | ---------- | ----------------------------------------------------------------------- | ---------------- | | Add Time | The optional creation date & time of the organization in UTC | | | Connection | The Pipedrive connection to use. | | | Name | The name of the organization | Acme Corporation | | Owner ID | The ID of the user who will be marked as the owner of this organization | 123 | | Visible To | The visibility of the organization | | *** ### Add Organization Follower[​](#addorganizationfollower "Direct link to 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 | | *** ### Add Person[​](#addperson "Direct link to Add Person") Adds a person. | **key: addPerson** | Input | Notes | Example | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | | Add Time | The optional creation date & time of the person in UTC | | | Connection | The Pipedrive connection to use. | | | Email | The emails of the person | john.doe\@example.com,jane.doe\@example.com | | Marketing Status | If the person does not have a valid email address, then the marketing status is **not set** and "no\_consent" is returned for the "marketing\_status" value when the new person is created | | | Name | The name of the person | 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 | | Phone | The phones of the person | +15551234567,+15559876543 | | Visible To | The visibility of the person | | *** ### Add Person Follower[​](#addpersonfollower "Direct link to 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 | *** ### Add Pipeline[​](#addpipeline "Direct link to 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 | The name of the pipeline | | *** ### Add Product[​](#addproduct "Direct link to 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) | See Example | | Tax | The tax percentage | 10 | | Unit | The unit in which this product is sold | license | | Visible To | The visibility of the product | | *** ### Add Product Follower[​](#addproductfollower "Direct link to 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 | | *** ### Add Stage[​](#addstage "Direct link to 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 | | | Name | The name of the stage | | | Pipeline ID | The ID of the pipeline to add stage to | | | Rotten Days | The number of days the deals not updated in this stage would become rotten | | | Rotten Flag | Whether deals in this stage can become rotten | false | *** ### Cancel Recurring Subscription (Deprecated)[​](#cancelrecurringsubscription "Direct link to Cancel Recurring Subscription (Deprecated)") Cancels a recurring subscription. | **key: cancelRecurringSubscription** | Input | Notes | Example | | --------------- | ------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | End Date | The subscription termination date | | | Subscription ID | The unique identifier for the subscription. | 123 | *** ### Create Webhook[​](#createwebhook "Direct link to 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](https://developers.pipedrive.com/changelog/post/breaking-change-webhooks-v2-will-become-the-new-default-version) post for more details. | 2.0 | *** ### Delete Activity[​](#deleteactivity "Direct link to 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 | *** ### Delete Call Log[​](#deletecalllog "Direct link to 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 | *** ### Delete Deal[​](#deletedeal "Direct link to 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 | *** ### Delete Deal Field[​](#deletedealfield "Direct link to 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 | *** ### Delete Deal Field (V2)[​](#deletedealfieldv2 "Direct link to 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 | *** ### Delete Deal Follower[​](#deletedealfollower "Direct link to 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 | | | Deal ID | The unique identifier for the deal. | 123 | *** ### Delete Deal Participant[​](#deletedealparticipant "Direct link to 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 | | | Deal ID | The unique identifier for the deal. | 123 | *** ### Delete Deal Product[​](#deletedealproduct "Direct link to 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 | | *** ### Delete File[​](#deletefile "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/deleteFile.json "Download example payload") Loading… *** ### Delete Lead[​](#deletelead "Direct link to 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 | *** ### Delete Lead Label[​](#deleteleadlabel "Direct link to 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 | *** ### Delete Mail Thread[​](#deletemailthread "Direct link to 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 | *** ### Delete Organization[​](#deleteorganization "Direct link to 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 | *** ### Delete Organization Follower[​](#deleteorganizationfollower "Direct link to 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 | | | Organization ID | The unique identifier for the organization. | 123 | *** ### Delete Person[​](#deleteperson "Direct link to 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 | *** ### Delete Person Field[​](#deletepersonfield "Direct link to 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 | *** ### Delete Person Field (V2)[​](#deletepersonfieldv2 "Direct link to 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 | *** ### Delete Person Follower[​](#deletepersonfollower "Direct link to 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 | | | Person ID | The unique identifier for the person. | 123 | *** ### Delete Person Picture[​](#deletepersonpicture "Direct link to 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 | *** ### Delete Pipeline[​](#deletepipeline "Direct link to 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 | *** ### Delete Product[​](#deleteproduct "Direct link to 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 | *** ### Delete Product Field[​](#deleteproductfield "Direct link to Delete Product Field") Deletes a product field. | **key: deleteProductField** | Input | Notes | Example | | ---------------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Product Field ID | The ID of the product field | | *** ### Delete Product Field (V2)[​](#deleteproductfieldv2 "Direct link to 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 | *** ### Delete Product Follower[​](#deleteproductfollower "Direct link to 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 | *** ### Delete Stage[​](#deletestage "Direct link to 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 | *** ### Delete Subscription (Deprecated)[​](#deletesubscription "Direct link to Delete Subscription (Deprecated)") Deletes a subscription. | **key: deleteSubscription** | Input | Notes | Example | | --------------- | ------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Subscription ID | The unique identifier for the subscription. | 123 | *** ### Delete Webhook[​](#deletewebhook "Direct link to 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 | *** ### Download File[​](#downloadfile "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/downloadFile.json "Download example payload") Loading… *** ### Find Subscription By Deal (Deprecated)[​](#findsubscriptionbydeal "Direct link to Find Subscription By Deal (Deprecated)") Finds a subscription by deal. | **key: findSubscriptionByDeal** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Deal ID | The ID of the deal | | *** ### Find Users By Name[​](#findusersbyname "Direct link to Find Users By Name") Finds users by name. | **key: findUsersByName** | Input | Notes | Example | | --------------- | ---------------------------------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Search By Email | When enabled, the term will only be matched against email addresses of users | 1 | | Term | The search term to look for | | *** ### Get Activities[​](#getactivities "Direct link to Get Activities") Gets all activities assigned to a particular user. | **key: getActivities** | Input | Notes | Example | | -------------- | ------------------------------------------------------------------------------------------------- | -------------------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Filter ID | The ID of the filter to use (will narrow down results if used together with "user\_id" parameter) | 123 | | Limit | The maximum number of results to return per page. | 100 | | 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 later than or equal to this time are returned | 2024-01-01T10:00:00Z | | Updated Until | If set, only activities with an update\_time earlier than or equal to this time are returned | 2024-12-31T23:59:59Z | *** ### Get Activity[​](#getactivity "Direct link to 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 | *** ### Get Activity Fields[​](#getactivityfields "Direct link to Get Activity Fields") Gets all activity fields. | **key: getActivityFields** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Activity Fields (V2)[​](#getactivityfieldsv2 "Direct link to Get Activity Fields (V2)") Gets all activity fields. | **key: getActivityFieldsV2** | Input | Notes | Example | | ---------- | ------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Fetch All | When true, automatically fetches all pages of results. When false, only the requested page is returned. | false | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Activity Types[​](#getactivitytypes "Direct link to Get Activity Types") Gets all activity types. | **key: getActivityTypes** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Call Log[​](#getcalllog "Direct link to 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 | *** ### Get Company Addons[​](#getcompanyaddons "Direct link to Get Company Addons") Gets all add-ons for a single company. | **key: getCompanyAddons** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Currencies[​](#getcurrencies "Direct link to Get Currencies") Gets all supported currencies. | **key: getCurrencies** | Input | Notes | Example | | ---------- | -------------------------------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Term | Optional search term that is searched for from currency's name and/or code | | *** ### Get Current User[​](#getcurrentuser "Direct link to Get Current User") Gets current user data. | **key: getCurrentUser** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Deal[​](#getdeal "Direct link to 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 | *** ### Get Deal Activities[​](#getdealactivities "Direct link to Get Deal Activities") Lists activities associated with a deal. | **key: getDealActivities** | Input | Notes | Example | | -------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Done | Whether the activity is done or not | false | | Deal ID | The unique identifier for the deal. | 123 | | Limit | The maximum number of results to return per page. | 100 | | Sort By | The field name used to order the results. | title | | Sort Direction | The direction in which results are ordered. | asc | *** ### Get Deal Field[​](#getdealfield "Direct link to 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 | *** ### Get Deal Field (V2)[​](#getdealfieldv2 "Direct link to 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 | *** ### Get Deal Fields[​](#getdealfields "Direct link to Get Deal Fields") Gets all deal fields. | **key: getDealFields** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Deal Fields (V2)[​](#getdealfieldsv2 "Direct link to Get Deal Fields (V2)") Gets all deal fields. | **key: getDealFieldsV2** | Input | Notes | Example | | ---------- | ------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Fetch All | When true, automatically fetches all pages of results. When false, only the requested page is returned. | false | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Deal Files[​](#getdealfiles "Direct link to Get Deal Files") Lists files attached to a deal. | **key: getDealFiles** | Input | Notes | Example | | --------------------- | ------------------------------------------------------------------------------------------------------- | ------------------ | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Deal ID | The unique identifier for the deal. | 123 | | Include Deleted Files | When enabled, the list of files will also include deleted files | | | Limit | The maximum number of results to return per page. | 100 | | 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 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Deal Followers[​](#getdealfollowers "Direct link to Get Deal Followers") Lists followers of a deal. | **key: getDealFollowers** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Deal ID | The unique identifier for the deal. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Deal Mail Messages[​](#getdealmailmessages "Direct link to Get Deal Mail Messages") Lists mail messages associated with a deal. | **key: getDealMailMessages** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Deal ID | The unique identifier for the deal. | 123 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Deal Participants[​](#getdealparticipants "Direct link to Get Deal Participants") Lists participants of a deal. | **key: getDealParticipants** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Deal ID | The unique identifier for the deal. | 123 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Deal Persons (Deprecated)[​](#getdealpersons "Direct link to Get Deal Persons (Deprecated)") Lists all persons associated with a deal. | **key: getDealPersons** | Input | Notes | Example | | -------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Deal ID | The unique identifier for the deal. | 123 | | Limit | The maximum number of results to return per page. | 100 | | Sort By | The field name used to order the results. | title | | Sort Direction | The direction in which results are ordered. | asc | *** ### Get Deal Products[​](#getdealproducts "Direct link to Get Deal Products") Lists products attached to a deal. | **key: getDealProducts** | Input | Notes | Example | | -------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Deal ID | The unique identifier for the deal. | 123 | | Limit | The maximum number of results to return per page. | 100 | | Sort By | The field name used to order the results. | title | | Sort Direction | The direction in which results are ordered. | asc | *** ### Get Deal Users[​](#getdealusers "Direct link to 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 | *** ### Get Deals[​](#getdeals "Direct link to Get Deals") Gets all deals. | **key: getDeals** | Input | Notes | Example | | -------------- | ------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | 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 | | Limit | The maximum number of results to return per page. | 100 | | 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/getDeals.json "Download example payload") Loading… *** ### Get Deals Summary[​](#getdealssummary "Direct link to Get Deals Summary") Gets a summary of deals. | **key: getDealsSummary** | Input | Notes | Example | | ---------- | --------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Filter ID | user\_id will not be considered | | | Stage ID | Only deals within the given stage will be returned | | | Status | Only fetch deals with a specific status | | | User ID | Only deals matching the given user will be returned | | *** ### Get Deals Timeline[​](#getdealstimeline "Direct link to 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 | | | Interval | The type of the interval | | | Pipeline ID | If supplied, only deals matching the given pipeline will be returned | | | 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 | | | User ID | If supplied, only deals matching the given user will be returned | | *** ### Get File Metadata by ID[​](#getfile "Direct link to 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/getFile.json "Download example payload") Loading… *** ### Get Filter[​](#getfilter "Direct link to 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 | *** ### Get Filters[​](#getfilters "Direct link to Get Filters") Gets all filters. | **key: getFilters** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Type | The types of filters to fetch | | *** ### Get Lead[​](#getlead "Direct link to 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 | *** ### Get Lead Labels[​](#getleadlabels "Direct link to Get Lead Labels") Gets all lead labels. | **key: getLeadLabels** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Lead Sources[​](#getleadsources "Direct link to Get Lead Sources") Gets all lead sources. | **key: getLeadSources** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Leads[​](#getleads "Direct link to 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 ID of the filter to use | 1 | | Limit | The maximum number of results to return per page. | 100 | | Owner ID | If supplied, only leads matching the given user will be returned | 1 | | 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 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Mail Message[​](#getmailmessage "Direct link to Get Mail Message") Gets one mail message. | **key: getMailMessage** | Input | Notes | Example | | ------------ | ----------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Id | The ID of the mail message to fetch | | | Include Body | Whether to include the full message body or not | 1 | *** ### Get Mail Thread[​](#getmailthread "Direct link to 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 | *** ### Get Mail Thread Messages[​](#getmailthreadmessages "Direct link to 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 | *** ### Get Mail Threads[​](#getmailthreads "Direct link to Get Mail Threads") Gets mail threads. | **key: getMailThreads** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Folder | The type of folder to fetch | inbox | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Note Fields[​](#getnotefields "Direct link to Get Note Fields") Gets all note fields. | **key: getNoteFields** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Organization[​](#getorganization "Direct link to 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 | *** ### Get Organization Activities[​](#getorganizationactivities "Direct link to Get Organization Activities") Lists activities associated with an organization. | **key: getOrganizationActivities** | Input | Notes | Example | | --------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Done | When true, returns only completed activities | false | | Organization ID | The unique identifier for the organization. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Organization Deals[​](#getorganizationdeals "Direct link to Get Organization Deals") Lists deals associated with an organization. | **key: getOrganizationDeals** | Input | Notes | Example | | --------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Organization ID | The unique identifier for the organization. | 123 | | Limit | The maximum number of results to return per page. | 100 | | 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 | | *** ### Get Organization Files[​](#getorganizationfiles "Direct link to 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 | | | Limit | The maximum number of results to return per page. | 100 | | 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 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Organization Followers[​](#getorganizationfollowers "Direct link to Get Organization Followers") Lists followers of an organization. | **key: getOrganizationFollowers** | Input | Notes | Example | | --------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Organization ID | The unique identifier for the organization. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Organization Mail Messages[​](#getorganizationmailmessages "Direct link to 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 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Organization Persons[​](#getorganizationpersons "Direct link to Get Organization Persons") Lists persons of an organization. | **key: getOrganizationPersons** | Input | Notes | Example | | --------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Organization ID | The unique identifier for the organization. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Organization Updates[​](#getorganizationupdates "Direct link to Get Organization Updates") Lists updates about an organization. | **key: getOrganizationUpdates** | Input | Notes | Example | | --------------- | ---------------------------------------------------------------- | ------- | | All Changes | Whether to show custom field updates or not | | | 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 | | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Organization Users[​](#getorganizationusers "Direct link to 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 | *** ### Get Organizations[​](#getorganizations "Direct link to Get Organizations") Gets all organizations. | **key: getOrganizations** | Input | Notes | Example | | -------------- | ------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | 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 | | Limit | The maximum number of results to return per page. | 100 | | 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/getOrganizations.json "Download example payload") Loading… *** ### Get Permission Set[​](#getpermissionset "Direct link to 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 | *** ### Get Permission Set Assignments[​](#getpermissionsetassignments "Direct link to 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 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Permission Sets[​](#getpermissionsets "Direct link to Get Permission Sets") Gets all permission sets. | **key: getPermissionSets** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Person[​](#getperson "Direct link to 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 | *** ### Get Person Activities[​](#getpersonactivities "Direct link to Get Person Activities") Lists activities associated with a person. | **key: getPersonActivities** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Done | When true, returns only completed activities | false | | Person ID | The unique identifier for the person. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Person Deals[​](#getpersondeals "Direct link to Get Person Deals") Lists deals associated with a person. | **key: getPersonDeals** | Input | Notes | Example | | -------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Person ID | The unique identifier for the person. | 123 | | Limit | The maximum number of results to return per page. | 100 | | 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 | | *** ### Get Person Field[​](#getpersonfield "Direct link to 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 | *** ### Get Person Field (V2)[​](#getpersonfieldv2 "Direct link to 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 | *** ### Get Person Field Details[​](#getpersonfielddetails "Direct link to 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 ID of the field to fetch details for a person | | *** ### Get Person Fields[​](#getpersonfields "Direct link to Get Person Fields") Gets all person fields. | **key: getPersonFields** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Person Fields (V2)[​](#getpersonfieldsv2 "Direct link to Get Person Fields (V2)") Gets all person fields. | **key: getPersonFieldsV2** | Input | Notes | Example | | ---------- | ------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Fetch All | When true, automatically fetches all pages of results. When false, only the requested page is returned. | false | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Person Files[​](#getpersonfiles "Direct link to 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 | | | Limit | The maximum number of results to return per page. | 100 | | 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 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Person Followers[​](#getpersonfollowers "Direct link to Get Person Followers") Lists followers of a person. | **key: getPersonFollowers** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Person ID | The unique identifier for the person. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Person Mail Messages[​](#getpersonmailmessages "Direct link to 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 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Person Products[​](#getpersonproducts "Direct link to 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 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Person Updates[​](#getpersonupdates "Direct link to Get Person Updates") Lists updates about a person. | **key: getPersonUpdates** | Input | Notes | Example | | ----------- | ---------------------------------------------------------------- | ------- | | All Changes | Whether to show custom field updates or not | | | 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 | | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Person Users[​](#getpersonusers "Direct link to 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 | *** ### Get Persons[​](#getpersons "Direct link to Get Persons") Gets all persons. | **key: getPersons** | Input | Notes | Example | | -------------- | ------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | 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 | | Limit | The maximum number of results to return per page. | 100 | | 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[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/getPersons.json "Download example payload") Loading… *** ### Get Pipeline[​](#getpipeline "Direct link to 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 | | *** ### Get Pipeline Conversion Statistics[​](#getpipelineconversionstatistics "Direct link to 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 | | | Pipeline ID | The unique identifier for the pipeline. | 123 | | Start Date | The start of the period | | | User ID | The ID of the user who"s pipeline metrics statistics to fetch | | *** ### Get Pipeline Deals[​](#getpipelinedeals "Direct link to Get Pipeline Deals") Gets deals in a pipeline. | **key: getPipelineDeals** | Input | Notes | Example | | -------------- | ------------------------------------------------------------------ | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Filter ID | If supplied, only deals matching the given filter will be returned | | | Pipeline ID | The unique identifier for the pipeline. | 123 | | Limit | The maximum number of results to return per page. | 100 | | 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 | | *** ### Get Pipeline Movement Statistics[​](#getpipelinemovementstatistics "Direct link to 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 | | | Pipeline ID | The unique identifier for the pipeline. | 123 | | Start Date | The start of the period | | | User ID | The ID of the user who"s pipeline statistics to fetch | | *** ### Get Pipelines[​](#getpipelines "Direct link to Get Pipelines") Gets all pipelines. | **key: getPipelines** | Input | Notes | Example | | -------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Limit | The maximum number of results to return per page. | 100 | | Sort By | The field name used to order the results. | title | | Sort Direction | The direction in which results are ordered. | asc | *** ### Get Product[​](#getproduct "Direct link to 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 | *** ### Get Product Deals[​](#getproductdeals "Direct link to 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 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | | Status | Only fetch deals with a specific status | | *** ### Get Product Field[​](#getproductfield "Direct link to Get Product Field") Gets one product field. | **key: getProductField** | Input | Notes | Example | | ---------------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Product Field ID | The ID of the product field | | *** ### Get Product Field (V2)[​](#getproductfieldv2 "Direct link to 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 | *** ### Get Product Fields[​](#getproductfields "Direct link to Get Product Fields") Gets all product fields. | **key: getProductFields** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Product Fields (V2)[​](#getproductfieldsv2 "Direct link to Get Product Fields (V2)") Gets all product fields. | **key: getProductFieldsV2** | Input | Notes | Example | | ---------- | ------------------------------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Fetch All | When true, automatically fetches all pages of results. When false, only the requested page is returned. | false | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Product Files[​](#getproductfiles "Direct link to 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 | | | Limit | The maximum number of results to return per page. | 100 | | 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 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get Product Followers[​](#getproductfollowers "Direct link to Get Product Followers") Lists followers of a product. | **key: getProductFollowers** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Product ID | The unique identifier for the product. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get Product Users[​](#getproductusers "Direct link to 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 | *** ### Get Products[​](#getproducts "Direct link to Get Products") Gets all products. | **key: getProducts** | Input | Notes | Example | | -------------- | ----------------------------------------------------------------------------------------- | ----------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Filter ID | The ID of the filter to use | 123 | | Ids | An array of integers with the IDs of the products that should be returned in the response | 123,456,789 | | Limit | The maximum number of results to return per page. | 100 | | Sort By | The field name used to order the results. | title | | Sort Direction | The direction in which results are ordered. | asc | *** ### Get Stage[​](#getstage "Direct link to 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 | *** ### Get Stage Deals[​](#getstagedeals "Direct link to Get Stage Deals") Gets deals in a stage. | **key: getStageDeals** | Input | Notes | Example | | -------------- | ------------------------------------------------------------------ | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Filter ID | If supplied, only deals matching the given filter will be returned | | | Stage ID | The unique identifier for the stage. | 123 | | Limit | The maximum number of results to return per page. | 100 | | Sort By | The field name used to order the results. | title | | Sort Direction | The direction in which results are ordered. | asc | *** ### Get Stages[​](#getstages "Direct link to Get Stages") Gets all stages. | **key: getStages** | Input | Notes | Example | | -------------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Limit | The maximum number of results to return per page. | 100 | | Pipeline ID | The ID of the pipeline to fetch stages for | | | Sort By | The field name used to order the results. | title | | Sort Direction | The direction in which results are ordered. | asc | *** ### Get Subscription (Deprecated)[​](#getsubscription "Direct link to Get Subscription (Deprecated)") Gets details of a subscription. | **key: getSubscription** | Input | Notes | Example | | --------------- | ------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Subscription ID | The unique identifier for the subscription. | 123 | *** ### Get Subscription Payments (Deprecated)[​](#getsubscriptionpayments "Direct link to Get Subscription Payments (Deprecated)") Gets all payments of a subscription. | **key: getSubscriptionPayments** | Input | Notes | Example | | --------------- | ------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Subscription ID | The unique identifier for the subscription. | 123 | *** ### Get User[​](#getuser "Direct link to 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 | *** ### Get User Call Logs[​](#getusercalllogs "Direct link to Get User Call Logs") Gets all call logs assigned to a particular user. | **key: getUserCallLogs** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get User Connections[​](#getuserconnections "Direct link to Get User Connections") Gets all user connections. | **key: getUserConnections** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get User Followers[​](#getuserfollowers "Direct link to Get User Followers") Lists followers of a user. | **key: getUserFollowers** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | User ID | The unique identifier for the user. | 123 | | Limit | The maximum number of results to return per page. | 100 | *** ### Get User Permissions[​](#getuserpermissions "Direct link to 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 | *** ### Get User Role Assignments[​](#getuserroleassignments "Direct link to 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 | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | *** ### Get User Role Settings[​](#getuserrolesettings "Direct link to 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 | *** ### Get User Settings[​](#getusersettings "Direct link to Get User Settings") Lists settings of an authorized user. | **key: getUserSettings** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Get Users[​](#getusers "Direct link to Get Users") Gets all users. | **key: getUsers** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### List Files[​](#getfiles "Direct link to List Files") Lists all files attached to all entities. | **key: getFiles** | Input | Notes | Example | | ---------- | ------------------------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Limit | The maximum number of results to return per page. | 100 | | Start | The 0-based offset of the first item to return. | 0 | Example Payload for List Files[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/getFiles.json "Download example payload") Loading… *** ### List Webhooks[​](#listwebhooks "Direct link to List Webhooks") Lists all webhooks. | **key: listWebhooks** | Input | Notes | Example | | ---------- | -------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | *** ### Merge Deals[​](#mergedeals "Direct link to 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 | | *** ### Merge Organizations[​](#mergeorganizations "Direct link to 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 | | *** ### Merge Persons[​](#mergepersons "Direct link to 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 | | *** ### Raw Request[​](#rawrequest "Direct link to 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[​](#searchdeals "Direct link to Search Deals") Searches deals. | **key: searchDeals** | Input | Notes | Example | | --------------- | ----------------------------------------------------------------------------------- | -------------------------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Exact Match | When true, only full exact matches against the given term are returned | false | | Fields | A comma-separated string array | custom\_fields,notes,title | | Include Fields | Supports including optional fields in the results which are not provided by default | | | Limit | The maximum number of results to return per page. | 100 | | Organization ID | Will filter deals by the provided organization ID | 123 | | Person ID | Will filter deals by the provided person ID | 123 | | Status | Will filter deals by the provided specific status | | | Term | The search term to look for | Software License | *** ### Search Leads[​](#searchleads "Direct link to Search Leads") Searches leads. | **key: searchLeads** | Input | Notes | Example | | --------------- | ----------------------------------------------------------------------------------- | ---------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Exact Match | When enabled, only full exact matches against the given term are returned | false | | Fields | A comma-separated string array | | | Include Fields | Supports including optional fields in the results which are not provided by default | | | Limit | The maximum number of results to return per page. | 100 | | Organization ID | Will filter leads by the provided organization ID | | | Person ID | Will filter leads by the provided person ID | | | Term | The search term to look for | | *** ### Search Organization[​](#searchorganization "Direct link to Search Organization") Searches organizations. | **key: searchOrganization** | Input | Notes | Example | | ----------- | ---------------------------------------------------------------------- | --------------------------------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Exact Match | When true, only full exact matches against the given term are returned | false | | Fields | A comma-separated string array | address,custom\_fields,notes,name | | Limit | The maximum number of results to return per page. | 100 | | Term | The search term to look for | Acme Corporation | *** ### Search Persons[​](#searchpersons "Direct link to Search Persons") Searches persons. | **key: searchPersons** | Input | Notes | Example | | --------------- | ----------------------------------------------------------------------------------- | ------------------------------------- | | Connection | The Pipedrive connection to use. | | | Cursor | The pagination cursor from a previous request. | 1234567890 | | Exact Match | When true, only full exact matches against the given term are returned | false | | Fields | A comma-separated string array | custom\_fields,email,notes,phone,name | | Include Fields | Supports including optional fields in the results which are not provided by default | | | Limit | The maximum number of results to return per page. | 100 | | Organization ID | Will filter persons by the provided organization ID | 123 | | Term | The search term to look for | John Doe | *** ### Set Person Field Value[​](#setfieldvalueforperson "Direct link to 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 key of the field to set | | | Person ID | The ID of the person to set the field value for | | | Value | The new value for the field | | *** ### Update Deal[​](#updatedeal "Direct link to Update Deal") Updates a deal. | **key: updateDeal** | Input | Notes | Example | | ------------------- | -------------------------------------------------------------------------------- | ------------------ | | Connection | The Pipedrive connection to use. | | | Currency | The currency of the deal | | | Expected Close Date | The expected close date of the deal | 2024-12-31 | | Deal ID | The unique identifier for the deal. | 123 | | Lost Reason | The optional message about why the deal was lost (to be used when status = lost) | Budget constraints | | 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 | | Probability | The success probability percentage of the deal | 75 | | Stage ID | The ID of the stage this deal will be added to | 123 | | Status | open = Open, won = Won, lost = Lost, deleted = Deleted | | | Title | The title of the deal | | | Value | The value of the deal | | | Visible To | The visibility of the deal | | *** ### Update Deal Product[​](#updatedealproduct "Direct link to Update Deal Product") Updates product attachment details of the deal-product (a product already attached to a deal). | **key: updateDealProduct** | Input | Notes | Example | | --------------------- | ----------------------------------------------------------------------- | ------- | | Comments | Any textual comment associated with this product-deal attachment | | | Connection | The Pipedrive connection to use. | | | Discount Percentage | The discount % | 0 | | Discount Type | The type of discount | | | Deal ID | The unique identifier for the deal. | 123 | | Item Price | The price value of the product | | | Product Attachment ID | The ID of the deal-product (the ID of the product attached to the deal) | | | Product Variation ID | The ID of the product variation to use | | | Quantity | The quantity of the product | | | Tax | The tax percentage | 0 | *** ### Update File[​](#updatefile "Direct link to Update File") Updates the file name or description. | **key: updateFile** | Input | Notes | Example | | ----------- | ----------------------------------- | ------- | | Connection | The Pipedrive connection to use. | | | Description | | | | File ID | The unique identifier for the file. | 123 | | File Name | | | Example Payload for Update File[⤓](https://prismatic.io/docs/example-payloads/pipedrive/actions/updateFile.json "Download example payload") Loading… *** ### Update Filter[​](#updatefilter "Direct link to Update Filter") Updates a filter. | **key: updateFilter** | Input | Notes | Example | | ---------- | --------------------------------------------- | ------- | | Conditions | The conditions of the filter as a JSON object | | | Connection | The Pipedrive connection to use. | | | Filter ID | The unique identifier for the filter. | 123 | | Name | The name of the filter | | *** ### Update Lead[​](#updatelead "Direct link to Update Lead") Updates a lead. | **key: updateLead** | Input | Notes | Example | | ------------------- | -------------------------------------------------------------------------------------- | ------------------------------------ | | Connection | The Pipedrive connection to use. | | | Expected Close Date | The date of when the deal which will be created from the lead is expected to be closed | | | Lead ID | The unique identifier for the lead. | 3cde3b05-035c-ae14-dcfc-172bd8000d08 | | Is Archived | A flag indicating whether the lead is archived or not | false | | Label Ids | The IDs of the lead labels which will be associated with the lead | | | Organization ID | The ID of an organization which this lead will be linked to | | | Owner ID | The ID of the user which will be the owner of the created lead | | | Person ID | The ID of a person which this lead will be linked to | | | Title | The name of the lead | | | Value | The potential value of the lead | | | Visible To | The visibility of the lead | | | Was Seen | A flag indicating whether the lead was seen by someone in the Pipedrive UI | false | *** ### Update Lead Label[​](#updateleadlabel "Direct link to Update Lead Label") Updates a lead label. | **key: updateLeadLabel** | Input | Notes | Example | | ------------- | ----------------------------------------- | ------------------------------------ | | Color | The color of the label | | | Connection | The Pipedrive connection to use. | | | Lead Label ID | The unique identifier for the lead label. | 3cde3b05-035c-ae14-dcfc-172bd8000d08 | | Name | The name of the lead label | | *** ### Update Organization[​](#updateorganization "Direct link to 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 name of the organization | Acme Corporation | | Owner ID | The ID of the user who will be marked as the owner of this organization | 123 | | Visible To | The visibility of the organization | | *** ### Update Person[​](#updateperson "Direct link to Update Person") Updates a person. | **key: updatePerson** | Input | Notes | Example | | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- | | Connection | The Pipedrive connection to use. | | | Emails | List of email data related to the person | email1\@example.com,email2\@example.com | | Person ID | The unique identifier for the person. | 123 | | Marketing Status | If the person does not have a valid email address, then the marketing status is **not set** and "no\_consent" is returned for the "marketing\_status" value when the new person is created | | | Name | The name of the person | 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 | | Phones | List of phone data related to the person | +1234567890,+1234567890 | | Visible To | The visibility of the person | | *** ### Update Pipeline[​](#updatepipeline "Direct link to 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 | The name of the pipeline | | *** ### Update Product[​](#updateproduct "Direct link to 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) | See Example | | Tax | The tax percentage | 10 | | Unit | The unit in which this product is sold | license | | Visible To | The visibility of the product | | *** ### Update Stage[​](#updatestage "Direct link to 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 | | | Stage ID | The unique identifier for the stage. | 123 | | Name | The name of the stage | | | Pipeline ID | The ID of the pipeline to add stage to | | | Rotten Days | The number of days the deals not updated in this stage would become rotten | | | Rotten Flag | Whether deals in this stage can become rotten | false | *** ## Changelog[​](#changelog "Direct link to Changelog") ### 2026-07-29[​](#2026-07-29 "Direct link to 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[​](#2026-07-27 "Direct link to 2026-07-27") Updated list of Event Objects for webhook configuration ### 2026-05-26[​](#2026-05-26 "Direct link to 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[​](#2026-04-30 "Direct link to 2026-04-30") Various modernizations and documentation updates ### 2026-03-31[​](#2026-03-31 "Direct link to 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[​](#2026-03-16 "Direct link to 2026-03-16") Various modernizations and documentation updates ### 2026-03-13[​](#2026-03-13 "Direct link to 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[​](#2026-03-05 "Direct link to 2026-03-05") Added inline data source for files to enable dynamic dropdown selection ### 2026-02-26[​](#2026-02-26 "Direct link to 2026-02-26") Added inline data sources for users, products, stages, pipelines, leads, activities, and filters to enable dynamic dropdown selection ### 2025-10-17[​](#2025-10-17 "Direct link to 2025-10-17") Enhanced webhook lifecycle management with improved trigger subscription handling and automated cleanup