Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing
Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing On Nagent, Pipedrive is exposed as a fully-configurable crm integration that any agent can call — 401 actions, 3 triggers, and OAUTH2, API_KEY authentication. No code is required to wire Pipedrive into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Pipedrive to automate the kinds of tasks crm teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Pipedrive also supports 3 event triggers ("New Deal Received Trigger", "New Note Received Trigger", "New Organization Received Trigger"), which lets your Nagent agents react to Pipedrive activity in real time — for example, kicking off a downstream workflow the moment a relevant event fires.
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Pipedrive into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Triggers are the entry points of agents built on Nagent — pick one to fire your agent the moment a Pipedrive event happens. Webhook triggers run instantly; poll triggers check on an interval you configure. Each shows its configuration parameters and the payload your agent receives.
PIPEDRIVE_NEW_DEAL_TRIGGERTriggered when a new deal is created in Pipedrive
Payload
Currency of the deal
ID of the deal
ID of the pipeline stage
Status of the deal
Title of the deal
ID of the user who created the deal
Value of the deal
PIPEDRIVE_NEW_NOTE_TRIGGERTriggered when a new note is created in Pipedrive
Payload
Time when the note was added
Content of the note
ID of the associated deal
ID of the note
ID of the associated organization
ID of the associated person
ID of the user who created the note
PIPEDRIVE_NEW_ORGANIZATION_TRIGGERTriggered when a new organization is created in Pipedrive
Payload
Address of the organization
Email of the organization
ID of the organization
Name of the organization
ID of the organization owner
Phone number of the organization
Website of the organization
Every operation an agent can call against Pipedrive, with input parameters and output schema. Drop these into any step of an agent built in Helix.
PIPEDRIVE_ADD_ACTIVITY_TYPEAdds a new activity type.
Input parameters
The name of the activity type
A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
Icon graphic to use for representing this activity type
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_A_DEALAdd a new deal to Pipedrive with any custom fields, which vary by account and are identified by long hash keys. Check dealFields for existing custom fields. For details, visit the tutorial on adding a deal.
Input parameters
The deal title
Monetary value of the deal
ID of the organization
Status of the deal (open, won, lost). Defaults to open
ID of the user who will be marked as owner of this deal
Currency for the deal value (3-letter ISO code)
Stage ID for the deal
ID of the person this deal is linked to
Visibility of the deal (owner, entire company etc)
Pipeline ID for the deal
Success probability percentage (0-100)
Expected close date in format YYYY-MM-DD
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_AN_ACTIVITYNew activity added. Response includes `more_activities_scheduled_in_context` to show if more are planned with the same entity. See tutorial on adding activities \[here\](https://pipedrive.readme.io/docs/adding-an-activity).
Input parameters
Whether the activity is done (0 = not done, 1 = done)
Note/description of the activity
The type of the activity (matches ActivityTypes.key_string)
ID of the linked organization
ID of the linked deal (integer or numeric string)
ID of the linked lead (UUID string)
The subject/title of the activity
ID of the user who owns the activity
Due date of the activity (YYYY-MM-DD)
Due time of the activity (HH:MM)
Duration of the activity (e.g., 00:30)
Location/address of the activity
Attendees of the activity (contacts or external emails)
Whether the activity marks the assignee as busy
ID of the linked person
ID of the linked project
Participants of the activity
Public description synced to external calendar
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_AN_ORGANIZATIONCreates a new organization in Pipedrive. The 'name' parameter is required and represents the organization's name (e.g., 'Acme Corp'). Optionally specify 'owner_id' to assign an owner and 'visible_to' for visibility settings. Custom fields can also be added using field keys from organizationFields.
Input parameters
The name of the organization to create (required). This is typically a company or business name such as 'Acme Corp' or 'Tech Solutions Inc.'
Owner user ID
Visibility (e.g., 1=owner only, 3=entire company)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_A_NOTEDEPRECATED: Use PIPEDRIVE_PIPEDRIVE_ADD_NOTE instead. Add a note to a deal, person, organization, lead, or project in Pipedrive. At least one of deal_id, person_id, org_id, lead_id, or project_id must be provided.
Input parameters
The ID of the organization this note will be attached to. Required unless one of (deal_id/person_id/lead_id/project_id) is specified.
The content of the note in HTML format. Subject to sanitization on the back-end.
The ID of the deal the note will be attached to. Required unless one of (lead_id/person_id/org_id/project_id) is specified.
The ID of the lead the note will be attached to (UUID format). Required unless one of (deal_id/person_id/org_id/project_id) is specified.
The optional creation date & time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
The ID of the person this note will be attached to. Required unless one of (deal_id/lead_id/org_id/project_id) is specified.
The ID of the project the note will be attached to. Required unless one of (deal_id/person_id/org_id/lead_id) is specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_A_PERSONAdd a new contact in Pipedrive with optional custom fields unique to each account found using the `personFields` endpoint. The endpoint also handles `data.marketing_status` for Campaigns product users.
Input parameters
The name of the person. REQUIRED by Pipedrive API.
List of email objects: { value: string, label?: string, primary?: bool }
List of phone objects: { value: string, label?: string, primary?: bool }
ID of the linked organization
Creation time (RFC 3339)
ID of the user who will be marked as the owner of this person
IDs of labels to assign to the person
Visibility of the person (e.g., 1=owner only, 3=entire company)
Last update time (RFC 3339)
Marketing status (no_consent, unsubscribed, subscribed, archived). Field is available only when Campaigns is enabled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_CALL_LOGAdds a new call log.
Input parameters
The note for the call log in HTML format
The ID of the organization this call is associated with
The ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once.
The ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once.
Describes the outcome of the call
The name of the activity this call is attached to
The ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users.
The duration of the call in seconds
The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
The ID of the person this call is associated with
The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
If specified, this activity will be converted into a call log, with the information provided. When this field is used, you don"t need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity.
The number called
The number that made the call
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_CALL_LOG_AUDIO_FILETool to attach an audio recording to an existing call log in Pipedrive. Use when you need to add audio evidence to a call log. Only one recording per call log is allowed.
Input parameters
The ID of the call log to attach the recording to. This is the ID received when you create the call log.
Audio file to upload. FileType object with 'name' (audio filename e.g., 'recording.mp3', 'audio.wav') and 'content' (base64-encoded audio data). Must be an HTML5-compatible audio format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_CHANNELNew messaging channel added; registration limited to admins. Utilizes getConversations endpoint for data retrieval. Requires Messengers integration OAuth scope and a prepared Messaging app extension manifest.
Input parameters
The name of the channel
The URL for an icon that represents your channel
It controls the icons (like the icon next to the conversation)
If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more \[here\](https://pipedrive.readme.io/docs/implementing-messaging-app-extension).
The channel ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_DEAL_DISCOUNTTool to add a discount to a deal in Pipedrive. Use when you need to apply a percentage-based or fixed amount discount to an existing deal.
Input parameters
The ID of the deal to add the discount to
Determines whether the discount is applied as a percentage or a fixed amount
The discount amount. Must be a positive number (excluding 0).
The name of the discount
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_DEAL_FIELDAdds a new deal field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.
Input parameters
The name of the field
When `field_type` is either `set` or `enum`, possible options must be supplied \[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}\]
The type of the field. Supported values: varchar, varchar_auto, text, double, monetary, date, set, enum, user, org, people, phone, time, timerange, daterange, address
Whether the field is available in "add new" modal or not (both in web and mobile app)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_DEALFIELDS_OPTIONSTool to add new options to a deal custom field atomically. Use when you need to add options to enum or set type deal fields.
Input parameters
Array of option objects to add. At least one option is required. Each option must have a label. This is an atomic operation - either all options are added or none.
The unique code identifying the deal field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_DEAL_FOLLOWERAdds a follower to a deal.
Input parameters
The ID of the deal
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_DEAL_PARTICIPANTAdds a participant to a deal.
Input parameters
The ID of the deal
The ID of the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_DEAL_PRODUCTTool to add a product to a deal in Pipedrive. Use when you need to attach a product to an existing deal with custom pricing, quantity, duration, discount, and tax settings.
Input parameters
The ID of the deal to which the product will be added
The product tax percentage
Notes or comments about the product
The value of the discount (use with discount_type to specify if amount or percentage)
Duration value for the product
The quantity of the product to add
Whether this product is enabled for the deal (cannot be disabled if deal has installments and product is the last enabled one)
The price value at which this product is added to the deal
The ID of the product to attach to the deal
Tax application method: 'exclusive' (tax not included in price), 'inclusive' (tax already included in price), or 'none' (no tax). Defaults to user setting. Changing this affects all products attached to the deal
Specifies whether discount is a 'percentage' or 'amount'
How often the product is billed (Growth+ plans only): 'one-time', 'annually', 'semi-annually', 'quarterly', 'monthly', or 'weekly'
Billing start date in YYYY-MM-DD format (within ±10 years from today)
Discount percentage (legacy parameter, use discount + discount_type instead)
The ID of the product variation if applicable
Number of times the billing frequency repeats (must be positive integer, maximum 208)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_DEAL_PRODUCTSTool to bulk add products to a Pipedrive deal. Use when attaching multiple products simultaneously, with maximum 100 products per request.
Input parameters
The ID of the deal to which products will be attached
Array of product objects to attach to the deal. Maximum 100 products per request.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_FILEUpload and link files to deals, people, organizations, activities, products, or leads in Pipedrive. See the "adding a file" tutorial for details.
Input parameters
File to upload (base64 content supported)
Org Id
Deal Id
Lead Id (UUID)
Person Id
Product Id
Activity Id
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_FILTERNew filter creation returns an ID. Only one primary condition group with 'AND' and two secondary groups (one 'AND', one 'OR') are supported. Future syntax expansion possible. See tutorial for details.
Input parameters
The name of the filter
The type of the filter. One of: deals, leads, org, people, products, activity, projects
Filter conditions object. Must follow structure with a top-level 'and' group containing two groups (one 'and' and one 'or').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_GOALAdds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
Input parameters
The type of the goal and its parameters
The title of the goal
The assignee of the goal
Goal active duration
The interval of the goal
Expected outcome configuration
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_INCOMING_MESSAGEAdds a message to a conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the \[Messaging app extension\](https://pipedrive.readme.io/docs/messaging-app-extension).
Input parameters
The ID of the message
The status of the message
The body of the message
The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM
The ID of the provider"s user that sent the message
The channel ID as in the provider
The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM
The list of attachments available in the message
The ID of the conversation
A URL that can open the conversation in the provider"s side
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_INSTALLMENT_SUBSCRIPTIONAdds a new installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action overrides the default request behavior and uses the public API host (api.pipedrive.com) explicitly.
Input parameters
The ID of the deal this installment subscription is associated with
The currency of the installment subscription. Accepts a 3-character currency code.
Array of payments. It requires a minimum structure as follows: \[{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }\]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
Indicates that the deal value must be set to the installment subscription"s total value
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_LEADPipedrive API lets you add leads linked to people or organizations and tags them with 'API' source. Custom fields from deals apply to leads and appear in responses if set. Details are in the tutorials for adding and updating leads.
Input parameters
The name of the lead
The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.
A flag indicating whether the lead was seen by someone in the Pipedrive UI
The IDs of the lead labels which will be associated with the lead
REQUIRED if organization_id is not provided. The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. At least one of person_id or organization_id must be set.
Amount
REQUIRED if person_id is not provided. The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. At least one of person_id or organization_id must be set.
Currency
The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_LEAD_LABELCreates a lead label.
Input parameters
The name of the lead label
The color of the label. Only a subset of colors can be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_NOTETool to add a note to a deal, person, organization, lead, or project in Pipedrive. Use when you need to create a note attached to an entity. At least one entity ID (lead_id, deal_id, person_id, org_id, or project_id) must be provided.
Input parameters
The ID of the organization to attach the note to. At least one of lead_id, deal_id, person_id, org_id, or project_id must be provided.
The content of the note in HTML format. Subject to sanitization on the back-end.
The ID of the deal to attach the note to. At least one of lead_id, deal_id, person_id, org_id, or project_id must be provided.
The ID of the lead to attach the note to (UUID format). At least one of lead_id, deal_id, person_id, org_id, or project_id must be provided.
The ID of the user who will be marked as the author of the note. Only admins can change this.
The creation timestamp for the note in UTC. Format: YYYY-MM-DD HH:MM:SS
The ID of the person to attach the note to. At least one of lead_id, deal_id, person_id, org_id, or project_id must be provided.
The ID of the project to attach the note to. At least one of lead_id, deal_id, person_id, org_id, or project_id must be provided.
If set to 1, the note will be pinned to the deal. 0 or omit to not pin.
If set to 1, the note will be pinned to the lead. 0 or omit to not pin.
If set to 1, the note will be pinned to the person. 0 or omit to not pin.
If set to 1, the note will be pinned to the project. 0 or omit to not pin.
If set to 1, the note will be pinned to the organization. 0 or omit to not pin.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_NOTE_COMMENTTool to add a comment to an existing note in Pipedrive. Use when you need to add commentary or updates to notes linked to deals, persons, or organizations.
Input parameters
The ID of the note to add a comment to.
The content of the comment in HTML format. Subject to sanitization on the back-end.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_ORGANIZATION_FIELDAdds a new organization field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.
Input parameters
The name of the field
When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`\[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}\]`
The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>
Whether the field is available in "add new" modal or not (both in web and mobile app)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_ORGANIZATION_FIELD_OPTIONSTool to add new options to an organization field in Pipedrive. Use when you need to add new choices to enum or set type organization fields. This is an atomic operation where all options are added or none.
Input parameters
Array of option objects to add to the field. At least one option must be provided. This is an atomic operation - all options are added or none.
The unique code identifying the organization field (enum or set type) to add options to
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_ORGANIZATION_FOLLOWERTool to add a follower to an organization in Pipedrive. Use when you need to create a follower relationship between a user and an organization entity.
Input parameters
The ID of the organization
The ID of the user to add as a follower to the organization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_OR_UPDATE_ROLE_SETTINGAdds or updates the visibility setting for a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the base URL accordingly.
Input parameters
The ID of the role
Possible values for the `default_visibility` setting depending on the subscription plan:<br> <table class="role-setting"> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class="role-setting"> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href="https://support.pipedrive.com/en/article/visibility-groups">here</a>.
Setting Key
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PERSON_FIELDAdds a new person field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.
Input parameters
The name of the field
When field_type is either set or enum, possible options must be supplied as a JSON-encoded sequential array, for example: \[{"label":"red"}, {"label":"blue"}\]
Optional API token to use as query parameter when OAuth scope does not permit POST; if provided, overrides Authorization header.
The type of the field. Allowed: address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to.
Whether the field is available in the add new modal (web and mobile). Default true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PERSONFIELDS_OPTIONSTool to bulk add options to enum/set person fields atomically. Use when you need to add new options to a person field.
Input parameters
Array of option objects to create. Each object must contain a 'label' field. At least one option is required. The operation is atomic - all options are added or none are added.
The unique code identifying the person field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PERSON_FOLLOWERTool to add a follower to a person in Pipedrive. Use when you need to create a follower relationship between a user and a person entity.
Input parameters
The ID of the person to add a follower to
The ID of the user to add as a follower to the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PERSON_PICTUREThis service allows adding a photo to a person's profile, replacing any existing one. Images must be square with a minimum size of 128 pixels and in GIF, JPG, or PNG formats. They will be resized to 128 and 512 pixels.
Input parameters
The ID of the person
Image file to set as the person's picture (GIF/JPG/PNG)
Crop X (pixels)
Crop Y (pixels)
Crop width (pixels)
Crop height (pixels)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PIPELINEAdds a new pipeline (v2).
Input parameters
The name of the pipeline
Whether deal probability is enabled for this pipeline
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PRODUCTAdds a new product to the Products inventory. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-product" target="_blank" rel="noopener noreferrer">adding a product</a>.
Input parameters
Tax percentage
Product code
Product name; cannot be empty
Sales unit of the product
Array of prices per currency
Product category
Owner user ID; if omitted, authorized user ID is used
Product visibility setting
Product description
Whether the product can be added to a deal
Billing frequency (one-time, annually, semi-annually, quarterly, monthly, weekly)
Number of billing repeats (rules depend on billing_frequency)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PRODUCT_FIELDAdds a new product field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-new-custom-field" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.
Input parameters
The name of the field
When `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`\[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}\]`
The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table>
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PRODUCTFIELDS_OPTIONSTool to add new options to a product custom field that supports options (enum or set field types). Use when you need to expand the available choices for a product field. This operation is atomic - all options are added or none are added.
Input parameters
Array of option objects to add. At least one option is required. Each option must have a label field.
The unique code identifying the field to add options to. This field must be of type enum or set.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PRODUCT_FOLLOWERTool to add a follower to a product in Pipedrive. Use when you need to have a user follow a specific product for updates and notifications.
Input parameters
The ID of the product to which the follower will be added
The ID of the user to add as a follower to the product
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PRODUCT_IMAGETool to upload an image for a product in Pipedrive. Use when you need to add a visual representation to a product.
Input parameters
The ID of the product to add the image to
The image file to upload (PNG, JPG, GIF). Provide the file content as base64-encoded string.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PRODUCT_VARIATIONTool to create a new product variation for an existing product. Use when you need to add a variation with customizable name and prices in multiple currencies.
Input parameters
The ID of the product to add the variation to
The name of the product variation (maximum 255 characters)
Array of price objects for different currencies. If omitted, system assigns default values: price of 0, cost of 0, direct_cost of 0, and the user's default currency. Only one price per variation per currency is supported.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_PROJECTAdds a new project. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys.
Input parameters
The title of the project
IDs of labels for this project
ID of associated organization
Project status
The ID of a project board
IDs of deals associated with this project
Project end date (YYYY-MM-DD)
Project owner's ID
The ID of a phase on the project board
ID of associated person
Project start date (YYYY-MM-DD)
Project description
ID of the template the project will be based on
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_RECURRING_SUBSCRIPTIONAdds a new recurring subscription.
Input parameters
The ID of the deal this recurring subscription is associated with
The currency of the recurring subscription. Accepts a 3-character currency code.
This indicates that the recurring subscription will last until it"s manually canceled or deleted. Note that only one field must be set: `cycles_count` or `infinite`.
Array of additional payments. It requires a minimum structure as follows: \[{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }\]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
The start date of the recurring subscription. Format: YYYY-MM-DD
The description of the recurring subscription
The interval between payments
The amount of each payment
Shows how many payments the subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required.
Indicates that the deal value must be set to recurring subscription"s MRR value
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_ROLEAdds a new role. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain base URL with `/api/v1` path. Example: https://{COMPANY}.pipedrive.com/api/v1/roles - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used.
Input parameters
The name of the role
The ID of the parent role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_ROLE_ASSIGNMENTAssigns a user to a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/assignments - This action normalizes the base URL accordingly and ensures JSON body is sent.
Input parameters
The ID of the role
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_STAGEAdds a new stage, returns the ID upon success.
Input parameters
The name of the stage
The ID of the pipeline to add stage to
The number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. (v2: days_to_rotten)
Whether deals in this stage can become rotten (v1: rotten_flag; v2: is_deal_rot_enabled)
The success probability percentage of the deal. Used/shown when deal weighted values are used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_TASKAdds a new task.
Input parameters
0 = Not done, 1 = Done
The title of the task
The task’s due date (YYYY-MM-DD)
The ID of a project
The assignee user ID
The description of the task
The ID of a parent task; cannot be a subtask’s ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_TEAMAdds a new team to the company and returns the created object.
Input parameters
The team name
The list of user IDs
The team manager ID
The team description
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_TEAM_USERSAdds users to an existing team.
Input parameters
The ID of the team
The list of user IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ADD_USERAdds a new user to the company, returns the ID upon success.
Input parameters
The email of the user
The access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: `\[{ app: "sales", permission_set_id: "62cc4d7f-4038-4352-abf3-a8c1c822b631" }, { app: "global", admin: true }, { app: "account_settings" }\]`
Whether the user is active or not. `false` = Not activated, `true` = Activated
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ARCHIVE_PROJECTArchives a project.
Input parameters
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_CANCEL_RECURRING_SUBSCRIPTIONCancels a recurring subscription. This action attempts to cancel a recurring subscription via Subscriptions API. If Subscriptions endpoints are unavailable (404), it gracefully falls back to disabling all product attachments on the given deal (interpreting `id` as `deal_id`) to mimic cancellation behavior.
Input parameters
The ID of the subscription. Fallback: treated as the deal ID when Subscriptions API is unavailable.
The subscription termination date. All payments after the specified date will be deleted. The end_date of the subscription will be set to the due date of the payment to follow the specified date. Default value is the current date.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_CONVERT_DEAL_TO_LEADTool to convert a Pipedrive deal to a lead asynchronously. Use when you need to move a deal back to the lead stage, transferring related entities like notes, files, emails, and activities. Requires global admin or 'Convert deals to leads' permission.
Input parameters
The ID of the deal to convert to a lead
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_CONVERT_LEAD_TO_DEALTool to convert a Pipedrive lead to a deal asynchronously. Use when you need to convert an existing lead into a deal. The conversion transfers all related entities (notes, files, emails, activities) to the new deal. Upon successful conversion, the lead is marked as deleted. Use the returned conversion_id to check the conversion status.
Input parameters
The ID of the lead to convert (UUID format)
The ID of a stage the created deal will be added to. The pipeline will be assigned automatically based on the stage_id. Do not use both pipeline_id and stage_id together.
The ID of a pipeline the created deal will be added to. The deal will be added to the first stage of the specified pipeline. Note: pipeline_id will be ignored if both pipeline_id and stage_id are provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_CREATE_ORGANIZATION_RELATIONSHIPCreates and returns an organization relationship.
Input parameters
The type of organization relationship
The ID of the base organization for the returned calculated values
The owner of the relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
The linked organization in the relationship. If type is `parent`, then the linked organization is the daughter.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_CREATE_REMOTE_FILE_LINKCreates an empty file on Google Drive linked to an item. For details, refer to the Pipedrive remote file adding tutorial.
Input parameters
The title of the file
The ID of the item to associate the file with
The file type
The item type
The location type to send the file to. Only `googledrive` is supported at the moment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_CREATE_WEBHOOKCreates and returns details of a new Webhook. Trigger events combine `event_action` and `event_object`, like `*.*` for all events or `added.deal`, `deleted.persons` for specific actions. More info in the Webhooks guide.
Input parameters
The webhook’s name
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`.
The webhook"s version
The type of action to receive notifications about. Wildcard will match all supported actions.
The type of object to receive notifications about. Wildcard will match all supported objects.
The HTTP basic auth username of the subscription URL endpoint (if required)
A full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link.
The HTTP basic auth password of the subscription URL endpoint (if required)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_CTIVITYIELDS_GET_ALL_ACTIVITYFIELDSTool to retrieve metadata about all activity fields in the company. Use when you need to get information about field structure, types, options, and properties for activities.
Input parameters
Pagination limit for number of results to return. Default: 100, Maximum: 500
Marker for pagination to fetch the next page of results
Optional comma separated string array of additional data namespaces to include in response (e.g., 'ui_visibility')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DEALS_UPDATE_DEALTool to update product details attached to a deal in Pipedrive using the v2 API. Use when you need to modify product attributes like price, quantity, discount, or tax for a deal-product attachment.
Input parameters
The ID of the deal
Product tax amount (default: 0)
Product notes/comments
Discount value - amount or percentage based on discount_type (default: 0)
Quantity of the product
Whether product is active/enabled for the deal. Note: API v2 uses strict validation - only accepts true/false, not 1/0.
Price value for the product
The product identifier
Tax application method - 'exclusive' (tax not included in price), 'inclusive' (tax included in price), or 'none' (no tax)
Discount type - either 'percentage' or 'amount'
Billing cycle option for Growth+ plans - 'one-time', 'annually', 'semi-annually', 'quarterly', 'monthly', or 'weekly'
When billing commences (Growth+ plans). Format: YYYY-MM-DD
Specific product variation identifier
The ID of the deal-product attachment (correlation ID between deal and product, obtained from GET /deals/{id}/products). This is NOT the same as the product_id.
Number of billing frequency repetitions (Growth+ plans)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ACTIVITIES_BULKMarks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
Input parameters
The comma-separated IDs of activities that will be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ACTIVITYTool to delete an activity in Pipedrive. Use when you need to remove an activity. This is a soft delete operation - the activity will be permanently deleted after 30 days.
Input parameters
The ID of the activity to be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ACTIVITY_TYPETool to delete an activity type in Pipedrive. Use when you need to remove an activity type from the system. The activity type will be marked as deleted (active_flag set to false) rather than permanently removed.
Input parameters
The ID of the activity type to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ACTIVITY_TYPES_BULKMarks multiple activity types as deleted.
Input parameters
The comma-separated activity type IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_AN_ACTIVITYMarks an activity as deleted. After 30 days, the activity will be permanently deleted.
Input parameters
The ID of the activity
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_A_PERSONMarks a person as deleted. After 30 days, the person will be permanently deleted.
Input parameters
The ID of the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_A_PERSON_FIELDMarks a field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.
Input parameters
The ID of the field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_A_STAGEMarks a stage as deleted. Uses the company-domain v2 endpoint.
Input parameters
The ID of the stage
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_CALL_LOGDeletes a call log. If there is an audio recording attached to it, it will also be deleted. The related activity will not be removed by this request. If you want to remove the related activities, please use the endpoint which is specific for activities.
Input parameters
The ID received when you create the call log
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_CHANNELThe endpoint removes a messenger channel along with conversations and messages. Requires Messengers integration OAuth and Messaging app extension manifest.
Input parameters
The ID of the channel provided by the integration
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_COMMENTTool to delete a comment from a note in Pipedrive. Use when you need to remove a specific comment that was previously added to a note. Users can only delete comments they created or if they have admin privileges.
Input parameters
The ID of the note
The ID of the comment in UUID format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_CONVERSATIONDeletes an existing conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the \[Messaging app extension\](https://pipedrive.readme.io/docs/messaging-app-extension).
Input parameters
The ID of the channel provided by the integration
The ID of the conversation provided by the integration
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEALTool to delete a deal in Pipedrive. Use when you need to remove a deal. This is a soft delete operation - the deal will be permanently deleted after 30 days.
Input parameters
The ID of the deal to be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_DISCOUNTTool to delete a discount from a deal in Pipedrive. Use when you need to remove a discount that was previously applied to a deal.
Input parameters
The ID of the deal
The ID of the discount to be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_FIELDTool to delete a deal field in Pipedrive by marking it as deleted. Use when you need to remove a custom deal field.
Input parameters
The ID of the deal field to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_FIELD_OPTIONSTool to remove existing options from a deal custom field atomically. Use when you need to delete options from a deal field.
Input parameters
Array of option objects to delete. At least one option ID is required. The entire request fails if any option does not exist (atomic operation).
The unique code identifying the deal field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_FIELDS_BULKMarks multiple deal fields as deleted.
Input parameters
The comma-separated field IDs to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_FOLLOWERTool to delete a follower from a deal in Pipedrive. Use when you need to remove a user from a deal's follower list.
Input parameters
The ID of the deal
The ID of the follower to be removed from the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_PARTICIPANTDeletes a participant from a deal.
Input parameters
The ID of the deal
The ID of the participant of the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_PRODUCTTool to delete an attached product from a deal in Pipedrive. Use when you need to remove a product that was previously attached to a deal. Note: It is not possible to delete the attached product if the deal has installments associated with it.
Input parameters
The ID of the deal
The product attachment ID. This is returned as product_attachment_id after attaching a product to a deal, or as id when listing the products attached to a deal.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEAL_PRODUCTSTool to delete multiple products from a deal in Pipedrive. Use when you need to remove specific products or all products from a deal. Maximum 100 products can be deleted per request.
Input parameters
The ID of the deal
Comma-separated list of deal product IDs to delete. If not provided, all deal products will be deleted up to 100 items. Maximum 100 IDs allowed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_DEALS_BULKMarks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
Input parameters
The comma-separated IDs that will be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_FILETool to delete a file in Pipedrive. Use when you need to remove a file from the system. The file is marked as deleted immediately but will be permanently deleted after 30 days.
Input parameters
The ID of the file to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_FILTERTool to delete a filter in Pipedrive. Use when you need to remove a specific filter by its ID.
Input parameters
The ID of the filter to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_FILTERS_BULKMarks multiple filters as deleted.
Input parameters
The comma-separated filter IDs to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_GOALMarks a goal as deleted. Notes: - Pipedrive Goals endpoints for OAuth live under `{companydomain}/api/v1`. The default base_url is usually `{companydomain}/v1`, which would yield 404. We therefore normalize the base URL to `/api/v1` before issuing the DELETE.
Input parameters
The ID of the goal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_LEADDeletes a specific lead.
Input parameters
The ID of the lead
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_LEAD_LABELTool to delete a specific lead label from Pipedrive. Use when you need to remove a lead label using its UUID identifier.
Input parameters
The UUID identifier of the lead label to be deleted. Must be in UUID format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_MAIL_THREADMarks a mail thread as deleted.
Input parameters
The ID of the mail thread
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_MULTIPLE_PRODUCT_FIELDSMarks multiple fields as deleted.
Input parameters
The comma-separated field IDs to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_MULTIPLE_STAGESMarks multiple stages as deleted (v1). Note: This endpoint may be deprecated; we keep compatibility and avoid raising to surface API errors in response.
Input parameters
The comma-separated stage IDs to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_NOTEDeletes a specific note.
Input parameters
The ID of the note
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ORGANIZATIONTool to delete an organization in Pipedrive. Use when you need to mark an organization as deleted. The organization will be permanently deleted after 30 days.
Input parameters
The ID of the organization to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ORGANIZATION_FIELDMarks a field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.
Input parameters
The ID of the field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ORGANIZATION_FIELD_OPTIONSTool to delete specified options from an organization field in Pipedrive. Use when you need to remove one or more options from an organization field by field code. The operation is atomic: if any option ID does not exist, the entire request fails and no options are deleted.
Input parameters
Array of option objects to delete. At least one option ID must be provided. The operation is atomic: the entire request fails if any specified option ID does not exist.
The unique code identifying the organization field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ORGANIZATION_FIELDS_BULKMarks multiple fields as deleted.
Input parameters
The comma-separated field IDs to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ORGANIZATION_FOLLOWERTool to delete a follower from an organization in Pipedrive. Use when you need to remove a user from an organization's follower list.
Input parameters
The ID of the organization
The ID of the follower to be removed from the organization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ORGANIZATION_RELATIONSHIPDeletes an organization relationship and returns the deleted ID.
Input parameters
The ID of the organization relationship
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ORGANIZATIONS_BULKMarks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
Input parameters
The comma-separated IDs that will be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PERSONTool to delete a person in Pipedrive. Use when you need to mark a person as deleted. The person will be permanently deleted after 30 days.
Input parameters
The ID of the person to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PERSON_FIELDTool to delete a person field from Pipedrive. Use when you need to remove a custom person field by its unique identifier.
Input parameters
The unique identifier of the person field to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PERSON_FIELD_OPTIONSTool to remove existing options from a person custom field atomically. Use when you need to delete options from a person field.
Input parameters
Array of option objects to delete. At least one option ID is required. The entire request fails if any option does not exist (atomic operation).
The unique code identifying the person field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PERSON_FIELDS_BULKMarks multiple fields as deleted.
Input parameters
The comma-separated field IDs to delete
Optional API token to use as query parameter when OAuth scope does not permit DELETE; if provided, overrides Authorization header.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PERSON_FOLLOWERDeletes a follower from a person.
Input parameters
The ID of the person
The ID of the follower
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PERSON_PICTUREDeletes a person’s picture. Note: Pipedrive may return a 400 with error "Item not found" when the person has no picture set. Since delete is idempotent, we treat this specific case as a successful no-op and return a normalized response rather than raising.
Input parameters
The ID of the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PERSONS_BULKMarks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
Input parameters
The comma-separated IDs that will be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PIPELINEMarks a pipeline as deleted.
Input parameters
The ID of the pipeline
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PRODUCTMarks a product as deleted. After 30 days, the product will be permanently deleted.
Input parameters
The ID of the product
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PRODUCT_FIELDMarks a product field as deleted. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/deleting-a-custom-field" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.
Input parameters
The ID of the product field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PRODUCT_FIELD_OPTIONSTool to remove existing options from a product custom field atomically. Use when you need to delete options from a product field.
Input parameters
Array of option objects to delete. At least one option ID is required. The entire request fails if any option does not exist (atomic operation).
The unique code identifying the product field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PRODUCT_FOLLOWERDeletes a follower from a product.
Input parameters
The ID of the product
The ID of the relationship between the follower and the product
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PRODUCT_IMAGETool to delete an image from a product in Pipedrive. Use when you need to remove a product image.
Input parameters
The ID of the product from which to delete the image
The ID of the image to delete from the product
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PRODUCT_VARIATIONTool to delete a product variation from a product in Pipedrive. Use when you need to remove a specific variation from a product.
Input parameters
The ID of the product
The ID of the product variation to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_PROJECTMarks a project as deleted.
Input parameters
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ROLEMarks a role as deleted. Note: This endpoint requires admin permissions. The API token must have the 'admin' scope to delete roles. The default role (ID=1) cannot be deleted.
Input parameters
The ID of the role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_ROLE_ASSIGNMENTRemoves the assigned user from a role and adds to the default role.
Input parameters
The ID of the role
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_STAGETool to delete a stage in Pipedrive. Use when you need to mark a stage as deleted.
Input parameters
The ID of the stage to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_SUBSCRIPTIONMarks an installment or a recurring subscription as deleted.
Input parameters
The ID of the subscription
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_TASKMarks a task as deleted. If the task has subtasks then those will also be deleted.
Input parameters
The ID of the task
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_TEAM_USERSDeletes users from an existing team.
Input parameters
The ID of the team
The list of user IDs
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DELETE_WEBHOOKDeletes the specified Webhook.
Input parameters
The ID of the Webhook to delete
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DOWNLOAD_FILEInitializes a file download.
Input parameters
The ID of the file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DUPLICATE_DEALDuplicates a deal.
Input parameters
The ID of the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_DUPLICATE_PRODUCTTool to duplicate a specific product in Pipedrive. Use when you need to create a copy of an existing product with all its properties and pricing information.
Input parameters
The ID of the product to duplicate
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ENUMERATE_ACCESSIBLE_USERS_FOR_LEADLists the users permitted to access a lead.
Input parameters
The ID of the lead
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_FIND_GOALSQuery goal data by appending `{searchField}={searchValue}` to the URL with dot-notation fields and values. Include `is_active` to filter by goal status and specify both `period.start` and `period.end` for time-based searches.
Input parameters
The title of the goal
Whether the goal is active or not
The type of the goal. If provided, everyone"s goals will be returned.
The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
The ID of the user who"s goal to fetch. When omitted, only your goals will be returned.
The start date of the period for which to find goals. Date in format of YYYY-MM-DD. When `period.start` is provided, `period.end` must be provided too.
The type of the goal"s assignee. If provided, everyone"s goals will be returned.
The ID of the stage. Applicable to only `deals_progressed` type of goals. If provided, everyone"s goals will be returned.
The numeric value of the outcome. If provided, everyone"s goals will be returned.
An array of pipeline IDs or `null` for all pipelines. If provided, everyone"s goals will be returned.
The numeric ID of the goal"s currency. Only applicable to goals with `expected_outcome.tracking_metric` with value `sum`. If provided, everyone"s goals will be returned.
An array of IDs or `null` for all activity types. Only applicable for `activities_completed` and/or `activities_added` types of goals. If provided, everyone"s goals will be returned.
The tracking metric of the expected outcome of the goal. If provided, everyone"s goals will be returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_FIND_USERS_BY_NAMEFinds users by their name.
Input parameters
The search term to look for
When enabled, the term will only be matched against email addresses of users. Default: `false`.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ACTIVITYReturns the details of a specific activity.
Input parameters
The ID of the activity
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ACTIVITY_FIELDTool to retrieve detailed metadata for a specific activity field by its field code. Use when you need information about field structure, type, options, or properties.
Input parameters
The unique code identifying the field (e.g., 'subject', 'due_date', or a 40-character hash for custom fields)
Enum for additional data namespaces to include in response
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ACTIVITIES_ASSIGNED_TO_A_PARTICULAR_USERReturns all activities assigned to a particular user.
Input parameters
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities.
The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the `key_string` parameter of ActivityTypes.
Number of activities to return per page (defaults to 100 if not specified)
For pagination, the position that represents the first result for the page
CLIENT-SIDE FILTERING: Comma-separated list of activity fields to include in the final response. Note: The Pipedrive API does not support native field selection - all fields are still fetched from the API, but the response is filtered before returning to reduce token usage in your application. This does not reduce API bandwidth or Pipedrive API costs. Common fields: id, subject, due_date, due_time, done, type, user_id, person_id, deal_id, org_id, note, add_time, update_time.
The ID of the user whose activities will be fetched. If omitted, the user associated with the API token will be used. If 0, activities for all company users will be fetched based on the permission sets.
Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.
The ID of the filter to use (will narrow down results if used together with `user_id` parameter)
Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.
Level of detail in the response. 'minimal' (default) excludes related_objects (deals, persons, organizations, users) to reduce token usage. 'full' includes the complete API response with all related_objects. Note: The API always returns related_objects — 'minimal' filters them out client-side.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ACTIVITIES_BETAThis BETA cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error. Refer to Pipedrive's documentation for pagination and global permissions.
Input parameters
Whether the activity is done or not. `false` = Not done, `true` = Done. If omitted, returns both done and not done activities.
The type of the activity, can be one type or multiple types separated by a comma. This is in correlation with the `key_string` parameter of ActivityTypes.
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
For pagination, the marker (an opaque string value) representing the first item on the next page
The ID of the user whose activities will be fetched. If omitted, all activities are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ACTIVITY_FIELDSReturns all activity fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ACTIVITY_TYPESReturns all activity types.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_DEAL_FIELDSReturns data about all deal fields.
Input parameters
Items shown per page. Must be > 0 if provided.
Pagination start. Must be >= 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_DEALSReturns all deals. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/getting-all-deals" target="_blank" rel="noopener noreferrer">getting all deals</a>.
Input parameters
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
Items shown per page (1-500). If not provided, 100 items will be returned.
Pagination start
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
If supplied, only deals matching the given user will be returned. However, `filter_id` and `owned_by_you` takes precedence over `user_id` when supplied.
If supplied, only deals within the given stage will be returned
The ID of the filter to use
When supplied, only deals owned by you are returned. However, `filter_id` takes precedence over `owned_by_you` when both are supplied.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_DEALS_BETAThis endpoint returns all deals with cursor pagination (in BETA). Only global admins can access it; others get a 403 error. More info on pagination and permissions is available online.
Input parameters
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
For pagination, the marker (an opaque string value) representing the first item on the next page
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
If supplied, only deals matching the given user will be returned
If supplied, only deals within the given stage will be returned
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_FILESReturns data about all files.
Input parameters
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_FILTER_HELPERSThe text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an API. It encourages consulting a tutorial for more details on adding a filter.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_FILTERSReturns data about all filters.
Input parameters
The types of filters to fetch
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_LEAD_LABELSReturns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_LEADSThe API returns sorted leads by creation time, supporting pagination via `limit` and `start`. Custom field values are included if set, mimicking the `Deals` endpoint structure; unset fields are omitted. Leads share custom fields with deals.
Input parameters
The field name and sorting mode. Format: 'field_name ASC' or 'field_name DESC'. Valid field names: id, title, owner_id, creator_id, was_seen, expected_close_date, next_activity_id, add_time (creation timestamp), update_time. Note: Use 'add_time' for creation time (NOT 'creation_date'). Only first-level field keys are supported (no nested keys).
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
For pagination, the position that represents the first result for the page
If supplied, only leads matching the given user will be returned. However, `filter_id` takes precedence over `owner_id` when supplied.
Optional ID of a saved filter to apply. Filter IDs are account-specific and must be obtained from the user's Pipedrive account using the 'Get all filters' endpoint (GET /filters with type='leads'). Do not pass placeholder values like 1. When filter_id is provided, it takes precedence over owner_id, person_id, and organization_id parameters. If omitted, returns all leads without filtering.
If supplied, only leads matching the given person will be returned. However, `filter_id` takes precedence over `person_id` when supplied.
Filtering based on the archived status of a lead. If not provided, `All` is used.
If supplied, only leads matching the given organization will be returned. However, `filter_id` takes precedence over `organization_id` when supplied.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_LEAD_SOURCESReturns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Pipedrive API will have a lead source `API` assigned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_NOTE_FIELDSReturns data about all note fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_NOTESReturns all notes.
Input parameters
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `content`, `add_time`, `update_time`.
Items shown per page
Pagination start
The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
The date in format of YYYY-MM-DD until which notes to fetch to
The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
The date in format of YYYY-MM-DD from which notes to fetch
If set, the results are filtered by note to deal pinning state
If set, the results are filtered by note to lead pinning state
If set, the results are filtered by note to person pinning state
If set, the results are filtered by note to organization pinning state
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ORGANIZATION_FIELDSReturns data about all organization fields.
Input parameters
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ORGANIZATIONSReturns all organizations.
Input parameters
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
Items shown per page
Pagination start
If supplied, only organizations owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
The ID of the filter to use
If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ORGANIZATIONS_BETAThis BETA API endpoint lists all organizations with cursor pagination. Only global admins have access; others get a 403 error. See docs for pagination and global permissions.
Input parameters
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
For pagination, the marker (an opaque string value) representing the first item on the next page
If supplied, only organizations owned by the given user will be returned
If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PERMISSION_SETSReturns data about all permission sets.
Input parameters
The app to filter the permission sets by
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PERSON_FIELDSReturns data about all person fields.<br>If a company uses the \[Campaigns product\](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
Input parameters
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PERSONSReturns all persons.
Input parameters
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
Items shown per page
Pagination start
If supplied, only persons owned by the given user will be returned. However, `filter_id` takes precedence over `user_id` when both are supplied.
The ID of the filter to use
If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PERSONS_BETAThis BETA endpoint returns all persons, using cursor pagination. Only global admins have access; others get a 403 error. Info on pagination and permissions is in the linked docs.
Input parameters
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
The time boundary that points to the start of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
The time boundary that points to the end of the range of data. Datetime in ISO 8601 format. E.g. 2022-11-01 08:55:59. Operates on the `update_time` field.
For pagination, the marker (an opaque string value) representing the first item on the next page
If supplied, only persons owned by the given user will be returned
If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PIPELINESReturns data about all pipelines. This action retrieves all pipelines from the user's Pipedrive instance using their instance-specific URL (e.g., https://company.pipedrive.com/api/v2/pipelines).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PRODUCT_FIELDSReturns data about all product fields.
Input parameters
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PRODUCTSReturns data about all products.
Input parameters
An array of integers with the IDs of the products that should be returned in the response
Items shown per page
Pagination start
If supplied, only products owned by the given user will be returned
The ID of the filter to use
If supplied, only products whose name starts with the specified letter will be returned (case-insensitive)
If supplied, the response will return the total numbers of products in the `additional_data.summary.total_count` property
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PROJECT_BOARDSReturns all projects boards that are not deleted. Note: The Projects feature requires the Projects add-on which is available on Power and Enterprise plans, or as a paid add-on for other plans. A 402 Payment Required error indicates the account does not have access to the Projects feature.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PROJECTSReturns all projects. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target="_blank" rel="noopener noreferrer">pagination</a>.
Input parameters
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
For pagination, the marker (an opaque string value) representing the first item on the next page
If supplied, includes only projects with the specified statuses. Possible values are `open`, `completed`, `canceled` and `deleted`. By default `deleted` projects are not returned.
If supplied, only projects in specified phase are returned
The ID of the filter to use
If supplied with `true` then archived projects are also included in the response. By default only not archived projects are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_PROJECT_TEMPLATESThe endpoint retrieves all non-deleted project templates with cursor-based pagination. Refer to the provided documentation link for more details on pagination. Note: This endpoint requires the Pipedrive Projects add-on to be enabled. Projects is included in Power and Enterprise plans, or can be purchased as an add-on for Professional plans or lower.
Input parameters
For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned.
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_RELATIONSHIPS_FOR_ORGANIZATIONGets all of the relationships for a supplied organization ID.
Input parameters
The ID of the organization to get relationships for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_ROLESReturns all the roles within the company. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain base URL with `/api/v1` path. Example: https://{COMPANY}.pipedrive.com/api/v1/roles - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used.
Input parameters
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_STAGESReturns data about all stages.
Input parameters
Items shown per page
Pagination start
The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_SUPPORTED_CURRENCIESReturns all supported currencies in given account which should be used when saving monetary values with other objects. The `code` parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.
Input parameters
Optional search term that is searched for from currency"s name and/or code
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_TASKSReturns all tasks. This is a cursor-paginated endpoint. For more information, please refer to our documentation on <a href="https://pipedrive.readme.io/docs/core-api-concepts-pagination" target="_blank" rel="noopener noreferrer">pagination</a>.
Input parameters
Whether the task is done or not. `0` = Not done, `1` = Done. If not omitted then returns both done and not done tasks.
For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned.
For pagination, the marker (an opaque string value) representing the first item on the next page
If supplied, only tasks that are assigned to this project are returned
If supplied, only tasks that are assigned to this user are returned
If `null` is supplied then only parent tasks are returned. If integer is supplied then only subtasks of a specific task are returned. By default all tasks are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_TEAMSReturns data about teams within the company.
Input parameters
The field name to sort returned teams by
When enabled, the teams will not include IDs of member users
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_TEAMS_OF_A_USERReturns data about all teams which have the specified user as a member.
Input parameters
The ID of the user
The field name to sort returned teams by
When enabled, the teams will not include IDs of member users
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_USER_CONNECTIONSReturns data about all connections for the authorized user.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_USERSReturns data about all users within the company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_USERS_IN_A_TEAMReturns a list of all user IDs within a team.
Input parameters
The ID of the team
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ALL_WEBHOOKSReturns data about all the Webhooks of a company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ARCHIVED_DEALSTool to get all archived deals from Pipedrive. Use when you need to retrieve deals that have been archived, with support for filtering and pagination.
Input parameters
Optional comma separated string array of up to 100 entity ids to fetch
For pagination, the limit of entries to be returned. A maximum value of 500 is allowed (default: 100)
Pagination marker for the next page of results
Filters to deals linked to the specified organization
Deal status filter
Supported sort fields for archived deals
Filters to deals owned by the specified user
Filters to deals in the specified stage
When supplied, returns only deals matching the specified filter
Filters to deals linked to the specified person
Filters to deals in the specified pipeline
Optional comma separated string array of custom fields keys to include. A maximum of 15 keys is allowed
RFC3339 format; returns deals with update_time >= this value
RFC3339 format; returns deals with update_time < this value
Additional optional fields (next_activity_id, last_activity_id, first_won_time, products_count, etc.)
Sort direction for archived deals
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ARCHIVED_LEADSTool to get all archived leads from Pipedrive. Use when you need to retrieve leads that have been archived, with support for filtering by owner, person, organization, or custom filter, and pagination.
Input parameters
Supported sort fields for archived leads
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
For pagination, the position that represents the first result for the page
If supplied, only leads matching the given user will be returned. However, filter_id takes precedence over owner_id when supplied.
The ID of the filter to use
If supplied, only leads matching the given person will be returned. However, filter_id takes precedence over person_id when supplied.
If supplied, only leads matching the given organization will be returned. However, filter_id takes precedence over organization_id when supplied.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_CALL_LOGTool to retrieve details of a specific call log by ID. Use when you need to get complete information about a call log including duration, outcome, participants, and timestamps.
Input parameters
The ID of the call log to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_COMMENTReturns the details of a comment.
Input parameters
The ID of the note
The ID of the comment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_COMPANY_ADD_ONSReturns the add-ons for a single company.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_CONVERSATIONSTool to retrieve messaging conversations. Use after channel registration to sync conversations.
Input parameters
Cursor for fetching the next page of conversations
Unique ID of the messaging channel
Maximum number of messages per conversation
Maximum number of conversations to return
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_CURRENT_USER_DATAReturns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means 'Date/number format' in the Pipedrive account settings, not the chosen language.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALTool to get details of a specific deal in Pipedrive. Use when you need to retrieve comprehensive information about a deal by its ID.
Input parameters
The ID of the deal to retrieve
Comma-separated list of custom field keys to include (maximum 15 keys). Use this parameter for faster results and smaller responses when only specific custom fields are needed.
Comma-separated list of additional fields to include in the response. Acceptable values: next_activity_id, last_activity_id, first_won_time, products_count, files_count, notes_count, followers_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, participants_count, last_incoming_mail_time, last_outgoing_mail_time, smart_bcc_email
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_ACTIVITIESDEPRECATED: Use PIPEDRIVE_PIPEDRIVE_ACTIVITIES_UPDATE_ACTIVITY or PIPEDRIVE_LIST_ACTIVITIES instead. Lists activities associated with a deal. Use when you need to retrieve all activities linked to a specific deal.
Input parameters
The ID of the deal
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities.
Number of items displayed per page
Pagination starting point
Comma-separated activity IDs to exclude from results
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_CHANGELOGTool to list updates about deal field values. Use when you need to retrieve the changelog history showing all changes made to a specific deal's field values.
Input parameters
The ID of the deal
Number of items to display per page. Controls the size of each paginated response.
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_FIELDTool to retrieve a specific deal field by ID. Use when you need to get metadata and configuration for a deal field.
Input parameters
The ID of the deal field to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_FILESTool to list files attached to a deal. Use when you need to retrieve all files associated with a specific deal in Pipedrive.
Input parameters
The ID of the deal
Supported fields for sorting: `id`, `update_time`. Example: 'id ASC' or 'update_time DESC'.
Items shown per page. Maximum value of 100 is allowed.
Pagination start. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_FOLLOWERSLists users who are following the deal. Use when you need to retrieve all followers of a specific deal.
Input parameters
The ID of the deal
For pagination, the limit of entries to be returned. Maximum value of 500 is allowed.
For pagination, the marker (an opaque string value) representing the first item on the next page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_FOLLOWERS_CHANGELOGTool to retrieve changelogs about users who have followed a deal. Use when you need to track follower activity, showing when users were added or removed as followers.
Input parameters
The ID of the deal
Number of items returned per page. Maximum value is 500.
Pagination marker (opaque string) pointing to the first item on the next page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_MAIL_MESSAGESTool to list mail messages associated with a deal in Pipedrive. Use when you need to retrieve email communications linked to a specific deal. Note: This returns mail message snippets only; for full email content, use the thread_id and query mail threads separately.
Input parameters
The ID of the deal to retrieve mail messages for
Number of items shown per page. If not provided, API default will be used.
Pagination start position. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_PARTICIPANTSTool to list participants of a deal. Use when you need to retrieve all participants (persons) associated with a specific deal in Pipedrive.
Input parameters
The ID of the deal
Items shown per page. Maximum value of 500 is allowed. Default is 100.
Pagination start. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_PARTICIPANTS_CHANGELOGTool to list updates about participants of a deal. Use when you need to retrieve the changelog history showing all changes made to a specific deal's participants.
Input parameters
The ID of the deal
Number of items to display per page. Maximum value is 500.
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_PRODUCTSTool to list products attached to a deal. Use when you need to retrieve all products associated with a specific deal in Pipedrive.
Input parameters
The ID of the deal
For pagination, the limit of entries to be returned. Maximum value of 500 is allowed. Default is 100.
For pagination, the marker (opaque string value) representing the first item on the next page
The field to sort by. Supported values: id, add_time, update_time, order_nr. Default is 'id'.
The sorting direction. Supported values: asc, desc. Default is 'asc'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_CONVERSION_RATES_IN_PIPELINEReturns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
Input parameters
The ID of the pipeline
The ID of the user who"s pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
The end of the period. Date in format of YYYY-MM-DD.
The start of the period. Date in format of YYYY-MM-DD.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_CONVERT_STATUSTool to retrieve the conversion status for a deal-to-lead conversion operation. Use when you need to check the progress or result of a deal conversion job.
Input parameters
The ID of the deal
The ID of the conversion job. The ID has UUID format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_DISCOUNTSTool to retrieve discounts for a specific deal. Use when you need to list all discounts added to a deal in Pipedrive.
Input parameters
The ID of the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_IN_A_PIPELINELists deals in a specific pipeline across all its stages.
Input parameters
The ID of the pipeline
Items shown per page
Pagination start
If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
If supplied, only deals within the given stage will be returned
If supplied, only deals matching the given filter will be returned
Whether to include a summary of the pipeline in the `additional_data` or not
The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned inside `deals_summary` inside `additional_data` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used. Only works when `get_summary` parameter flag is enabled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_IN_A_STAGELists deals in a specific stage.
Input parameters
The ID of the stage
Items shown per page
Pagination start
If supplied, `filter_id` will not be considered and only deals owned by the given user will be returned. If omitted, deals owned by the authorized user will be returned.
If supplied, `filter_id` and `user_id` will not be considered – instead, deals owned by everyone will be returned
If supplied, only deals matching the given filter will be returned
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_PRODUCTSTool to retrieve products attached to specified deals (max 100 deals per request). Use when you need to get all products associated with multiple deals.
Input parameters
Number of entries per request (default: 100, max: 500)
Pagination marker to retrieve the next page of results
Field to sort by - supports 'id', 'deal_id', 'add_time', 'update_time', or 'order_nr' (default: 'id')
IDs of the deals for which attached products will be returned. Maximum 100 deal IDs allowed.
Sort order - 'asc' or 'desc' (default: 'asc')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_SUMMARYReturns a summary of all the deals.
Input parameters
Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
Only deals matching the given user will be returned. `user_id` will not be considered if you use `filter_id`.
Only deals within the given stage will be returned
<code>user_id</code> will not be considered. Only deals matching the given filter will be returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_SUMMARY_ARCHIVEDTool to retrieve summary statistics for archived deals. Use when you need aggregated data about archived deals including total count, values, and weighted values grouped by currency.
Input parameters
Deal status filter options
Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.
Only deals within the given stage will be returned
user_id will not be considered. Only deals matching the given filter will be returned.
Only deals within the given pipeline will be returned
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_TIMELINEReturns opened and won deals in time-based groups according to a specified dealField, with examples of deals grouped by month over a 3-month period starting January 2012.
Input parameters
The number of given intervals, starting from `start_date`, to fetch. E.g. 3 (months).
If supplied, only deals matching the given user will be returned
The type of the interval<table><tr><th>Value</th><th>Description</th></tr><tr><td>`day`</td><td>Day</td></tr><tr><td>`week`</td><td>A full week (7 days) starting from `start_date`</td></tr><tr><td>`month`</td><td>A full month (depending on the number of days in given month) starting from `start_date`</td></tr><tr><td>`quarter`</td><td>A full quarter (3 months) starting from `start_date`</td></tr></table>
The date field key which deals will be retrieved from
If supplied, only deals matching the given filter will be returned
The date when the first interval starts. Format: YYYY-MM-DD.
If supplied, only deals matching the given pipeline will be returned
Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
The 3-letter currency code of any of the supported currencies. When supplied, `totals_converted` is returned per each interval which contains the currency-converted total amounts in the given currency. You may also set this parameter to `default_currency` in which case the user"s default currency is used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_SUBSCRIPTIONReturns details of an installment or a recurring subscription by the deal ID. Note: Subscriptions endpoints may not be available on company-specific hosts or may be deprecated. This action attempts multiple hosts and gracefully falls back to Installments (v2) or Deal Products (v1) to provide a useful response based on live API data.
Input parameters
The ID of the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEALS_WITH_PRODUCTReturns data about deals that have a product attached to it.
Input parameters
The ID of the product
Items shown per page
Pagination start
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_UPDATESLists updates about a deal in chronological order. Use when you need to track deal changes, monitor activity timeline, or audit deal modifications.
Input parameters
The unique identifier of the deal
Comma-separated filter for specific update types. Supported values: call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change. Note: Use 'change' instead of 'dealChange' for deal change items
Number of items to show per page for pagination
Pagination starting point for retrieving results
Set to "1" to display custom field updates in the response; omit to exclude custom field changes
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DEAL_USERSTool to list users permitted to access a deal. Use when you need to retrieve all users who have permission to access a specific deal in Pipedrive.
Input parameters
The ID of the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DETAILS_OF_AN_ORGANIZATIONProvides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as long hashes to the 'key' value in organizationFields.
Input parameters
The ID of the organization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_DETAILS_OF_A_PERSONDEPRECATED: Use PIPEDRIVE_PIPEDRIVE_GET_PERSON instead. The text describes an API endpoint that returns detailed person information, including extra fields and custom fields as hashes. It also provides `data.marketing_status` if the Campaigns product is used.
Input parameters
The ID of the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_FILEReturns data about a specific file.
Input parameters
The ID of the file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_FILTERReturns data about a specific filter. Note that this also returns the condition lines of the filter.
Input parameters
The ID of the filter
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_GOAL_RESULTGets the progress of a goal for the specified period.
Input parameters
The ID of the goal that the results are looked for
The end date of the period for which to find the goal"s progress. Format: YYYY-MM-DD. This date must be the same or before the goal duration end date.
The start date of the period for which to find the goal"s progress. Format: YYYY-MM-DD. This date must be the same or after the goal duration start date.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_LEAD_CONVERSION_STATUSTool to retrieve the conversion status for a specific lead conversion job. Use when you need to check the progress of a lead-to-deal conversion including current state and resulting deal ID upon completion.
Input parameters
The identifier for a specific lead (UUID format)
The identifier for the conversion job (UUID format)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_LEAD_FIELDSTool to retrieve all lead fields. Use when you need to get the schema for leads in a company's context.
Input parameters
Number of items shown per page
Pagination start position
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_LEAD_USERSTool to list users permitted to access a lead. Use when you need to retrieve all user IDs who have permission to access a specific lead in Pipedrive.
Input parameters
The ID of the lead
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_MAIL_MESSAGEReturns data about a specific mail message.
Input parameters
The ID of the mail message to fetch
Whether to include the full message body or not. `0` = Don"t include, `1` = Include.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_MAIL_THREADReturns a specific mail thread.
Input parameters
The ID of the mail thread
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_MAIL_THREAD_MESSAGESReturns all the mail messages inside a specified mail thread.
Input parameters
The ID of the mail thread
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_MAIL_THREADSReturns mail threads in a specified folder ordered by the most recent message within.
Input parameters
Items shown per page
Pagination start
The type of folder to fetch
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_MARKETPLACE_CLIENT_IDTool to retrieve marketplace_client_id of an installed video integration. Use when you need the client ID for an installed integration.
Input parameters
Optional provider name to filter add-ons by code containing this string.
Hint for the marketplace client ID. If provided, returned immediately.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_NOTEReturns details about a specific note.
Input parameters
The ID of the note
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_NOTE_COMMENTSReturns all comments associated with a note.
Input parameters
The ID of the note
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ONE_LEADAPI returns specific lead details with custom field values in the Deals format. Unset custom fields are omitted. Leads share custom fields with deals, not having a unique set.
Input parameters
The ID of the lead
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATIONTool to get details of a specific organization in Pipedrive. Use when you need to retrieve comprehensive information about an organization by its ID.
Input parameters
The ID of the organization to retrieve
Comma-separated list of custom field keys to include (maximum 15 keys). Use this parameter for faster results and smaller responses when only specific custom fields are needed.
Comma-separated list of additional fields to include in the response. Acceptable values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, email_messages_count, people_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_CHANGELOGTool to list updates about organization field values. Use when you need to retrieve the changelog history showing all changes made to a specific organization's field values.
Input parameters
The ID of the organization
Number of items to display per page. Controls the size of each paginated response. Maximum value is 500.
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_DEALSLists deals associated with an organization. Use when you need to retrieve all deals linked to a specific organization with optional filtering and pagination.
Input parameters
The ID of the organization
Field names and sorting mode separated by comma (e.g., 'add_time ASC'). Only first-level field keys are supported (no nested keys).
Items shown per page
Pagination start. Default: 0
Filter by deal status. Values: open, won, lost, deleted, all_not_deleted. If omitted, all not deleted deals are returned.
If set to 1, only deals directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Values: 0 or 1
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_FIELDTool to retrieve a specific organization field by ID. Use when you need to get metadata and configuration for an organization field.
Input parameters
The ID of the organization field to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_FILESTool to list files attached to an organization. Use when you need to retrieve all files associated with a specific organization in Pipedrive.
Input parameters
The ID of the organization
Supported fields for sorting: `id`, `update_time`. Example: 'id ASC' or 'update_time DESC'.
Items shown per page. Maximum value of 100 is allowed.
Pagination start. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_FOLLOWERSTool to list followers of an organization. Use when you need to retrieve all users who are following a specific organization in Pipedrive.
Input parameters
The ID of the organization
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_FOLLOWERS_CHANGELOGTool to list changelog about organization followers. Use when you need to retrieve the history of users who have followed or unfollowed a specific organization.
Input parameters
The ID of the organization
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_MAIL_MESSAGESTool to list mail messages associated with an organization. Use when you need to retrieve all email correspondence linked to a specific organization in Pipedrive.
Input parameters
The ID of the organization
Number of items displayed per page (default: 100, max: 500)
Pagination start point. Default: 0
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_PERSONSTool to list persons associated with an organization. Use when you need to retrieve all persons linked to a specific organization in Pipedrive.
Input parameters
The ID of the organization
Number of items shown per page. Defines how many records to return in one request.
Pagination start position. Indicates from which record number to start returning results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_RELATIONSHIPFinds and returns an organization relationship from its ID.
Input parameters
The ID of the organization relationship
The ID of the base organization for the returned calculated values
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_UPDATESTool to list updates about an organization including field value changes, activities, notes, files, and other related items. Use when you need to retrieve the activity flow and update history for a specific organization.
Input parameters
The ID of the organization
A comma-separated string for filtering out item-specific updates. Possible values: activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document
Items shown per page. Maximum value of 500 is allowed. If not provided, 100 items will be returned.
Pagination start point. Use to skip initial items and start from a specific position in the results.
Whether to show custom field updates or not. Set to '1' to include custom field changes. If omitted, returns changes without custom field updates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ORGANIZATION_USERSList users permitted to access an organization. Use when you need to retrieve all users who have been granted permission to view and interact with a specific organization record.
Input parameters
The ID of the organization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERMISSION_SETReturns data about a specific permission set.
Input parameters
The ID of the permission set
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERMISSION_SET_ASSIGNMENTSTool to list permission set assignments for a given permission set. Use when you need to retrieve all users assigned to a specific permission set.
Input parameters
The ID of the permission set
Items shown per page
Pagination start (default: 0)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSONTool to get details of a specific person in Pipedrive. Use when you need to retrieve comprehensive information about a person by their ID.
Input parameters
The ID of the person to retrieve
Comma-separated list of custom field keys to include (maximum 15 keys). Use this parameter for faster results and smaller responses when only specific custom fields are needed.
Comma-separated list of additional fields to include in the response. Allowed values: next_activity_id, last_activity_id, open_deals_count, related_open_deals_count, closed_deals_count, related_closed_deals_count, participant_open_deals_count, participant_closed_deals_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, files_count, notes_count, followers_count, won_deals_count, related_won_deals_count, lost_deals_count, related_lost_deals_count, last_incoming_mail_time, last_outgoing_mail_time, marketing_status, doi_status. Note: marketing_status and doi_status are only available if company has marketing app enabled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_CHANGELOGTool to list updates about person field values. Use when you need to retrieve the changelog history showing all changes made to a specific person's field values.
Input parameters
The ID of the person
Number of items to display per page. Controls the size of each paginated response.
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_DEALSLists deals associated with a person. Use when you need to retrieve all deals linked to a specific person.
Input parameters
The ID of the person
Field names and sorting mode separated by comma (e.g., 'field_name_1 ASC', 'field_name_2 DESC'). Only first-level field keys are supported.
Number of items shown per page
Pagination start position
Filter deals by status. Allowed values: 'open', 'won', 'lost', 'deleted', 'all_not_deleted'. Default is 'all_not_deleted'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_FIELDTool to retrieve metadata for a specific person field by its ID. Use when you need to get field properties like name, type, order, and options.
Input parameters
The ID of the person field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_FILESTool to list files attached to a person. Use when you need to retrieve all files associated with a specific person in Pipedrive.
Input parameters
The ID of the person
Field to sort by. Supported fields: `id`, `update_time`.
Items shown per page. Maximum value of 100 is allowed.
Pagination start. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_FOLLOWERSTool to list followers of a person in Pipedrive. Use when you need to retrieve all users who are following a specific person.
Input parameters
The ID of the person
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value allowed is 500.
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_FOLLOWERS_CHANGELOGTool to retrieve changelogs about users who have followed a person. Use when you need to track follower activity, showing when users were added or removed as followers.
Input parameters
The ID of the person
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed.
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_MAIL_MESSAGESTool to list mail messages associated with a person in Pipedrive. Use when you need to retrieve email communications linked to a specific person contact.
Input parameters
The ID of the person
Number of items shown per page. If not specified, all items are returned.
Pagination start position. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_PICTURETool to get picture details of a specific person in Pipedrive. Use when you need to retrieve picture information and URLs for a person by their ID.
Input parameters
The ID of the person whose picture to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_PRODUCTSTool to list products associated with a person. Use when you need to retrieve all products linked to a specific person in Pipedrive.
Input parameters
The ID of the person
Items shown per page. If not provided, the default limit from API settings will be used.
Pagination start position
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_UPDATESLists updates and activity history for a specific person in chronological order. Use when you need to track person changes, monitor activity timeline, or audit person modifications.
Input parameters
The ID of the person whose updates should be retrieved
Comma-separated string for filtering specific update types. Possible values: call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change
Items shown per page for pagination
Pagination start position. Default is 0.
Set to "1" to include custom field updates in the response. If omitted, returns changes without custom field updates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PERSON_USERSTool to list users permitted to access a person. Use when you need to retrieve all users who have permission to access a specific person in Pipedrive.
Input parameters
The ID of the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PIPELINEReturns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
Input parameters
The ID of the pipeline
The 3-letter currency code of any of the supported currencies. When supplied, `per_stages_converted` is returned in `deals_summary` which contains the currency-converted total amounts in the given currency per each stage. You may also set this parameter to `default_currency` in which case users default currency is used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PIPELINE_CONVERSION_STATISTICSTool to get deals conversion rates in a pipeline for a given time period. Use when you need stage-to-stage conversion statistics, won conversion rates, or lost conversion rates for a specific pipeline.
Input parameters
The ID of the pipeline
The ID of the user who's pipeline metrics statistics to fetch. If omitted, the authorized user will be used
The end of the period. Date in format of YYYY-MM-DD
The start of the period. Date in format of YYYY-MM-DD
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PIPELINE_MOVEMENT_STATISTICSTool to retrieve deal movement statistics within a pipeline for a specified time period. Use when you need to analyze pipeline performance metrics including new deals, won/lost deals, deals left open, and average age statistics.
Input parameters
The pipeline's identifier
Specifies which team member's statistics to retrieve; if absent, the authorized user's data is used
Period end date in YYYY-MM-DD format
Period beginning date in YYYY-MM-DD format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCTReturns data about a specific product.
Input parameters
The ID of the product
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_DEALSTool to list deals associated with a product. Use when you need to retrieve deals that have a specific product attached to them.
Input parameters
The ID of the product
Items shown per page. Maximum value allowed is 500.
Pagination start. Default is 0.
Filter deals by status. Options: 'open', 'won', 'lost', 'deleted', 'all_not_deleted'. Default is 'all_not_deleted'. If set to 'deleted', deals deleted up to 30 days ago will be included.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_FIELDReturns data about a specific product field.
Input parameters
The ID of the product field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_FILESTool to list files attached to a product. Use when you need to retrieve all files associated with a specific product in Pipedrive.
Input parameters
The ID of the product
Field names and sorting mode separated by comma (field_name_1 ASC, field_name_2 DESC). Supported fields: `id`, `update_time`. Only first field is used for sorting.
Number of items per page. Maximum value of 100 is allowed.
Pagination start offset. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_FOLLOWERSTool to list all followers of a product in Pipedrive. Use when you need to retrieve users following a specific product. Returns pagination metadata to handle large follower lists.
Input parameters
The ID of the product
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value: 500
Pagination start offset for entries. Default is 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_FOLLOWERS_CHANGELOGTool to list changelog of followers for a product. Use when you need to retrieve the history of users who have followed or unfollowed a specific product.
Input parameters
The ID of the product
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_IMAGESTool to retrieve image data for a specific product. Use when you need to get the public URL and metadata for a product's image. Note that public URLs have a limited lifetime of 7 days.
Input parameters
The ID of the product
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_USERSTool to list users permitted to access a product in Pipedrive. Use when you need to retrieve the list of users who have permission to view or manage a specific product.
Input parameters
The ID of the product to get permitted users for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PRODUCT_VARIATIONSTool to retrieve all product variations for a specific product with pagination support. Use when you need to get the complete list of variations available for a product, each with different prices across currencies.
Input parameters
The ID of the product
For pagination, the maximum entries returned. Default is 100; maximum allowed is 500
For pagination, an opaque marker representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECTReturns the details of a specific project. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of project fields.
Input parameters
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECT_ACTIVITIESReturns activities linked to a specific project.
Input parameters
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECT_BOARDReturns the details of a specific project board.
Input parameters
The ID of the project board
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECT_GROUPSReturns all active groups under a specific project.
Input parameters
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECT_PHASEReturns the details of a specific project phase.
Input parameters
The ID of the project phase
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECT_PHASESReturns all active project phases under a specific board.
Input parameters
ID of the board for which phases are requested
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECT_PLANReturns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.
Input parameters
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_PROJECT_TASKSReturns tasks linked to a specific project.
Input parameters
The ID of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_RECENTSReturns data about all recent changes occurred after the given timestamp.
Input parameters
Multiple selection of item types to include in the query (optional)
Items shown per page
Pagination start
The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ROLETool to retrieve details for a specific role by its ID. Use when you need to get complete role information including name, parent role, active status, assignment count, and default visibility settings.
Input parameters
The ID of the role to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ROLE_ASSIGNMENTSTool to retrieve all users assigned to a specific role in Pipedrive. Use when you need to list role assignments for a given role.
Input parameters
The ID of the role
Number of items shown per page
Pagination start position
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ROLE_PIPELINESReturns the visibility settings for pipelines associated with a specific role. Use when you need to list which pipelines are visible or hidden for a role.
Input parameters
The ID of the role
Determines whether to retrieve visible or hidden pipelines. Defaults to true (visible pipelines).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_ROLE_SETTINGSTool to retrieve visibility settings of a specific role. Use when you need to get default visibility levels and access levels for deals, leads, organizations, people, and products associated with a role. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain base URL with `/api/v1` path. Example: https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the provided base_url to use `/api/v1` to avoid host/path mismatches.
Input parameters
The ID of the role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_STAGEReturns data about a specific stage.
Input parameters
The ID of the stage
If `everyone=1` is provided, deals summary will return deals owned by every user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_SUBSCRIPTIONReturns details of an installment or a recurring subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action tries multiple hosts and gracefully falls back to Installments (v2) and Deal Products (v1).
Input parameters
The ID of the subscription
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_SUBSCRIPTION_PAYMENTSReturns all payments of an installment or recurring subscription.
Input parameters
The ID of the subscription
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_TASKReturns the details of a specific task.
Input parameters
The ID of the task
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_TEAMReturns data about a specific team.
Input parameters
The ID of the team
When enabled, the teams will not include IDs of member users
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_TEMPLATEReturns the details of a specific project template.
Input parameters
The ID of the project template
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_TEMPLATESTool to retrieve message templates for a channel. Use when template support is enabled.
Input parameters
Unique ID of the messaging channel (UUID format)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_USERReturns data about a specific user within the company.
Input parameters
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_USER_CALL_LOGSReturns all call logs assigned to a particular user.
Input parameters
For pagination, the limit of entries to be returned. The upper limit is 50.
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_USER_FOLLOWERSTool to list users who are following a specific user. Use when you need to retrieve all followers of a user in Pipedrive.
Input parameters
The ID of the user
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_USER_PERMISSIONSTool to list aggregated permissions over all assigned permission sets for a user. Use when you need to check what capabilities and access rights a specific user has across the system.
Input parameters
The identifier of the user whose permissions to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_USER_ROLE_ASSIGNMENTSTool to list role assignments for a user. Use when you need to retrieve all role assignments associated with a specific user in Pipedrive.
Input parameters
The ID of the user
Items shown per page
Pagination start position
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_GET_USER_ROLE_SETTINGSTool to list user role settings. Use when you need to retrieve the role configuration data for a specific user, including default visibility levels and access levels for various entities. Note: This endpoint costs 10 API credits per request.
Input parameters
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LINK_REMOTE_FILELinks an existing remote file (`googledrive`) to the item you supply. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-remote-file" target="_blank" rel="noopener noreferrer">adding a remote file</a>.
Input parameters
The ID of the item to associate the file with
The item type
The remote item ID
The location type to send the file to. Only `googledrive` is supported at the moment.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LINK_USER_VIDEO_INTEGRATIONA video calling provider must call this endpoint after a user has installed the video calling app so that the new user's information is sent.
Input parameters
Pipedrive user ID
Pipedrive company ID
Unique identifier linking a user to the installed integration. Generated by the integration.
Pipedrive Marketplace client ID of the installed integration
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_ACTIVITIESLists activities associated with a deal.
Input parameters
The ID of the deal
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
Items shown per page
Pagination start
A comma-separated string of activity IDs to exclude from result
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_FILESLists files associated with a deal.
Input parameters
The ID of the deal
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_FOLLOWERSLists the followers of a deal.
Input parameters
The ID of the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_MAIL_MESSAGESLists mail messages associated with a deal.
Input parameters
The ID of the deal
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_PERSONSThe endpoint lists every person linked to a deal, including primary contacts and participants, and provides a `data.marketing_status` field for users of the Campaigns product.
Input parameters
The ID of the deal
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_PRODUCTSLists products attached to a deal.
Input parameters
The ID of the deal
Items shown per page
Pagination start
Whether to fetch product data along with each attached product (1) or not (0, default)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_UPDATESLists updates about a deal.
Input parameters
The ID of the deal
A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
Items shown per page
Pagination start
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_DEAL_USERSLists the users permitted to access a deal.
Input parameters
The ID of the deal
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ORGANIZATION_ACTIVITIESLists activities associated with an organization.
Input parameters
The ID of the organization
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
Items shown per page
Pagination start
A comma-separated string of activity IDs to exclude from result
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ORGANIZATION_DEALSLists deals associated with an organization.
Input parameters
The ID of the organization
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
Items shown per page
Pagination start
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
If set, only deals that are directly associated to the organization are fetched. If not set (default), all deals are fetched that are either directly or indirectly related to the organization. Indirect relations include relations through custom, organization-type fields and through persons of the given organization.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ORGANIZATION_FILESLists files associated with an organization.
Input parameters
The ID of the organization
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ORGANIZATION_FOLLOWERSLists the followers of an organization.
Input parameters
The ID of the organization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ORGANIZATION_MAIL_MESSAGESLists mail messages associated with an organization.
Input parameters
The ID of the organization
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ORGANIZATION_PERSONSLists persons associated with an organization.<br>If a company uses the \[Campaigns product\](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
Input parameters
The ID of the organization
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PARTICIPANTS_OF_A_DEALLists the participants associated with a deal.<br>If a company uses the \[Campaigns product\](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.
Input parameters
The ID of the deal
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERMISSION_SET_ASSIGNMENTSReturns the list of assignments for a permission set. Notes: - This endpoint requires the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/permissionSets/{id}/assignments - This action normalizes the base URL accordingly and returns the API envelope even on errors.
Input parameters
The ID of the permission set
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERSON_ACTIVITIESLists activities associated with a person.
Input parameters
The ID of the person
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
Items shown per page
Pagination start
A comma-separated string of activity IDs to exclude from result
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERSON_DEALSLists deals associated with a person.
Input parameters
The ID of the person
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys).
Items shown per page
Pagination start
Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERSON_FILESLists files associated with a person.
Input parameters
The ID of the person
The field names and sorting mode separated by a comma (`field_name_1 ASC`, `field_name_2 DESC`). Only first-level field keys are supported (no nested keys). Supported fields: `id`, `user_id`, `deal_id`, `person_id`, `org_id`, `product_id`, `add_time`, `update_time`, `file_name`, `file_type`, `file_size`, `comment`.
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERSON_FOLLOWERSLists the followers of a person.
Input parameters
The ID of the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERSON_MAIL_MESSAGESLists mail messages associated with a person.
Input parameters
The ID of the person
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERSON_PRODUCTSLists products associated with a person.
Input parameters
The ID of the person
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PERSON_USERSList users permitted to access a person.
Input parameters
The ID of the person
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PRODUCT_FILESLists files associated with a product.
Input parameters
The ID of the product
The field name and sorting mode (`field_name_1 ASC` or `field_name_1 DESC`). Supported fields: `update_time`, `id`.
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PRODUCT_FOLLOWERSLists the followers of a product.
Input parameters
The ID of the product
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_PRODUCT_USERSLists users permitted to access a product.
Input parameters
The ID of the product
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ROLE_ASSIGNMENTSReturns all users assigned to a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/assignments - This action normalizes the base URL accordingly.
Input parameters
The ID of the role
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ROLE_PIPELINE_VISIBILITYReturns a list of visible or hidden pipeline IDs by role. See the "Visibility groups article" for details on pipeline visibility.
Input parameters
The ID of the role
Whether to return the visible or hidden pipelines for the role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_ROLE_SETTINGSReturns the visibility settings of a specific role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the base URL accordingly.
Input parameters
The ID of the role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_UPDATES_ABOUT_AN_ORGANIZATIONLists updates about an organization.
Input parameters
The ID of the organization
A comma-separated string for filtering out item specific updates. (Possible values - activity, plannedActivity, note, file, change, deal, follower, participant, mailMessage, mailMessageWithAttachment, invoice, activityFile, document).
Items shown per page
Pagination start
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_UPDATES_ABOUT_A_PERSONLists updates about a person.<br>If a company uses the \[Campaigns product\](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.
Input parameters
The ID of the person
A comma-separated string for filtering out item specific updates. (Possible values - call, activity, plannedActivity, change, note, deal, file, dealChange, personChange, organizationChange, follower, dealFollower, personFollower, organizationFollower, participant, comment, mailMessage, mailMessageWithAttachment, invoice, document, marketing_campaign_stat, marketing_status_change).
Items shown per page
Pagination start
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_UPDATES_ABOUT_PARTICIPANTS_OF_A_DEALThis endpoint provides cursor-paginated updates on deal participants. For pagination details, see the Pipedrive documentation.
Input parameters
The ID of the deal
Items shown per page
For pagination, the marker (an opaque string value) representing the first item on the next page
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_USER_FOLLOWERSLists the followers of a specific user.
Input parameters
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_USER_PERMISSIONSLists aggregated permissions over all assigned permission sets for a user.
Input parameters
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_USER_ROLE_ASSIGNMENTSLists role assignments for a user.
Input parameters
The ID of the user
Items shown per page
Pagination start
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_USER_ROLE_SETTINGSLists the settings of user's assigned role.
Input parameters
The ID of the user
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_LIST_USER_SETTINGSLists the settings of an authorized user. Example response contains a shortened list of settings.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_MERGE_DEALSTool to merge two deals in Pipedrive. Use when you need to consolidate two deals into one. The deal specified by 'id' will be merged into the deal specified by 'merge_with_id', and the first deal will be removed while the second one will remain with all consolidated data.
Input parameters
The ID of the deal that will be merged and removed from the account
The ID of the deal that will remain in the account and receive the merged data. This deal takes priority in conflict scenarios, and all related data (activities, emails, notes, products, followers, participants, filters) will be transferred to it.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_MERGE_ORGANIZATIONSTool to merge two organizations in Pipedrive. Use when you need to consolidate two organizations into one. The organization specified by 'id' will be merged into the organization specified by 'merge_with_id', and the first organization will be removed while the second one will remain with all consolidated data.
Input parameters
The ID of the organization that will be merged and removed from the account
The ID of the organization that will remain in the account and receive the merged data. This organization takes priority in conflict scenarios.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_MERGE_PERSONSTool to merge two persons in Pipedrive. Use when you need to combine two person records into one. The person ID specified in the request will be merged and removed, while the merge_with_id person will remain. When data conflicts exist, the merge_with_id person's field data takes priority.
Input parameters
The ID of the person that will be merged and removed from Pipedrive
The ID of the person that will remain after the merge. This person's data will be prioritized in case of conflict with the other person.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_MERGE_TWO_DEALSMerges a deal with another deal. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-deals" target="_blank" rel="noopener noreferrer">merging two deals</a>.
Input parameters
The ID of the deal
The ID of the deal that the deal will be merged with
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_MERGE_TWO_ORGANIZATIONSMerges an organization with another organization. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-organizations" target="_blank" rel="noopener noreferrer">merging two organizations</a>.
Input parameters
The ID of the organization
The ID of the organization that the organization will be merged with
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_MERGE_TWO_PERSONSMerges a person with another person. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/merging-two-persons" target="_blank" rel="noopener noreferrer">merging two persons</a>.
Input parameters
The ID of the person
The ID of the person that will not be overwritten. This person’s data will be prioritized in case of conflict with the other person.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_ORGANIZATION_ACCESSIBLE_USER_LISTList users permitted to access an organization.
Input parameters
The ID of the organization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_PATCH_DEAL_FIELDSUpdates an existing deal custom field using PATCH method. Use when you need to modify field properties like name, visibility, or validation rules. Note that field code and type are immutable and cannot be changed.
Input parameters
The unique code identifying the field (40-character identifier for custom fields)
The name displayed for the field. At least one body parameter must be provided.
Text describing the field's purpose
Settings controlling where the field appears in the web UI
Settings for marking as mandatory at certain stages
Configuration for highlighting at specific stages
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_PATCH_ORGANIZATION_FIELDSTool to update an existing organization field in Pipedrive using the v2 API. Use when you need to modify field name, UI visibility, importance settings, required field settings, or description.
Input parameters
The unique code identifying the organization field to update
The new label/name for the organization field
Description text for the field (nullable)
Configuration for UI visibility settings
Configuration for making field required
Configuration for marking field as important
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_PATCH_PERSON_FIELDSTool to update person field configuration in Pipedrive. Use when you need to modify field properties like name, description, visibility settings, or requirement status. Only provided properties will be updated; omitted properties retain their existing values. Note: field_code and field_type cannot be changed.
Input parameters
The unique code identifying the field (40-character hash for custom fields)
Field display name (1-255 characters). At least one request body parameter must be provided
Field description text
Controls field appearance in Pipedrive interface
Marks field as mandatory
Configuration for highlighting field at specific deal stages
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_PRODUCTFIELDS_PATCH_PRODUCTFIELDSTool to update a product custom field. Use when you need to modify field name, UI visibility, or description. The field_code and field_type cannot be changed. At least one field must be provided in the request.
Input parameters
The unique code identifying the field to update (40-character hash)
Field name (1-255 characters). At least one of field_name, ui_visibility, or description must be provided.
Field description. Can be null to remove the description.
UI visibility settings for the product field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_REFRESH_TOKENSAccess tokens expire after the time specified in `expires_in`. To continue accessing the API, use the `refresh_token` to obtain a new access token.
Input parameters
The client ID provided to you by the Pipedrive Marketplace when you register your app
Since you are to refresh your access_token, you must use the value "refresh_token"
The client secret provided to you by the Pipedrive Marketplace when you register your app
The refresh token that you received after you exchanged the authorization code
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_REQUEST_AUTHORIZATIONAuthorize a user by redirecting them to the Pipedrive OAuth authorization page and request their permissions to act on their behalf. This step is necessary to implement only when you allow app installation outside of the Marketplace.
Input parameters
You may pass any random string as the state parameter and the same string will be returned to your app after a user authorizes access. It may be used to store the user"s session ID from your app or distinguish different responses. Using state may increase security; see RFC-6749. The state parameter is not automatically available in Marketplace Manager. To enable it for your app, please write to us at marketplace.devs@pipedrive.com.
The client ID provided to you by the Pipedrive Marketplace when you register your app
The callback URL you provided when you registered your app. Authorization code will be sent to that URL (if it matches with the value you entered in the registration form) if a user approves the app install. Or, if a customer declines, the corresponding error will also be sent to this URL.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_SEARCH_DEALSThis API endpoint searches deals by title, notes, and custom fields, filters results by person or organization ID, and is a specific use case of /v1/itemSearch with limited OAuth scope.
Input parameters
The search term to look for. Minimum 2 characters required (or 1 character if exact_match is set to true). Please note that the search term has to be URL encoded.
Items shown per page. Maximum value is 100.
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
Supports including optional fields in the results which are not provided by default
Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_SEARCH_ITEM_BY_FIELDPerforms a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete field values), or the IDs of actual items (deals, leads, persons, organizations or products).
Input parameters
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
Items shown per page
Pagination start
The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields" API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
The type of the field to perform the search from
When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive.
Whether to return the IDs of the matching items or not. When not set or set to `0` or `false`, only distinct values of the searched field are returned. When set to `1` or `true`, the ID of each found item is returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_SEARCH_LEADSEndpoint searches leads by title, notes, custom fields, with options to filter by person and organization IDs, and is a more specific use of the /v1/itemSearch with limited OAuth scope.
Input parameters
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
Items shown per page
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
A comma-separated string array. The fields to perform the search from. Defaults to all of them.
Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
Supports including optional fields in the results which are not provided by default
Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_SEARCH_MULTIPLE_ITEM_TYPESPerforms a search from your choice of item types and fields.
Input parameters
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
Items shown per page
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>`custom_fields`, `notes`, `title`</td></tr> <tr><td>Person</td><td>`custom_fields`, `email`, `name`, `notes`, `phone`</td></tr> <tr><td>Organization</td><td>`address`, `custom_fields`, `name`, `notes`</td></tr> <tr><td>Product</td><td>`code`, `custom_fields`, `name`</td></tr> <tr><td>Lead</td><td>`custom_fields`, `notes`, `email`, `organization_name`, `person_name`, `phone`, `title`</td></tr> <tr><td>File</td><td>`name`</td></tr> <tr><td>Mail attachment</td><td>`name`</td></tr> <tr><td>Project</td><td> `custom_fields`, `notes`, `title`, `description` </td></tr> </table> <br> Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.<br/> When searching for leads, the email, organization_name, person_name, and phone fields will return results only for leads not linked to contacts. For searching leads by person or organization values, please use `search_for_related_items`.
A comma-separated string array. The type of items to perform the search from. Defaults to all.
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
A comma-separated string array. Supports including optional fields in the results which are not provided by default.
When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_SEARCH_ORGANIZATIONSSearches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope.
Input parameters
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
Items shown per page
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_SEARCH_PERSONSThis endpoint searches for individuals by various identifiers and is a specific use case of /v1/itemSearch with limited OAuth scope, allowing results filtering by organization ID.
Input parameters
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Wildcards like '*' or '@' are NOT supported. To list all persons in an organization, use the GET_ALL_PERSONS or LIST_PERSONS_OF_AN_ORGANIZATION action instead.
Items shown per page
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
The field to perform the search from. Defaults to all searchable fields. Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone.
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
Supports including optional fields in the results which are not provided by default
Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_SEARCH_PRODUCTSSearches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope.
Input parameters
The search term to look for. Minimum 2 characters (or 1 if using `exact_match`). Please note that the search term has to be URL encoded.
Items shown per page
Pagination start. Note that the pagination is based on main results and does not include related items when using `search_for_related_items` parameter.
A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields <a href="https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields" target="_blank" rel="noopener noreferrer">here</a>.
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
Supports including optional fields in the results which are not provided by default
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_TAGES_UPDATE_STAGETool to update an existing stage in Pipedrive. Use when you need to modify stage properties such as name, deal probability, or rotten deal settings.
Input parameters
The ID of the stage to update
The name of the stage
The ID of the pipeline to add stage to
Number of days before deals become rotten; applies only when is_deal_rot_enabled is enabled
Success probability percentage for deals; utilized when deal weighted values are active. Must be between 0 and 100.
Whether deals in this stage can become rotten
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UNLINK_USER_FROM_VIDEO_CALL_INTEGRATIONA video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
Input parameters
Unique identifier linking a user to the installed integration
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_COMMENT_RELATED_TO_A_NOTEUpdates a comment related to a note.
Input parameters
The ID of the note
The content of the comment in HTML format. Subject to sanitization on the back-end.
The ID of the comment
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ACTIVITYTool to update an existing activity in Pipedrive including scheduling, assignments, descriptions, and participants. Use when you need to modify any properties of an activity such as subject, due date/time, status, or associated entities.
Input parameters
The unique identifier of the activity to update
Calendar availability flag (true=busy, false=available)
Completion status indicator (true=completed, false=not completed)
Internal activity comments/notes
The activity category/type (e.g., 'call', 'meeting', 'task')
Associated organization identifier
Associated deal identifier
Associated lead identifier (UUID format)
The activity's title/subject
Activity date in YYYY-MM-DD format
Activity time in HH:MM format
Activity length in HH:MM format
Geographic information with address fields or simple string address
User ID assigned to the activity
Importance level of the activity
External and internal meeting participants with email, name, and status
Primary participant identifier
Associated project identifier
Multiple person associations for the activity
Calendar-synced event details visible in external calendars
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ACTIVITY_IN_PROJECT_PLANUpdates an activity phase or group in a project.
Input parameters
The ID of the project
The ID of a group on a project board
The ID of a phase on a project board
The ID of the activity
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ACTIVITY_TYPETool to update an activity type in Pipedrive. Use when you need to modify the name, icon, color, or order of an existing activity type.
Input parameters
The identifier of the activity type to update
The designation of the activity type
Six-character hexadecimal color code (e.g., FFFFFF for white, 000000 for black)
Permitted icon values for activity types.
An order number for this activity type. Order numbers should be used to order the types in the activity type selections.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_DEALUpdates the properties of a deal. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/updating-a-deal" target="_blank" rel="noopener noreferrer">updating a deal</a>.
Input parameters
The ID of the deal
The deal title
Monetary value of the deal
ID of the organization
Status of the deal (open, won, lost). Defaults to open
ID of the user who will be marked as owner of this deal
Currency for the deal value (3-letter ISO code)
Stage ID for the deal
ID of the person this deal is linked to
Visibility of the deal (owner, entire company etc)
Reason for losing the deal (only with status=lost)
Pipeline ID for the deal
Success probability percentage (0-100)
Expected close date in format YYYY-MM-DD
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_DEAL_FIELDUpdates a deal field. For more information, see the tutorial for <a href= https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.
Input parameters
The ID of the field
The name of the field
When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `\[{"id":123,"label":"Existing Item"},{"label":"New Item"}\]`
Whether the field is available in "add new" modal or not (both in web and mobile app)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_FILTERUpdates an existing filter in Pipedrive. Use when you need to modify filter name or conditions. Maximum of 16 conditions per filter allowed.
Input parameters
The ID of the filter to update
The name assigned to the filter
Filter conditions as JSON object. Maximum of 16 conditions per filter. Date values must use YYYY-MM-DD format. Structure: {"glue":"and","conditions":\[{"object":"","field_id":"","operator":"","value":""}\]}
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_LEADUpdating lead properties modifies only specified fields; use `null` to unset. Custom field data matches `Deals`. Unset fields are omitted. Leads share deals' custom fields. For examples, refer to the tutorial.
Input parameters
The ID of the lead
The name of the lead
The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.
A flag indicating whether the lead was seen by someone in the Pipedrive UI
The IDs of the lead labels which will be associated with the lead
The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both.
A flag indicating whether the lead is archived or not
Amount
The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. A lead always has to be linked to a person or organization or both.
Currency
The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_LEAD_LABELUpdates one or more properties of a lead label. Only properties included in the request will be updated.
Input parameters
The ID of the lead label
The name of the lead label
The color of the label. Only a subset of colors can be used.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_AN_ACTIVITYUpdates an activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).
Input parameters
The ID of the activity
Whether the activity is done (0 = not done, 1 = done)
The note of the activity (HTML supported)
The type of the activity (e.g., call, meeting), correlates with ActivityTypes key_string
ID of the organization linked to the activity
ID of the deal linked to the activity
The subject of the activity
ID of the user who will own the activity
The due date of the activity (YYYY-MM-DD)
The due time of the activity (HH:MM)
The duration of the activity (e.g., 00:30)
Location of the activity
ID of the person linked to the activity
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_AN_ACTIVITY_TYPEUpdates an activity type.
Input parameters
The ID of the activity type
The name of the activity type
A designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
Icon graphic to use for representing this activity type
An order number for this activity type. Order numbers should be used to order the types in the activity type selections.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_AN_ORGANIZATIONUpdates the properties of an organization.
Input parameters
The ID of the organization
Organization name
Formatted address string
Organization website URL
The numeric ID of the industry option. This is an enum field with predefined options specific to your Pipedrive account. Use PIPEDRIVE_GET_ALL_ORGANIZATION_FIELDS to retrieve the 'industry' field and its available options (each option has an 'id' and 'label'). Pass the option 'id' here, not the label text.
LinkedIn URL
Owner user ID
IDs of labels to assign
Visibility (e.g., 1=owner only, 3=entire company)
The numeric ID of the annual revenue option. This is an enum field with predefined options specific to your Pipedrive account. Use PIPEDRIVE_GET_ALL_ORGANIZATION_FIELDS to retrieve the 'annual_revenue' field and its available options (each option has an 'id' and 'label'). Pass the option 'id' here, not the label text.
Employee count
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_AN_ORGANIZATION_FIELDUpdates an organization field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.
Input parameters
The ID of the field
The name of the field
When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `\[{"id":123,"label":"Existing Item"},{"label":"New Item"}\]`
Whether the field is available in "add new" modal or not (both in web and mobile app)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_AN_ORGANIZATION_RELATIONSHIPUpdates and returns an organization relationship.
Input parameters
The ID of the organization relationship
The type of organization relationship
The ID of the base organization for the returned calculated values
The owner of this relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
The linked organization in this relationship. If type is `parent`, then the linked organization is the daughter.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_NOTEUpdates a note.
Input parameters
The ID of the note
The ID of the organization the note will be attached to.
The content of the note in HTML format; subject to sanitization.
The ID of the deal the note will be attached to.
The ID (UUID) of the lead the note will be attached to.
The ID of the user to mark as the note’s author (admin only).
Optional creation date & time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
The ID of the person the note will be attached to.
The ID of the project the note will be attached to.
If set, updates note-to-deal pinning state (requires deal_id). 0 or 1.
If set, updates note-to-lead pinning state (requires lead_id). 0 or 1.
If set, updates note-to-person pinning state (requires person_id). 0 or 1.
If set, updates note-to-project pinning state (requires project_id). 0 or 1.
If set, updates note-to-organization pinning state (requires org_id). 0 or 1.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_PERSONModifies a person’s details in Pipedrive. See the linked tutorial for guidance. If utilizing Campaigns, the endpoint also handles `data.marketing_status`.
Input parameters
The ID of the person
The name of the person
List of email objects: { value: string, label?: string, primary?: bool }
List of phone objects: { value: string, label?: string, primary?: bool }
ID of the linked organization
Creation time (RFC 3339)
ID of the user who will be marked as the owner of this person
IDs of labels to assign to the person
Visibility of the person (e.g., 1=owner only, 3=entire company)
Last update time (RFC 3339)
Marketing status (no_consent, unsubscribed, subscribed, archived). Field is available only when Campaigns is enabled.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_PERSON_FIELDUpdates a person field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.
Input parameters
The ID of the field
The name of the field
When `field_type` is either set or enum, possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: `\[{"id":123,"label":"Existing Item"},{"label":"New Item"}\]`
Whether the field is available in "add new" modal or not (both in web and mobile app)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_PIPELINEUpdates the properties of a pipeline (v2).
Input parameters
The ID of the pipeline
The name of the pipeline
Whether deal probability is enabled for this pipeline
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_PRODUCTUpdates product data.
Input parameters
The ID of the product
Tax percentage
Product code
Product name
Sales unit of the product
Array of prices per currency
Product category
Owner user ID; if omitted, authorized user ID is used
Product visibility setting
Product description
Whether the product can be added to a deal
Billing frequency (one-time, annually, semi-annually, quarterly, monthly, weekly)
Number of billing repeats (rules depend on billing_frequency)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_A_PRODUCT_FIELDUpdates a product field. For more information, see the tutorial for <a href=" https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.
Input parameters
The ID of the product field
The name of the field
When `field_type` is either set or enum, possible options on update must be supplied as an array of objects each containing id and label, for example: \[{"id":1, "label":"red"},{"id":2, "label":"blue"},{"id":3, "label":"lilac"}\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_COMMENT_FOR_NOTETool to update a comment on a note in Pipedrive. Use when you need to modify the content of an existing comment attached to a note.
Input parameters
The ID of the note
The updated content of the comment in HTML format. Subject to sanitization on the back-end.
The ID of the comment in UUID format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_DEALTool to update an existing deal in Pipedrive. Use when you need to modify properties of a deal such as title, value, status, stage, or associated contacts/organizations.
Input parameters
The ID of the deal to update
The title/name of the deal
The monetary value of the deal
The ID of the organization associated with the deal
The status of the deal. Must be one of: open, won, lost
Three-letter ISO currency code for the deal value
The ID of the user who owns the deal
The ID of the stage within the pipeline
Date and time when status changed to won
Array of label IDs assigned to the deal
Date and time when status changed to lost
The ID of the person/contact associated with the deal
Date and time of closing the deal (for won/lost status)
Visibility setting for the deal
Whether the deal is archived. Note: From July 15, 2025, archived deals cannot be edited except for this property.
Reason for losing the deal. Required when status is set to 'lost'
The ID of the pipeline for the deal. When changed, stage_id auto-updates to first stage.
The success probability percentage (0-100)
Date and time of archiving in UTC in YYYY-MM-DD HH:MM:SS format
Expected closing date in YYYY-MM-DD format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_DEAL_DISCOUNTTool to update a discount for a specific deal. Use when you need to modify the amount, description, or type of an existing discount added to a deal in Pipedrive.
Input parameters
The ID of the deal
Determines whether the discount is applied as a percentage or a fixed amount.
The discount amount. Must be a positive number (excluding 0).
The name of the discount.
The ID of the discount to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_DEAL_FIELDTool to update a deal field in Pipedrive. Use when you need to modify existing deal field properties such as name, visibility, or options. Note that field_code and field_type cannot be changed.
Input parameters
The ID of the deal field to update
The name of the field
When field_type is either 'set' or 'enum', possible options must be supplied as a JSON-encoded sequential array of objects. All active items must be supplied and already existing items must have their ID supplied. New items only require a label. Example: \[{"id":123,"label":"Existing Item"},{"label":"New Item"}\]
Whether the field is available in "add new" modal or not (both in web and mobile app)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_DEALFIELDS_OPTIONSTool to update existing options for a deal custom field atomically. Use when you need to modify labels of options in a deal field.
Input parameters
Array of option objects to update. At least one option is required. The entire request fails if any option ID does not exist (atomic operation).
The unique 40-character code identifying the deal field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_DEAL_PRODUCTUpdates a product attached to a deal with new values. Use when you need to modify price, quantity, discount, tax, or other properties of a deal product.
Input parameters
The ID of the deal
The tax percentage or amount to apply
Comments or notes about this product attachment
The discount value. Use discount_type to specify whether this is a percentage or fixed amount
The quantity of the product in the deal
Whether the product is enabled in the deal. Disabled products are excluded from deal value calculations
The price at which this product will be updated in the deal
Tax calculation method: 'exclusive' (tax added to price), 'inclusive' (tax included in price), or 'none'
The type of discount: 'percentage' or 'amount'
Billing frequency for recurring products
Billing start date in YYYY-MM-DD format
The ID of the deal-product attachment (returned when adding a product to a deal)
Number of billing cycles for recurring products
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_DEAL_PRODUCT_ATTACHMENTUpdates the details of the product that has been attached to a deal.
Input parameters
The ID of the deal
The tax percentage
A textual comment associated with this product-deal attachment
The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage.
The duration of the product
How many items of this product will be added to the deal
The price at which this product will be added to the deal
The ID of the product to use
The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount.
Whether the product is enabled for a deal or not. This makes it possible to add products to a deal with a specific price and discount criteria, but keep them disabled, which refrains them from being included in the deal value calculation. When omitted, the product will be marked as enabled by default.
The type of the discount"s value.
The ID of the product variation to use. When omitted, no variation will be used.
The ID of the deal-product (the ID of the product attached to the deal)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_DEAL_V2Tool to update an existing deal using Pipedrive v2 API. Use when you need to modify deal properties including custom fields, archive status, or deletion status.
Input parameters
The ID of the deal to update
The title of the deal
The value of the deal
The ID of the organization linked to the deal
The status of the deal
The currency associated with the deal
The ID of the user who owns the deal
The ID of the deal stage
The date and time of changing the deal status as won. Can only be set if deal status is won.
The IDs of labels assigned to the deal
The date and time of changing the deal status as lost. Can only be set if deal status is lost.
The ID of the person linked to the deal
The date and time of closing the deal. Can only be set if deal status is won or lost.
Whether the deal is deleted or not
The visibility of the deal
Whether the deal is archived or not
The reason for losing the deal. Can only be set if deal status is lost.
The ID of the pipeline associated with the deal
The success probability percentage of the deal (must be an integer)
The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and is_archived is true, it will be set to the current date and time.
An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes
The expected close date of the deal in YYYY-MM-DD format
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_FILEUpdates the properties of a file including its visible name and description. Use when you need to modify file metadata in Pipedrive.
Input parameters
The ID of the file to update
The visible name of the file
The description of the file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_FILE_DETAILSUpdates the properties of a file.
Input parameters
The ID of the file
The visible name of the file
The description of the file
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_FILTERUpdates an existing filter.
Input parameters
The ID of the filter
The name of the filter
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_GOALUpdates an existing goal. Note: For OAuth, Goals API is available under {companydomain}/api/v1. The platform metadata base_url may be {companydomain}/v1, which yields 404 for PUT /goals/{id}. We therefore construct the URL using the company domain and /api/v1 explicitly.
Input parameters
The ID of the goal
The type of the goal and its parameters
The title of the goal
The assignee of the goal
Goal active duration
The interval of the goal
Expected outcome configuration
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_INSTALLMENT_SUBSCRIPTIONUpdates an installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action overrides the default request behavior and uses multiple hosts along with a practical fallback to Deal Products when Subscriptions/Installments features are not accessible.
Input parameters
The ID of the subscription
Array of payments. It requires a minimum structure as follows: \[{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }\]. Replace SUM with a payment amount, DESCRIPTION with a explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
Indicates that the deal value must be set to installment subscription"s total value
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_LEADTool to update a lead in Pipedrive. Use when you need to modify properties of an existing lead such as title, value, status, or linked contacts.
Input parameters
The unique identifier of the lead to update in UUID format
The name/title of the lead
Schema for the value object containing amount and currency
Marketing channel identifier
The ID of the user who will own the lead
Flag indicating if lead was seen in Pipedrive UI
Array of lead label identifiers to assign to the lead
ID of person to link to the lead. Lead requires person OR organization link. Set to null to unset.
Optional ID to distinguish the marketing channel
Visibility setting (values: 1, 3, 5, or 7 depending on plan)
Archive status flag. Set to true to archive the lead, false to unarchive.
ID of organization to link to the lead. Lead requires person OR organization link. Set to null to unset.
Expected close date in ISO 8601 format (YYYY-MM-DD)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_LEAD_LABELTool to update a lead label in Pipedrive. Use when you need to modify the name or color of an existing lead label. Only properties included in the request will be updated.
Input parameters
The ID of the lead label to update (UUID format)
The name of the lead label
The color of the label. Only a subset of colors can be used: blue, brown, dark-gray, gray, green, orange, pink, purple, red, yellow
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_MAIL_THREADUpdates the properties of a mail thread.
Input parameters
The ID of the mail thread
The ID of the deal this thread is associated with
The ID of the lead this thread is associated with
Whether this thread is marked as read (0 or 1)
Whether this thread is shared with other users (0 or 1)
Whether this thread is archived (0 or 1)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_NOTETool to update an existing note in Pipedrive. Use when you need to modify the content or properties of a note attached to deals, persons, organizations, leads, or projects.
Input parameters
The ID of the note to update
The ID of the organization to attach the note to.
The content of the note in HTML format. Subject to sanitization on the back-end.
The ID of the deal to attach the note to.
The ID of the lead to attach the note to (UUID format).
The ID of the user to mark as the note's author. Only administrators can change this.
Creation date and time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
The ID of the person to attach the note to.
The ID of the project to attach the note to.
If set, updates the note-to-deal pinning state. Requires deal_id to be set. 0 to unpin, 1 to pin.
If set, updates the note-to-lead pinning state. Requires lead_id to be set. 0 to unpin, 1 to pin.
If set, updates the note-to-person pinning state. Requires person_id to be set. 0 to unpin, 1 to pin.
If set, updates the note-to-project pinning state. Requires project_id to be set. 0 to unpin, 1 to pin.
If set, updates the note-to-organization pinning state. Requires org_id to be set. 0 to unpin, 1 to pin.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ORGANIZATIONTool to update an existing organization in Pipedrive. Use when you need to modify organization properties such as name, owner, visibility, labels, or address.
Input parameters
The unique identifier of the organization to update
The name of the organization
Address object with structured fields
The ID of the user who owns the organization
The IDs of labels assigned to the organization
The visibility of the organization. 1=owner only, 3=owner's visibility group, 7=entire company
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ORGANIZATION_FIELDTool to update an organization field in Pipedrive. Use when you need to modify the name, options, or visibility of an existing organization field.
Input parameters
The ID of the organization field to update
The name of the field
When field_type is either set or enum, possible options must be supplied as a JSON-encoded sequential array. Existing items require an ID and new items only require a label. Example: \[{'id': 123, 'label': 'Existing Item'}, {'label': 'New Item'}\]
Whether the field is available in 'add new' modal or not (both in web and mobile app)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ORGANIZATION_FIELD_OPTIONSTool to update existing options for an organization custom field atomically. Use when you need to modify option labels for an organization field. All specified option IDs must exist or the entire request fails.
Input parameters
Array of option objects to update. At least one option is required. Each option must have an id (existing option identifier) and label (new display text). The operation is atomic: all updates succeed or none are applied.
The unique code identifying the organization field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ORGANIZATION_RELATIONSHIPTool to update an organization relationship in Pipedrive. Use when you need to modify the type or organizations involved in an existing relationship between two organizations.
Input parameters
The ID of the organization relationship to update
Permitted relationship types for organization relationships.
The ID of the base organization for the returned calculated values
The owner of this relationship. If type is 'parent', then the owner is the parent and the linked organization is the daughter.
The linked organization in this relationship. If type is 'parent', then the linked organization is the daughter.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PERSONTool to update a person's properties in Pipedrive. Use when you need to modify existing person details such as name, contact information, owner, or organization.
Input parameters
The ID of the person to update
The person's full name
Email addresses as an array of objects with properties: value (required), primary (optional), label (optional)
Label ID for categorizing the person (deprecated in v2, use label_ids)
Phone numbers as an array of objects with properties: value (required), primary (optional), label (optional)
The ID of the organization this person belongs to
The creation date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
The ID of the user who will be the owner of the person. Requires proper permissions; without can_modify_owner_for_people permission, a 403 error will be thrown.
Array of label IDs to assign to the person
Visibility of the person. Values: 1 (Owner & followers), 3 (Entire company), 5 (Owner only), 7 (Owner's visibility group)
The last update date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
Marketing status. Only available if company uses Campaigns product. Must be one of: no_consent, unsubscribed, subscribed, archived
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PERSON_FIELDTool to update a person field in Pipedrive. Use when you need to modify the name, options, or visibility settings of an existing person field.
Input parameters
The ID of the person field to update
The field's display name
For enum/set field types, supply all active items. Each item should include 'id' (integer) for existing options to keep, or 'label' (string) for new options to add or to update existing option labels.
Controls whether the field is visible in 'add new' modal for web and mobile apps. Default is true.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PERSONFIELDS_OPTIONSTool to update existing options for a person custom field atomically. Use when you need to modify labels of options in a person field.
Input parameters
Array of option objects to update. At least one option is required. The entire request fails if any option ID does not exist (atomic operation).
The unique code identifying the person field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PERSON_V2Tool to update a person's properties in Pipedrive using the v2 API. Use when you need to modify existing person details such as name, contact information, owner, or organization.
Input parameters
The ID of the person to update
The person's full name
Email addresses as objects with properties: value, primary, label
The ID of the organization this person belongs to
Phone numbers as objects with properties: value, primary, label
The creation date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
The ID of the user who will be the owner of the person
Array of label IDs to assign to the person
The person's last name
The person's first name
Visibility of the person. Values: 1 (Owner & followers), 3 (Entire company), 5 (Owner only), 7 (Owner's visibility group)
The last update date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
Marketing status. Values: 'no_consent', 'unsubscribed', 'subscribed', 'archived'. Only available if company uses Campaigns product.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PIPELINETool to update a pipeline in Pipedrive. Use when you need to modify pipeline properties like name, deal probability, order, or active status. All fields except id are optional - only include the fields you want to update.
Input parameters
The ID of the pipeline to update
The name of the pipeline
Whether the pipeline is inactive/hidden (0) or active (1)
Defines the order of pipelines. The pipeline with order_nr=0 is the default pipeline
Whether deal probability is disabled (0) or enabled (1) for this pipeline
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PIPELINE_VISIBILITY_FOR_ROLEUpdates pipeline visibility settings for different roles. For details, see the Pipedrive Visibility groups article.
Input parameters
The ID of the role
Object specifying pipelines to add (visible) and/or remove (hidden) for the role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PRODUCTTool to update a product in Pipedrive. Use when you need to modify product details like name, code, price, tax, or other attributes.
Input parameters
The ID of the product to update
Tax percentage. Default is 0.
Product code/identifier
Product name. Cannot be blank if provided.
Unit of measurement for the product
Array of price objects. There can only be one price per product per currency.
Product category
ID of the user who will be marked as the owner. When omitted, the authorized user ID will be used.
Whether the product is selectable. Changed from integer to boolean as of April 3, 2023.
Visibility setting for the product. If omitted, default visibility will be used.
Whether the product is active. Changed from integer to boolean as of April 3, 2023.
Product description
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PRODUCT_FIELDTool to update a product field definition in Pipedrive. Use when you need to modify the name or options of an existing product custom field.
Input parameters
The ID of the product field to update
The name of the product field
When field_type is either 'set' or 'enum', possible options must be supplied as an array of objects, each containing 'id' and 'label' properties. Example: \[{"id": 1, "label": "red"}, {"id": 2, "label": "blue"}\]
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PRODUCTFIELDS_OPTIONSTool to update existing options for a product custom field atomically. Use when you need to modify labels of options in a product field.
Input parameters
Array of option objects to update. At least one option is required. The entire request fails if any option ID does not exist (atomic operation).
The unique code identifying the product field
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PRODUCT_IMAGETool to update an image for a product in Pipedrive. Use when you need to add or replace a product image.
Input parameters
The ID of the product to update the image for
Image file to upload. FileType object with 'name' (image filename e.g., 'product.png', 'image.jpg') and 'content' (base64-encoded image data). Supported formats: PNG, JPG, JPEG, GIF.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PRODUCT_VARIATIONTool to update a product variation in Pipedrive. Use when you need to modify variation details like name or prices across different currencies.
Input parameters
The ID of the product
The name of the product variation. Maximum length is 255 characters.
Array of price objects for different currencies. When omitted, existing prices remain unchanged. Only one price per variation per currency is supported.
The ID of the product variation to update
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_PROJECTUpdates a project.
Input parameters
The ID of the project
The title of the project
Array of IDs of labels the project has
The ID of the associated organization
The status of the project
The ID of the board this project is associated with
Array of IDs of associated deals
The end date (YYYY-MM-DD)
The ID of a project owner
The ID of the phase this project is associated with
The ID of the associated person
The start date (YYYY-MM-DD)
The description of the project
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_RECURRING_SUBSCRIPTIONUpdates a recurring subscription. Note: Some company hosts may not expose Subscriptions endpoints. This action will attempt multiple hosts and gracefully fall back to updating the product attached to a deal (v1) when applicable. In the fallback path, the request `id` is treated as the `product_attachment_id` and we locate the corresponding deal by scanning deal products.
Input parameters
The ID of the subscription
Array of additional payments. It requires a minimum structure as follows: \[{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }\]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
The description of the recurring subscription
The amount of each payment
All payments after that date will be affected. Format: YYYY-MM-DD
Indicates that the deal value must be set to recurring subscription"s MRR value
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ROLEUpdates the parent role and/or the name of a specific role. Notes: - Roles endpoints require the `admin` scope. - With OAuth (Bearer) tokens, Pipedrive expects the company domain base URL with `/api/v1` path, e.g. https://{COMPANY}.pipedrive.com/api/v1/roles/{id} - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used with the company domain when available. Falls back to the global API host otherwise.
Input parameters
The ID of the role
The name of the role
The ID of the parent role
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_ROLE_PIPELINESUpdates pipeline visibility for a role. Use when you need to control which sales pipelines are accessible to users within a particular role group.
Input parameters
The ID of the role
Structure for managing pipeline visibility. Specify pipeline IDs to add (make visible) or remove (make hidden) for the role.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_STAGETool to update stage details in Pipedrive. Use when you need to modify properties of an existing stage such as name, pipeline association, deal probability, or rotten deal settings.
Input parameters
The ID of the stage to update
The name of the stage. Cannot be null or empty when provided.
Numerical ordering position for the stage within its pipeline.
The pipeline ID the stage belongs to. Must match an existing pipeline.
Number of days before deals become rotten. Only applies when rotten_flag is enabled.
Whether deals in this stage can become rotten (deteriorate).
Success probability percentage for deals in this stage. Must be between 0 and 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_STAGE_DETAILSUpdates the properties of a stage.
Input parameters
The ID of the stage
The name of the stage
Order number of this stage within its pipeline
The ID of the pipeline to add the stage to
Days until deals become rotten (applies when rotten_flag is true)
Whether deals in this stage can become rotten
Success probability percentage (0–100)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_TASKUpdates a task.
Input parameters
The ID of the task
0 = Not done, 1 = Done
The title of the task
The task’s due date (YYYY-MM-DD)
The ID of a project
The assignee user ID
The description of the task
The ID of a parent task; cannot be a subtask’s ID
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_TASK_IN_PROJECT_PLANUpdates a task phase or group in a project.
Input parameters
The ID of the project
The ID of the task
The ID of a group on a project board
The ID of a phase on a project board
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_TEAMUpdates an existing team and returns the updated object.
Input parameters
The ID of the team
The team name
The list of user IDs
The team manager ID
Flag that indicates whether the team is active (0/1)
The team description
Flag that indicates whether the team is deleted (0/1)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_USERTool to update user details in Pipedrive. Use when you need to activate or deactivate a user account. Requires admin-level permissions.
Input parameters
The ID of the user to update
Indicates user status. false = Not activated, true = Activated
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
PIPEDRIVE_UPDATE_USER_DETAILSUpdates the properties of a user. Currently, only `active_flag` can be updated.
Input parameters
The ID of the user
Whether the user is active or not. `false` = Not activated, `true` = Activated
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 66 agents privately built on Nagent that already use Pipedrive.
Build on Nagent
Connect Pipedrive to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Pipedrive, and click "Connect Now." You'll authenticate with OAUTH2, API_KEY — Nagent handles credential storage and refresh automatically. Once connected, Pipedrive is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Pipedrive is connected, you configure its 401 actions and 3 triggers directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Pipedrive steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Pipedrive event fires, the agent kicks off automatically.
Every Pipedrive action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Pipedrive ships with 401 pre-built crm actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Pipedrive together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Pipedrive-based workflows tailored to your business.