Pipedrive Component

Manage leads, companies, activities, and more on the Pipedrive platform

Component key: pipedrive

Description

Pipedrive is a sales-focused customer relationship management tool. This component allows you to manage leads, companies, activities, and more.

Connections

OAuth 2.0

To connect to Pipedrive you will need to create a new sandbox account in their Developers Corner.

Once you have your sandbox account you will need to create a new app at https://app.pipedrive.com/developer-hub.

Select Create an App and then select a Public app. Fill in the minimal required fields and be sure to include the OAuth 2.0 Callback URL: https://oauth2.prismatic.io/callback

Update the Access scopes to give your app access to the necessary types of data. Reference https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations for information on what permissions your integration might need. Click "Save".

After saving the "OAuth & Access scopes" section will include the Client ID and Client Secret for your app.

You are now ready to create the OAuth 2.0 connection to Pipedrive:

Enter the Client ID and Client Secret values into the same named fields.

Save your integration and you should now be able to connect and authenticate to Pipedrive.

Note that you will need to submit your Pipedrive app for review if you chose "Yes" on the "Intent to publish app" page during app creation.

Pipedrive Custom Redirect URIs

If you plan to make your Pipedrive app public, and publish it in the Pipedrive marketplace, Pipedrive has additional stipulations for how app installation occurs. Please reference https://pipedrive.readme.io/docs/app-installation-flows

When a user within Pipedrive selects your app and clicks "Install", Pipedrive requires that your 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 your integration, they visit a Pipedrive consent screen and are redirected to the callback URL with search parameters ?code=[SOME AUTH CODE]&state=SW5example. We 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, you will need to supply an endpoint that captures and handles an auth code that potentially has no state attached to it (yet).

At a high level, you will need to:

Create a custom endpoint within your 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 your app, encourage them to sign up for your app.
- If the user is registered but not logged in, have them log in.
- If the user is logged in, continue.
Now that you have a user authenticated in your app with a Pipedrive auth code, programmatically create a customer in Prismatic (if needed) and programmatically deploy an (unconfigured) instance to the customer (assuming they do not have an instance of your 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 prismatic.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 your integration's authorize URL

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

So, you need to override the redirect_uri in the authorize URL to your custom endpoint.

Open your 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	Authorization URL	https://oauth.pipedrive.com/oauth/authorize
Client ID	Client identifier
Client Secret	Client secret
Scopes	Space-delimited scopes
Token URL	Token URL	https://oauth.pipedrive.com/oauth/token

Triggers

Webhook Trigger

Receive data from Pipedrive in real time with webhook subscriptions. | key: pipedriveTrigger

Input	Notes	Example
Connection
Event Action	The actions to subscribe to
Event Object	The object to subscribe to
HTTP Auth Password	The password for HTTP Basic Auth	password
HTTP Auth User	The username for HTTP Basic Auth	username
User ID	The ID of the user that this webhook will be authorized with. You have the option to use a different user's user_id. If it is not set, the current user's user_id will be used. As each webhook event is checked against a user's permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user's user_id.
Version	The version of the API to use.	2.0

Data Sources

Select Deal

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

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "1",
      "label": "Deal Title - open"
    }
  ]
}

Select Organization

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

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "1",
      "label": "Jhon Doe"
    }
  ]
}

Select Person

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

Input	Notes	Example
Connection

{
  "result": [
    {
      "key": "1",
      "label": "Jhon Doe"
    }
  ]
}

Actions

Add Call Log

Add 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
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 Channel

Add a channel | key: addChannel

Input	Notes	Example
Avatar Url	The URL for an icon that represents your channel
Connection
Name	The name of the channel	My Channel
Provider Channel ID	The channel ID
Provider Type	It controls the icons (like the icon next to the conversation)	other
Template Support	If true, enables templates logic on UI	false

Add Deal

Add a deal | key: addDeal

Input	Notes	Example
Add Time	The optional creation date & time of the deal in UTC
Connection
Currency	The currency of the deal
Expected Close Date	The expected close date of the deal
Lost Reason	The optional message about why the deal was lost (to be used when status = lost)
Org ID	The ID of an organization which this deal will be linked to
Person ID	The ID of a person which this deal will be linked to
Pipeline ID	The ID of the pipeline this deal will be added to
Probability	The success probability percentage of the deal
Stage ID	The ID of the stage this deal will be added to
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. See https://developers.pipedrive.com/docs/api/v1/Deals#addDeal.

Add Deal Follower

Add a follower to a deal | key: addDealFollower

Input	Notes	Example
Connection
Deal ID	The ID of the deal
User ID	The ID of the user

Add Deal Participant

Add a participant to a deal | key: addDealParticipant

Input	Notes	Example
Connection
Deal ID	The ID of the deal
Person ID	The ID of the person

Add Deal Product

Add 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
Discount Percentage	The discount %	0
Discount Type	The type of discount
Deal ID	The ID of the deal
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

Upload and add a new file to a deal, person, org, product, activity or lead | key: addFile

Input	Notes	Example
Connection
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

{
  "data": {
    "success": true,
    "data": {
      "id": 123,
      "user_id": 456,
      "deal_id": 1,
      "person_id": 789,
      "org_id": 1,
      "product_id": 1,
      "activity_id": 1,
      "lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
      "log_id": null,
      "add_time": "2020-02-20 14:36:35",
      "update_time": "2020-02-20 14:36:31",
      "file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
      "file_type": "img",
      "file_size": 7801780,
      "active_flag": true,
      "inline_flag": false,
      "remote_location": "googledocs",
      "remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
      "cid": "",
      "s3_bucket": "",
      "mail_message_id": "",
      "mail_template_id": "",
      "deal_name": "",
      "person_name": "Person",
      "org_name": "",
      "product_name": "",
      "lead_name": "Test lead name",
      "url": "https://2a7f.pipedrive.com/v1/files/123/download",
      "name": "IMG_8189.jpg",
      "description": ""
    }
  }
}

Add Lead

Add a lead | key: addLead

Input	Notes	Example
Connection
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

Add a lead label | key: addLeadLabel

Input	Notes	Example
Color	The color of the label
Connection
Name	The name of the lead label

Add Organization

Add an organization | key: addOrganization

Input	Notes	Example
Add Time	The optional creation date & time of the organization in UTC
Connection
Name	The name of the organization
Owner ID	The ID of the user who will be marked as the owner of this organization
Visible To	The visibility of the organization

Add Organization Follower

Add a follower to an organization | key: addOrganizationFollower

Input	Notes	Example
Connection
Organization ID	The ID of the organization
User ID	The ID of the user

Add Person

Add a person | key: addPerson

Input	Notes	Example
Add Time	The optional creation date & time of the person in UTC
Connection
Email	The emails of the person	email1@example.com,email2@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
Org ID	The ID of the organization this person will belong to
Owner ID	The ID of the user who will be marked as the owner of this person
Phone	The phones of the person	+1234567890,+1234567890
Visible To	The visibility of the person

Add Person Follower

Add a follower to a person | key: addPersonFollower

Input	Notes	Example
Connection
Person ID	The ID of the person
User ID	If supplied, only persons owned by the given user will be returned

Add Pipeline

Add a new pipeline | key: addPipeline

Input	Notes	Example
Connection
Deal Probability	Whether deal probability is disabled or enabled for this pipeline	false
Name	The name of the pipeline

Add Product

Add a product | key: addProduct

Input	Notes	Example
Code	The product code
Connection
Name	The name of the product
Owner ID	The ID of the user who will be marked as the owner of this product
Prices	An array of objects, each containing: "currency" (string), "price" (number), "cost" (number, optional), "overhead_cost" (number, optional)
Tax	The tax percentage	0
Unit	The unit in which this product is sold
Visible To	The visibility of the product

Add Product Follower

Add a follower to a product | key: addProductFollower

Input	Notes	Example
Connection
Product ID	The ID of the product	123
User ID	The ID of the user

Add Stage

Add a new stage | key: addStage

Input	Notes	Example
Connection
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)

Cancel a recurring subscription | key: cancelRecurringSubscription

Input	Notes	Example
Connection
End Date	The subscription termination date
Subscription ID	The ID of the subscription

Create Webhook

Create a new webhook | key: createWebhook

Input	Notes	Example
Connection
Event Action	The actions to subscribe to
Event Object	The object to subscribe to
HTTP Auth Password	The password for HTTP Basic Auth	password
HTTP Auth User	The username for HTTP Basic Auth	username
Subscription URL	The URL to subscribe to	https://example.com/pipedrive/webhook
User ID	The ID of the user that this webhook will be authorized with. You have the option to use a different user's user_id. If it is not set, the current user's user_id will be used. As each webhook event is checked against a user's permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user's user_id.
Version	The webhook's version. NB! Webhooks v2 is the default from March 17th, 2025. See this Changelog post for more details.	2.0

Delete Activity

Delete an activity | key: deleteActivity

Input	Notes	Example
Connection
Activity ID	The ID of the activity

Delete Call Log

Delete a call log | key: deleteCallLog

Input	Notes	Example
Connection
Call Log ID	The ID received when you create the call log	3cde3b05035cae14dcfc172bd8000d08

Delete Channel

Delete a channel | key: deleteChannel

Input	Notes	Example
Connection
Id	The ID of the channel provided by the integration

Delete Conversation

Delete a conversation | key: deleteConversation

Input	Notes	Example
Channel ID	The ID of the channel provided by the integration
Connection
Conversation ID	The ID of the conversation provided by the integration

Delete Deal

Delete a deal | key: deleteDeal

Input	Notes	Example
Connection
Deal ID	The ID of the deal

Delete Deal Field

Delete a deal field | key: deleteDealField

Input	Notes	Example
Connection
Deal Field ID	The ID of the deal field

Delete Deal Follower

Delete a follower from a deal | key: deleteDealFollower

Input	Notes	Example
Connection
Follower ID	The ID of the follower
Deal ID	The ID of the deal

Delete Deal Participant

Delete a participant from a deal | key: deleteDealParticipant

Input	Notes	Example
Connection
Deal Participant ID	The ID of the participant of the deal
Deal ID	The ID of the deal

Delete Deal Product

Delete an attached product from a deal | key: deleteDealProduct

Input	Notes	Example
Connection
Deal ID	The ID of the deal
Product Attachment ID	The product attachment ID

Delete File

Delete a file | key: deleteFile

Input	Notes	Example
Connection
File ID	The ID of a file

{
  "data": {
    "success": true,
    "data": {
      "id": 123
    }
  }
}

Delete Lead

Delete a lead | key: deleteLead

Input	Notes	Example
Connection
Lead ID	The ID of the lead

Delete Lead Label

Delete a lead label | key: deleteLeadLabel

Input	Notes	Example
Connection
Lead Label ID	The ID of the lead label

Delete Mail Thread

Delete mail thread | key: deleteMailThread

Input	Notes	Example
Connection
Mail Thread ID	The ID of the mail thread

Delete Organization

Delete an organization | key: deleteOrganization

Input	Notes	Example
Connection
Organization ID	The ID of the organization

Delete Organization Follower

Delete a follower from an organization | key: deleteOrganizationFollower

Input	Notes	Example
Connection
Follower ID	The ID of the follower
Organization ID	The ID of the organization

Delete Person

Delete a person | key: deletePerson

Input	Notes	Example
Connection
Person ID	The ID of the person

Delete Person Field

Delete a person field | key: deletePersonField

Input	Notes	Example
Connection
Person Field ID	The ID of the field

Delete Person Follower

Delete a follower from a person | key: deletePersonFollower

Input	Notes	Example
Connection
Follower ID	The ID of the follower
Person ID	The ID of the person

Delete Person Picture

Delete person picture | key: deletePersonPicture

Input	Notes	Example
Connection
Person ID	The ID of the person

Delete Pipeline

Delete a pipeline | key: deletePipeline

Input	Notes	Example
Connection
Pipeline ID	The ID of the pipeline

Delete Product

Delete a product | key: deleteProduct

Input	Notes	Example
Connection
Product ID	The ID of the product	123

Delete Product Field

Delete a product field | key: deleteProductField

Input	Notes	Example
Connection
Product Field ID	The ID of the product field

Delete Product Follower

Delete a follower from a product | key: deleteProductFollower

Input	Notes	Example
Connection
Follower ID	The ID of the relationship between the follower and the product
Product ID	The ID of the product	123

Delete Stage

Delete a stage | key: deleteStage

Input	Notes	Example
Connection
Stage ID	The ID of the stage

Delete Subscription (Deprecated)

Delete a subscription | key: deleteSubscription

Input	Notes	Example
Connection
Subscription ID	The ID of the subscription

Delete Webhook

Delete a webhook | key: deleteWebhook

Input	Notes	Example
Connection
Webhook ID	The ID of the webhook	1234567890

Download File

Download one file | key: downloadFile

Input	Notes	Example
Connection
File ID	The ID of a file

{
  "data": {
    "type": "Buffer",
    "data": [
      72,
      101,
      108,
      108,
      111,
      44,
      32,
      87,
      111,
      114,
      108,
      100
    ]
  },
  "contentType": "text/plain"
}

Find Subscription By Deal (Deprecated)

Find subscription by deal | key: findSubscriptionByDeal

Input	Notes	Example
Connection
Deal ID	The ID of the deal

Find Users By Name

Find users by name | key: findUsersByName

Input	Notes	Example
Connection
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

Get all activities assigned to a particular user | key: getActivities

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Filter ID	The ID of the filter to use (will narrow down results if used together with "user_id" parameter)
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.	desc
Updated Since	If set, only activities with an update_time later than or equal to this time are returned
Updated Until	If set, only activities with an update_time earlier than or equal to this time are returned

Get Activity

Get details of an activity | key: getActivity

Input	Notes	Example
Connection
Activity ID	The ID of the activity

Get Activity Fields

Get all activity fields | key: getActivityFields

Input	Notes	Example
Connection

Get Activity Types

Get all activity types | key: getActivityTypes

Input	Notes	Example
Connection

Get Call Log

Get details of a call log | key: getCallLog

Input	Notes	Example
Connection
Call Log ID	The ID received when you create the call log	3cde3b05035cae14dcfc172bd8000d08

Get Company Addons

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

Input	Notes	Example
Connection

Get Currencies

Get all supported currencies | key: getCurrencies

Input	Notes	Example
Connection
Term	Optional search term that is searched for from currency's name and/or code

Get Current User

Get current user data | key: getCurrentUser

Input	Notes	Example
Connection

Get Deal

Get details of a deal | key: getDeal

Input	Notes	Example
Connection
Deal ID	The ID of the deal

Get Deal Activities

List activities associated with a deal | key: getDealActivities

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Done	Whether the activity is done or not	false
Deal ID	The ID of the deal
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

Get Deal Field

Get one deal field | key: getDealField

Input	Notes	Example
Connection
Deal Field ID	The ID of the deal field

Get Deal Fields

Get all deal fields | key: getDealFields

Input	Notes	Example
Connection
Limit	Items shown per page
Start	Pagination start	0

Get Deal Files

List files attached to a deal | key: getDealFiles

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Deal ID	The ID of the deal
Include Deleted Files	When enabled, the list of files will also include deleted files
Limit	Items shown per page
Sort	The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Start	Pagination start	0

Get Deal Followers

List followers of a deal | key: getDealFollowers

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Deal ID	The ID of the deal
Limit	Items shown per page

Get Deal Mail Messages

List mail messages associated with a deal | key: getDealMailMessages

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Deal ID	The ID of the deal
Limit	Items shown per page
Start	Pagination start	0

Get Deal Participants

List participants of a deal | key: getDealParticipants

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Deal ID	The ID of the deal
Limit	Items shown per page
Start	Pagination start	0

Get Deal Persons (Deprecated)

List all persons associated with a deal | key: getDealPersons

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Deal ID	The ID of the deal
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

Get Deal Products

List products attached to a deal | key: getDealProducts

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Deal ID	The ID of the deal
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

Get Deal Users

List permitted users | key: getDealUsers

Input	Notes	Example
Connection
Deal ID	The ID of the deal

Get Deals

Get all deals | key: getDeals

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Fetch All	If set to true, all records will be fetched. If set to false, the provided pagination will be used.	false
Filter ID	The ID of the filter to use
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.
Stage ID	If supplied, only deals within the given stage will be returned
Status	Only fetch deals with a specific status

{
  "data": {
    "data": [
      {
        "id": 1,
        "creator_user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "person_id": {
          "active_flag": true,
          "name": "test person",
          "email": [
            {
              "value": "",
              "primary": true
            }
          ],
          "phone": [
            {
              "value": "",
              "primary": true
            }
          ],
          "owner_id": 18487521,
          "value": 3
        },
        "org_id": {
          "name": "test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Developer",
          "value": 2
        },
        "stage_id": 1,
        "title": "test deal",
        "value": 2,
        "currency": "USD",
        "add_time": "2024-09-27 14:25:27",
        "update_time": "2024-09-27 14:25:28",
        "stage_change_time": null,
        "active": true,
        "deleted": false,
        "status": "open",
        "probability": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "lost_reason": null,
        "visible_to": "3",
        "close_time": null,
        "pipeline_id": 1,
        "won_time": null,
        "first_won_time": null,
        "lost_time": null,
        "products_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "participants_count": 1,
        "expected_close_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "local_won_date": null,
        "local_lost_date": null,
        "local_close_date": null,
        "origin": "ManuallyCreated",
        "origin_id": null,
        "channel": null,
        "channel_id": null,
        "stage_order_nr": 0,
        "person_name": "test person",
        "org_name": "test",
        "next_activity_subject": null,
        "next_activity_type": null,
        "next_activity_duration": null,
        "next_activity_note": null,
        "formatted_value": "$2",
        "weighted_value": 2,
        "formatted_weighted_value": "$2",
        "weighted_value_currency": "USD",
        "rotten_time": null,
        "owner_name": "Developer",
        "cc_email": "test-sandbox+deal1@pipedrivemail.com",
        "org_hidden": false,
        "person_hidden": false
      },
      {
        "id": 2,
        "creator_user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "user_id": {
          "id": 18487521,
          "name": "Developer",
          "email": "dummy@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "person_id": {
          "active_flag": true,
          "name": "awesome person",
          "email": [
            {
              "value": "",
              "primary": true
            }
          ],
          "phone": [
            {
              "value": "",
              "primary": true
            }
          ],
          "owner_id": 18487521,
          "value": 4
        },
        "org_id": {
          "name": "test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Developer",
          "value": 2
        },
        "stage_id": 4,
        "title": "test deal 2",
        "value": 3,
        "currency": "USD",
        "add_time": "2024-09-27 14:25:53",
        "update_time": "2024-09-27 14:31:57",
        "stage_change_time": "2024-09-27 14:31:45",
        "active": false,
        "deleted": false,
        "status": "won",
        "probability": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "lost_reason": null,
        "visible_to": "3",
        "close_time": "2024-09-27 14:31:57",
        "pipeline_id": 1,
        "won_time": "2024-09-27 14:31:57",
        "first_won_time": "2024-09-27 14:31:57",
        "lost_time": null,
        "products_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "participants_count": 1,
        "expected_close_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "local_won_date": "2024-09-27",
        "local_lost_date": null,
        "local_close_date": "2024-09-27",
        "origin": "ManuallyCreated",
        "origin_id": null,
        "channel": null,
        "channel_id": null,
        "stage_order_nr": 3,
        "person_name": "awesome person",
        "org_name": "test",
        "next_activity_subject": null,
        "next_activity_type": null,
        "next_activity_duration": null,
        "next_activity_note": null,
        "formatted_value": "$3",
        "weighted_value": 3,
        "formatted_weighted_value": "$3",
        "weighted_value_currency": "USD",
        "rotten_time": null,
        "owner_name": "Developer",
        "cc_email": "test-sandbox+deal2@pipedrivemail.com",
        "org_hidden": false,
        "person_hidden": false
      }
    ],
    "additional_data": {
      "next_cursor": "1234567890"
    }
  }
}

Get Deals Summary

Get deals summary | key: getDealsSummary

Input	Notes	Example
Connection
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

Get deals timeline | key: getDealsTimeline

Input	Notes	Example
Amount	The number of given intervals, starting from "start_date", to fetch
Connection
Exclude Deals	Whether to exclude deals list (1) or not (0)
Field Key	The date field key which deals will be retrieved from
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
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

Get metadata about one file by ID | key: getFile

Input	Notes	Example
Connection
File ID	The ID of a file

{
  "data": {
    "success": true,
    "data": {
      "id": 123,
      "user_id": 456,
      "deal_id": 1,
      "person_id": 789,
      "org_id": 1,
      "product_id": 1,
      "activity_id": 1,
      "lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
      "log_id": null,
      "add_time": "2020-02-20 14:36:35",
      "update_time": "2020-02-20 14:57:33",
      "file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
      "file_type": "img",
      "file_size": 7801780,
      "active_flag": true,
      "inline_flag": false,
      "remote_location": "googledocs",
      "remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
      "cid": "",
      "s3_bucket": "",
      "mail_message_id": "",
      "mail_template_id": "",
      "deal_name": "",
      "person_name": "Person",
      "org_name": "",
      "product_name": "",
      "lead_name": "Test lead name",
      "url": "https://2a7f.pipedrive.com/v1/files/123/download",
      "name": "test file name",
      "description": "test file description"
    }
  }
}

Get Filter

Get one filter | key: getFilter

Input	Notes	Example
Connection
Filter ID	The ID of the filter

Get Filters

Get all filters | key: getFilters

Input	Notes	Example
Connection
Type	The types of filters to fetch

Get Lead

Get one lead | key: getLead

Input	Notes	Example
Connection
Lead ID	The ID of the lead

Get Lead Labels

Get all lead labels | key: getLeadLabels

Input	Notes	Example
Connection

Get Lead Sources

Get all lead sources | key: getLeadSources

Input	Notes	Example
Connection

Get Leads

Get all leads | key: getLeads

Input	Notes	Example
Archived Status	Filtering based on the archived status of a lead
Connection
Filter ID	The ID of the filter to use	1
Limit	Items shown per page
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 ("field_name_1 ASC", "field_name_2 DESC")
Start	Pagination start	0

Get Mail Message

Get one mail message | key: getMailMessage

Input	Notes	Example
Connection
Id	The ID of the mail message to fetch
Include Body	Whether to include the full message body or not	1

Get Mail Thread

Get one mail thread | key: getMailThread

Input	Notes	Example
Connection
Mail Thread ID	The ID of the mail thread

Get Mail Thread Messages

Get all mail messages of mail thread | key: getMailThreadMessages

Input	Notes	Example
Connection
Mail Thread ID	The ID of the mail thread

Get Mail Threads

Get mail threads | key: getMailThreads

Input	Notes	Example
Connection
Folder	The type of folder to fetch	inbox
Limit	Items shown per page
Start	Pagination start	0

Get Note Fields

Get all note fields | key: getNoteFields

Input	Notes	Example
Connection

Get Organization

Get details of an organization | key: getOrganization

Input	Notes	Example
Connection
Organization ID	The ID of the organization

Get Organization Activities

List activities associated with an organization | key: getOrganizationActivities

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Done	Whether the activity is done or not	false
Organization ID	The ID of the organization
Limit	Items shown per page

Get Organization Deals

List deals associated with an organization | key: getOrganizationDeals

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Organization ID	The ID of the organization
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.
Status	Only fetch deals with a specific status

Get Organization Files

List files attached to an organization | key: getOrganizationFiles

Input	Notes	Example
Connection
Organization ID	The ID of the organization
Include Deleted Files	When enabled, the list of files will also include deleted files
Limit	Items shown per page
Sort	The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Start	Pagination start	0

Get Organization Followers

List followers of an organization | key: getOrganizationFollowers

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Organization ID	The ID of the organization
Limit	Items shown per page

Get Organization Mail Messages

List mail messages associated with an organization | key: getOrganizationMailMessages

Input	Notes	Example
Connection
Organization ID	The ID of the organization
Limit	Items shown per page
Start	Pagination start	0

Get Organization Persons

List persons of an organization | key: getOrganizationPersons

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Organization ID	The ID of the organization
Limit	Items shown per page

Get Organization Updates

List updates about an organization | key: getOrganizationUpdates

Input	Notes	Example
All Changes	Whether to show custom field updates or not
Connection
Organization ID	The ID of the organization
Items	A comma-separated string for filtering out item specific updates
Limit	Items shown per page
Start	Pagination start	0

Get Organization Users

List permitted users | key: getOrganizationUsers

Input	Notes	Example
Connection
Organization ID	The ID of the organization

Get Organizations

Get all organizations | key: getOrganizations

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Fetch All	If set to true, all records will be fetched. If set to false, the provided pagination will be used.	false
Filter ID	The ID of the filter to use
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

{
  "data": {
    "data": [
      {
        "id": 1,
        "creator_user_id": {
          "id": 18487521,
          "name": "test Developer",
          "email": "dev@test.io",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "user_id": {
          "id": 18487521,
          "name": "test Developer",
          "email": "dev@test.io",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "person_id": {
          "active_flag": true,
          "name": "test person",
          "email": [
            {
              "value": "",
              "primary": true
            }
          ],
          "phone": [
            {
              "value": "",
              "primary": true
            }
          ],
          "owner_id": 18487521,
          "value": 3
        },
        "org_id": {
          "name": "test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "test Developer",
          "value": 2
        },
        "stage_id": 1,
        "title": "test deal",
        "value": 2,
        "currency": "USD",
        "add_time": "2024-09-27 14:25:27",
        "update_time": "2024-09-27 14:25:28",
        "stage_change_time": null,
        "active": true,
        "deleted": false,
        "status": "open",
        "probability": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "lost_reason": null,
        "visible_to": "3",
        "close_time": null,
        "pipeline_id": 1,
        "won_time": null,
        "first_won_time": null,
        "lost_time": null,
        "products_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "participants_count": 1,
        "expected_close_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "local_won_date": null,
        "local_lost_date": null,
        "local_close_date": null,
        "origin": "ManuallyCreated",
        "origin_id": null,
        "channel": null,
        "channel_id": null,
        "stage_order_nr": 0,
        "person_name": "test person",
        "org_name": "test",
        "next_activity_subject": null,
        "next_activity_type": null,
        "next_activity_duration": null,
        "next_activity_note": null,
        "formatted_value": "$2",
        "weighted_value": 2,
        "formatted_weighted_value": "$2",
        "weighted_value_currency": "USD",
        "rotten_time": null,
        "owner_name": "test Developer",
        "cc_email": "test-sandbox+deal1@pipedrivemail.com",
        "org_hidden": false,
        "person_hidden": false
      },
      {
        "id": 2,
        "creator_user_id": {
          "id": 18487521,
          "name": "test Developer",
          "email": "dev@test.io",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "user_id": {
          "id": 18487521,
          "name": "test Developer",
          "email": "dev@test.io",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "person_id": {
          "active_flag": true,
          "name": "awesome person",
          "email": [
            {
              "value": "",
              "primary": true
            }
          ],
          "phone": [
            {
              "value": "",
              "primary": true
            }
          ],
          "owner_id": 18487521,
          "value": 4
        },
        "org_id": {
          "name": "test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "test Developer",
          "value": 2
        },
        "stage_id": 4,
        "title": "test deal 2",
        "value": 3,
        "currency": "USD",
        "add_time": "2024-09-27 14:25:53",
        "update_time": "2024-09-27 14:31:57",
        "stage_change_time": "2024-09-27 14:31:45",
        "active": false,
        "deleted": false,
        "status": "won",
        "probability": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "lost_reason": null,
        "visible_to": "3",
        "close_time": "2024-09-27 14:31:57",
        "pipeline_id": 1,
        "won_time": "2024-09-27 14:31:57",
        "first_won_time": "2024-09-27 14:31:57",
        "lost_time": null,
        "products_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "participants_count": 1,
        "expected_close_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "local_won_date": "2024-09-27",
        "local_lost_date": null,
        "local_close_date": "2024-09-27",
        "origin": "ManuallyCreated",
        "origin_id": null,
        "channel": null,
        "channel_id": null,
        "stage_order_nr": 3,
        "person_name": "awesome person",
        "org_name": "test",
        "next_activity_subject": null,
        "next_activity_type": null,
        "next_activity_duration": null,
        "next_activity_note": null,
        "formatted_value": "$3",
        "weighted_value": 3,
        "formatted_weighted_value": "$3",
        "weighted_value_currency": "USD",
        "rotten_time": null,
        "owner_name": "test Developer",
        "cc_email": "test-sandbox+deal2@pipedrivemail.com",
        "org_hidden": false,
        "person_hidden": false
      }
    ],
    "additional_data": {
      "next_cursor": "1234567890"
    }
  }
}

Get Permission Set

Get one permission set | key: getPermissionSet

Input	Notes	Example
Connection
Permission Set ID	The ID of the permission set

Get Permission Set Assignments

List permission set assignments | key: getPermissionSetAssignments

Input	Notes	Example
Connection
Permission Set ID	The ID of the permission set
Limit	Items shown per page
Start	Pagination start	0

Get Permission Sets

Get all permission sets | key: getPermissionSets

Input	Notes	Example
Connection

Get Person

Get details of a person | key: getPerson

Input	Notes	Example
Connection
Person ID	The ID of the person

Get Person Activities

List activities associated with a person | key: getPersonActivities

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Done	Whether the activity is done or not	false
Person ID	The ID of the person
Limit	Items shown per page

Get Person Deals

List deals associated with a person | key: getPersonDeals

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Person ID	The ID of the person
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.
Status	Only fetch deals with a specific status

Get Person Field

Get one person field | key: getPersonField

Input	Notes	Example
Connection
Person Field ID	The ID of the field

Get Person Field Details

Get details of a specific field for a person | key: getPersonFieldDetails

Input	Notes	Example
Connection
Field ID	The ID of the field to fetch details for a person

Get Person Fields

Get all person fields | key: getPersonFields

Input	Notes	Example
Connection
Limit	Items shown per page
Start	Pagination start	0

Get Person Files

List files attached to a person | key: getPersonFiles

Input	Notes	Example
Connection
Person ID	The ID of the person
Include Deleted Files	When enabled, the list of files will also include deleted files
Limit	Items shown per page
Sort	The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Start	Pagination start	0

Get Person Followers

List followers of a person | key: getPersonFollowers

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Person ID	The ID of the person
Limit	Items shown per page

Get Person Mail Messages

List mail messages associated with a person | key: getPersonMailMessages

Input	Notes	Example
Connection
Person ID	The ID of the person
Limit	Items shown per page
Start	Pagination start	0

Get Person Products

List products associated with a person | key: getPersonProducts

Input	Notes	Example
Connection
Person ID	The ID of the person
Limit	Items shown per page
Start	Pagination start	0

Get Person Updates

List updates about a person | key: getPersonUpdates

Input	Notes	Example
All Changes	Whether to show custom field updates or not
Connection
Person ID	The ID of the person
Items	A comma-separated string for filtering out item specific updates
Limit	Items shown per page
Start	Pagination start	0

Get Person Users

List permitted users | key: getPersonUsers

Input	Notes	Example
Connection
Person ID	The ID of the person

Get Persons

Get all persons | key: getPersons

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Fetch All	If set to true, all records will be fetched. If set to false, the provided pagination will be used.	false
Filter ID	The ID of the filter to use
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

{
  "data": {
    "data": [
      {
        "id": 1,
        "company_id": 12882925,
        "owner_id": {
          "id": 18487521,
          "name": "Test Developer",
          "email": "dev@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "org_id": {
          "name": "Acme",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Test Developer",
          "value": 1
        },
        "name": "John",
        "first_name": "John",
        "last_name": null,
        "open_deals_count": 0,
        "related_open_deals_count": 0,
        "closed_deals_count": 0,
        "related_closed_deals_count": 0,
        "participant_open_deals_count": 0,
        "participant_closed_deals_count": 0,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "files_count": 5,
        "notes_count": 0,
        "followers_count": 1,
        "won_deals_count": 0,
        "related_won_deals_count": 0,
        "lost_deals_count": 0,
        "related_lost_deals_count": 0,
        "active_flag": true,
        "phone": [
          {
            "value": "",
            "primary": true
          }
        ],
        "email": [
          {
            "value": "",
            "primary": true
          }
        ],
        "first_char": "t",
        "update_time": "2023-08-14 22:49:23",
        "delete_time": null,
        "add_time": "2023-04-06 02:51:24",
        "visible_to": "3",
        "picture_id": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "label_ids": [],
        "im": [
          {
            "value": "",
            "primary": true
          }
        ],
        "postal_address": null,
        "postal_address_lat": null,
        "postal_address_long": null,
        "postal_address_subpremise": null,
        "postal_address_street_number": null,
        "postal_address_route": null,
        "postal_address_sublocality": null,
        "postal_address_locality": null,
        "postal_address_admin_area_level_1": null,
        "postal_address_admin_area_level_2": null,
        "postal_address_country": null,
        "postal_address_postal_code": null,
        "postal_address_formatted_address": null,
        "notes": null,
        "birthday": null,
        "job_title": null,
        "org_name": "Acme",
        "owner_name": "Test Developer",
        "primary_email": null,
        "5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": "15",
        "3cf151d1c54a8c13329a97403054d6306fe4680c": "17",
        "cc_email": "test-sandbox@pipedrivemail.com"
      },
      {
        "id": 2,
        "company_id": 12882925,
        "owner_id": {
          "id": 18487521,
          "name": "Test Developer",
          "email": "dev@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "org_id": {
          "name": "Acme",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Test Developer",
          "value": 1
        },
        "name": "John",
        "first_name": "John",
        "last_name": null,
        "open_deals_count": 0,
        "related_open_deals_count": 0,
        "closed_deals_count": 0,
        "related_closed_deals_count": 0,
        "participant_open_deals_count": 0,
        "participant_closed_deals_count": 0,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "won_deals_count": 0,
        "related_won_deals_count": 0,
        "lost_deals_count": 0,
        "related_lost_deals_count": 0,
        "active_flag": true,
        "phone": [
          {
            "value": "",
            "primary": true
          }
        ],
        "email": [
          {
            "label": "work",
            "value": "john.doe@example.com",
            "primary": true
          }
        ],
        "first_char": "j",
        "update_time": "2023-07-13 21:26:05",
        "delete_time": null,
        "add_time": "2023-07-13 20:47:38",
        "visible_to": "3",
        "picture_id": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "label_ids": [],
        "im": [
          {
            "value": "",
            "primary": true
          }
        ],
        "postal_address": null,
        "postal_address_lat": null,
        "postal_address_long": null,
        "postal_address_subpremise": null,
        "postal_address_street_number": null,
        "postal_address_route": null,
        "postal_address_sublocality": null,
        "postal_address_locality": null,
        "postal_address_admin_area_level_1": null,
        "postal_address_admin_area_level_2": null,
        "postal_address_country": null,
        "postal_address_postal_code": null,
        "postal_address_formatted_address": null,
        "notes": null,
        "birthday": null,
        "job_title": null,
        "org_name": "Acme",
        "owner_name": "Test Developer",
        "primary_email": "john.doe@example.com",
        "5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": "15",
        "3cf151d1c54a8c13329a97403054d6306fe4680c": "19",
        "cc_email": "test-sandbox@pipedrivemail.com"
      },
      {
        "id": 3,
        "company_id": 12882925,
        "owner_id": {
          "id": 18487521,
          "name": "Test Developer",
          "email": "dev@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "org_id": {
          "name": "Test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Test Developer",
          "value": 2
        },
        "name": "test person",
        "first_name": "test",
        "last_name": "person",
        "open_deals_count": 1,
        "related_open_deals_count": 0,
        "closed_deals_count": 0,
        "related_closed_deals_count": 0,
        "participant_open_deals_count": 0,
        "participant_closed_deals_count": 0,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "won_deals_count": 0,
        "related_won_deals_count": 0,
        "lost_deals_count": 0,
        "related_lost_deals_count": 0,
        "active_flag": true,
        "phone": [
          {
            "value": "",
            "primary": true
          }
        ],
        "email": [
          {
            "value": "",
            "primary": true
          }
        ],
        "first_char": "t",
        "update_time": "2024-09-27 14:25:28",
        "delete_time": null,
        "add_time": "2024-09-27 14:25:27",
        "visible_to": "3",
        "picture_id": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "label_ids": [],
        "im": [
          {
            "value": "",
            "primary": true
          }
        ],
        "postal_address": null,
        "postal_address_lat": null,
        "postal_address_long": null,
        "postal_address_subpremise": null,
        "postal_address_street_number": null,
        "postal_address_route": null,
        "postal_address_sublocality": null,
        "postal_address_locality": null,
        "postal_address_admin_area_level_1": null,
        "postal_address_admin_area_level_2": null,
        "postal_address_country": null,
        "postal_address_postal_code": null,
        "postal_address_formatted_address": null,
        "notes": null,
        "birthday": null,
        "job_title": null,
        "org_name": "Test",
        "owner_name": "Test Developer",
        "primary_email": null,
        "5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": null,
        "3cf151d1c54a8c13329a97403054d6306fe4680c": null,
        "cc_email": "test-sandbox@pipedrivemail.com"
      },
      {
        "id": 4,
        "company_id": 12882925,
        "owner_id": {
          "id": 18487521,
          "name": "Test Developer",
          "email": "dev@test.dev",
          "has_pic": 0,
          "pic_hash": null,
          "active_flag": true,
          "value": 18487521
        },
        "org_id": {
          "name": "Test",
          "people_count": 2,
          "owner_id": 18487521,
          "address": null,
          "active_flag": true,
          "cc_email": "test-sandbox@pipedrivemail.com",
          "label_ids": [],
          "owner_name": "Test Developer",
          "value": 2
        },
        "name": "awesome person",
        "first_name": "awesome",
        "last_name": "person",
        "open_deals_count": 1,
        "related_open_deals_count": 0,
        "closed_deals_count": 0,
        "related_closed_deals_count": 0,
        "participant_open_deals_count": 0,
        "participant_closed_deals_count": 0,
        "email_messages_count": 0,
        "activities_count": 0,
        "done_activities_count": 0,
        "undone_activities_count": 0,
        "files_count": 0,
        "notes_count": 0,
        "followers_count": 1,
        "won_deals_count": 0,
        "related_won_deals_count": 0,
        "lost_deals_count": 0,
        "related_lost_deals_count": 0,
        "active_flag": true,
        "phone": [
          {
            "value": "",
            "primary": true
          }
        ],
        "email": [
          {
            "value": "",
            "primary": true
          }
        ],
        "first_char": "a",
        "update_time": "2024-09-27 14:25:53",
        "delete_time": null,
        "add_time": "2024-09-27 14:25:53",
        "visible_to": "3",
        "picture_id": null,
        "next_activity_date": null,
        "next_activity_time": null,
        "next_activity_id": null,
        "last_activity_id": null,
        "last_activity_date": null,
        "last_incoming_mail_time": null,
        "last_outgoing_mail_time": null,
        "label": null,
        "label_ids": [],
        "im": [
          {
            "value": "",
            "primary": true
          }
        ],
        "postal_address": null,
        "postal_address_lat": null,
        "postal_address_long": null,
        "postal_address_subpremise": null,
        "postal_address_street_number": null,
        "postal_address_route": null,
        "postal_address_sublocality": null,
        "postal_address_locality": null,
        "postal_address_admin_area_level_1": null,
        "postal_address_admin_area_level_2": null,
        "postal_address_country": null,
        "postal_address_postal_code": null,
        "postal_address_formatted_address": null,
        "notes": null,
        "birthday": null,
        "job_title": null,
        "org_name": "Test",
        "owner_name": "Test Developer",
        "primary_email": null,
        "5f1513c3d8ba7f34c0164f3f909280c3fa0c592e": null,
        "3cf151d1c54a8c13329a97403054d6306fe4680c": null,
        "cc_email": "test-sandbox@pipedrivemail.com"
      }
    ],
    "additional_data": {
      "next_cursor": "1234567890"
    }
  }
}

Get Pipeline

Get one pipeline | key: getPipeline

Input	Notes	Example
Connection
Pipeline ID	The ID of the pipeline
Totals Convert Currency	The 3-letter currency code of any of the supported currencies

Get Pipeline Conversion Statistics

Get deals conversion rates in pipeline | key: getPipelineConversionStatistics

Input	Notes	Example
Connection
End Date	The end of the period
Pipeline ID	The ID of the pipeline
Start Date	The start of the period
User ID	The ID of the user who"s pipeline metrics statistics to fetch

Get Pipeline Deals

Get deals in a pipeline | key: getPipelineDeals

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Filter ID	If supplied, only deals matching the given filter will be returned
Pipeline ID	The ID of the pipeline
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.	desc
Stage ID	If supplied, only deals within the given stage will be returned

Get Pipeline Movement Statistics

Get deals movements in pipeline | key: getPipelineMovementStatistics

Input	Notes	Example
Connection
End Date	The end of the period
Pipeline ID	The ID of the pipeline
Start Date	The start of the period
User ID	The ID of the user who"s pipeline statistics to fetch

Get Pipelines

Get all pipelines | key: getPipelines

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

Get Product

Get one product | key: getProduct

Input	Notes	Example
Connection
Product ID	The ID of the product	123

Get Product Deals

Get deals where a product is attached to | key: getProductDeals

Input	Notes	Example
Connection
Product ID	The ID of the product	123
Limit	Items shown per page
Start	Pagination start	0
Status	Only fetch deals with a specific status

Get Product Field

Get one product field | key: getProductField

Input	Notes	Example
Connection
Product Field ID	The ID of the product field

Get Product Fields

Get all product fields | key: getProductFields

Input	Notes	Example
Connection
Limit	Items shown per page
Start	Pagination start	0

Get Product Files

List files attached to a product | key: getProductFiles

Input	Notes	Example
Connection
Product ID	The ID of the product	123
Include Deleted Files	When enabled, the list of files will also include deleted files
Limit	Items shown per page
Sort	The field names and sorting mode separated by a comma ("field_name_1 ASC", "field_name_2 DESC")
Start	Pagination start	0

Get Product Followers

List followers of a product | key: getProductFollowers

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Product ID	The ID of the product	123
Limit	Items shown per page

Get Product Users

List permitted users | key: getProductUsers

Input	Notes	Example
Connection
Product ID	The ID of the product	123

Get Products

Get all products | key: getProducts

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Filter ID	The ID of the filter to use
Ids	An array of integers with the IDs of the products that should be returned in the response
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

Get Stage

Get one stage | key: getStage

Input	Notes	Example
Connection
Stage ID	The ID of the stage

Get Stage Deals

Get deals in a stage | key: getStageDeals

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Filter ID	If supplied, only deals matching the given filter will be returned
Stage ID	The ID of the stage
Limit	Items shown per page
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

Get Stages

Get all stages | key: getStages

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Limit	Items shown per page
Pipeline ID	The ID of the pipeline to fetch stages for
Sort By	The field name to sort by	title
Sort Direction	The sorting direction.

Get Subscription (Deprecated)

Get details of a subscription | key: getSubscription

Input	Notes	Example
Connection
Subscription ID	The ID of the subscription

Get Subscription Payments (Deprecated)

Get all payments of a subscription | key: getSubscriptionPayments

Input	Notes	Example
Connection
Subscription ID	The ID of the subscription

Get User

Get one user by ID | key: getUser

Input	Notes	Example
Connection
User ID	The ID of the user

Get User Call Logs

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

Input	Notes	Example
Connection
Limit	Items shown per page
Start	Pagination start	0

Get User Connections

Get all user connections | key: getUserConnections

Input	Notes	Example
Connection

Get User Followers

List followers of a user | key: getUserFollowers

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
User ID	The ID of the user
Limit	Items shown per page

Get User Permissions

List user permissions | key: getUserPermissions

Input	Notes	Example
Connection
User ID	The ID of the user

Get User Role Assignments

List role assignments | key: getUserRoleAssignments

Input	Notes	Example
Connection
User ID	The ID of the user
Limit	Items shown per page
Start	Pagination start	0

Get User Role Settings

List user role settings | key: getUserRoleSettings

Input	Notes	Example
Connection
User ID	The ID of the user

Get User Settings

List settings of an authorized user | key: getUserSettings

Input	Notes	Example
Connection

Get Users

Get all users | key: getUsers

Input	Notes	Example
Connection

List Files

List all files attached to all entities | key: getFiles

Input	Notes	Example
Connection
Limit	Items shown per page
Start	Pagination start	0

{
  "data": {
    "success": true,
    "data": [
      {
        "id": 123,
        "user_id": 456,
        "deal_id": 1,
        "person_id": 789,
        "org_id": 1,
        "product_id": 1,
        "activity_id": 1,
        "lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
        "log_id": null,
        "add_time": "2020-02-20 14:36:35",
        "update_time": "2020-02-20 14:57:33",
        "file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
        "file_type": "img",
        "file_size": 7801780,
        "active_flag": true,
        "inline_flag": false,
        "remote_location": "googledocs",
        "remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
        "cid": "",
        "s3_bucket": "",
        "mail_message_id": "",
        "mail_template_id": "",
        "deal_name": "",
        "person_name": "Person",
        "lead_name": "Test lead name",
        "org_name": "",
        "product_name": "",
        "url": "https://2a7f.pipedrive.com/v1/files/123/download",
        "name": "test file name",
        "description": "test file description"
      }
    ],
    "additional_data": {
      "pagination": {
        "start": 0,
        "limit": 100,
        "more_items_in_collection": true,
        "next_start": 100
      }
    }
  }
}

List Webhooks

List all webhooks | key: listWebhooks

Input	Notes	Example
Connection

Merge Deals

Merge two deals | key: mergeDeals

Input	Notes	Example
Connection
Deal ID	The ID of the deal
Merge With ID	The ID of the deal that the deal will be merged with

Merge Organizations

Merge two organizations | key: mergeOrganizations

Input	Notes	Example
Connection
Organization ID	The ID of the organization
Merge With ID	The ID of the organization that the organization will be merged with

Merge Persons

Merge two persons | key: mergePersons

Input	Notes	Example
Connection
Person ID	The ID of the person
Merge With ID	The ID of the person that will not be overwritten

Raw Request

Send raw HTTP request to Pipedrive | key: rawRequest

Input	Notes	Example
Connection
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 version of the API to use.	v1

Search Deals

Search deals | key: searchDeals

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Exact Match	When enabled, 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	Items shown per page
Organization ID	Will filter deals by the provided organization ID
Person ID	Will filter deals by the provided person ID
Status	Will filter deals by the provided specific status
Term	The search term to look for

Search Leads

Search leads | key: searchLeads

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	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	Items shown per page
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

Search organizations | key: searchOrganization

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Exact Match	When enabled, only full exact matches against the given term are returned	false
Fields	A comma-separated string array	address,custom_fields,notes,name
Limit	Items shown per page
Term	The search term to look for

Search Persons

Search persons | key: searchPersons

Input	Notes	Example
Connection
Cursor	For pagination, the marker (an opaque string value) representing the first item on the next page	1234567890
Exact Match	When enabled, 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	Items shown per page
Organization ID	Will filter persons by the provided organization ID
Term	The search term to look for

Set Person Field Value

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

Input	Notes	Example
Connection
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

Update a deal | key: updateDeal

Input	Notes	Example
Connection
Currency	The currency of the deal
Expected Close Date	The expected close date of the deal
Deal ID	The ID of the deal
Lost Reason	The optional message about why the deal was lost (to be used when status = lost)
Org ID	The ID of an organization which this deal will be linked to
Person ID	The ID of a person which this deal will be linked to
Pipeline ID	The ID of the pipeline this deal will be added to
Probability	The success probability percentage of the deal
Stage ID	The ID of the stage this deal will be added to
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

Update 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
Discount Percentage	The discount %	0
Discount Type	The type of discount
Deal ID	The ID of the deal
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

Update file name or description | key: updateFile

Input	Notes	Example
Connection
Description
File ID	The ID of a file
File Name

{
  "data": {
    "success": true,
    "data": {
      "id": 123,
      "user_id": 456,
      "deal_id": 1,
      "person_id": 789,
      "org_id": 1,
      "product_id": 1,
      "activity_id": 1,
      "lead_id": "adf21080-0e10-11eb-879b-05d71fb426ec",
      "log_id": null,
      "add_time": "2020-02-20 14:36:35",
      "update_time": "2020-02-20 14:57:33",
      "file_name": "IMG_8189_52233498214699de9579e7b304a81b157b2eb2137e8062.jpg",
      "file_type": "img",
      "file_size": 7801780,
      "active_flag": true,
      "inline_flag": false,
      "remote_location": "googledocs",
      "remote_id": "1mT6jshiv6537IirwOExXJuG1jdR4F0FQ",
      "cid": "",
      "s3_bucket": "",
      "mail_message_id": "",
      "mail_template_id": "",
      "deal_name": "",
      "person_name": "Person",
      "org_name": "",
      "product_name": "",
      "lead_name": "Test lead name",
      "url": "https://2a7f.pipedrive.com/v1/files/123/download",
      "name": "test file name",
      "description": "test file description"
    }
  }
}

Update Filter

Update filter | key: updateFilter

Input	Notes	Example
Conditions	The conditions of the filter as a JSON object
Connection
Filter ID	The ID of the filter
Name	The name of the filter

Update Lead

Update a lead | key: updateLead

Input	Notes	Example
Connection
Expected Close Date	The date of when the deal which will be created from the lead is expected to be closed
Lead ID	The ID of the lead
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

Update a lead label | key: updateLeadLabel

Input	Notes	Example
Color	The color of the label
Connection
Lead Label ID	The ID of the lead label
Name	The name of the lead label

Update Organization

Update an organization | key: updateOrganization

Input	Notes	Example
Connection
Organization ID	The ID of the organization
Name	The name of the organization
Owner ID	The ID of the user who will be marked as the owner of this organization
Visible To	The visibility of the organization

Update Person

Update a person | key: updatePerson

Input	Notes	Example
Connection
Emails	List of email data related to the person	email1@example.com,email2@example.com
Person ID	The ID of the person
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
Org ID	The ID of the organization this person will belong to
Owner ID	The ID of the user who will be marked as the owner of this person
Phones	List of phone data related to the person	+1234567890,+1234567890
Visible To	The visibility of the person

Update Pipeline

Update a pipeline | key: updatePipeline

Input	Notes	Example
Connection
Pipeline ID	The ID of the pipeline
Deal Probability	Whether deal probability is disabled or enabled for this pipeline	false
Name	The name of the pipeline

Update Product

Update a product | key: updateProduct

Input	Notes	Example
Code	The product code
Connection
Product ID	The ID of the product	123
Name	The name of the product
Owner ID	The ID of the user who will be marked as the owner of this product
Prices	An array of objects, each containing: "currency" (string), "price" (number), "cost" (number, optional), "overhead_cost" (number, optional)
Tax	The tax percentage	0
Unit	The unit in which this product is sold
Visible To	The visibility of the product

Update Stage

Update stage details | key: updateStage

Input	Notes	Example
Connection
Deal Probability	The success probability percentage of the deal
Stage ID	The ID of the stage
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

2025-10-17

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

Manage leads, companies, activities, and more on the Pipedrive platform

Description​

Connections​

OAuth 2.0​

Pipedrive Custom Redirect URIs​

Triggers​

Webhook Trigger​

Data Sources​

Select Deal​

Select Organization​

Select Person​

Actions​

Add Call Log​

Add Channel​

Add Deal​

Add Deal Follower​

Add Deal Participant​

Add Deal Product​

Add File​

Add Lead​

Add Lead Label​

Add Organization​

Add Organization Follower​

Add Person​

Add Person Follower​

Add Pipeline​

Add Product​

Add Product Follower​

Add Stage​

Cancel Recurring Subscription (Deprecated)​

Create Webhook​

Delete Activity​

Delete Call Log​

Delete Channel​

Delete Conversation​

Delete Deal​

Delete Deal Field​

Delete Deal Follower​

Delete Deal Participant​

Delete Deal Product​

Delete File​

Delete Lead​

Delete Lead Label​

Delete Mail Thread​

Delete Organization​

Delete Organization Follower​

Delete Person​

Delete Person Field​

Delete Person Follower​

Delete Person Picture​

Delete Pipeline​

Delete Product​

Delete Product Field​

Delete Product Follower​

Delete Stage​

Delete Subscription (Deprecated)​

Delete Webhook​

Download File​

Find Subscription By Deal (Deprecated)​

Find Users By Name​

Get Activities​

Get Activity​

Get Activity Fields​

Get Activity Types​

Get Call Log​

Get Company Addons​

Get Currencies​

Get Current User​

Get Deal​

Get Deal Activities​

Get Deal Field​

Get Deal Fields​

Get Deal Files​

Get Deal Followers​

Get Deal Mail Messages​

Get Deal Participants​

Get Deal Persons (Deprecated)​

Get Deal Products​

Get Deal Users​

Get Deals​