Skip to main content
Pipedrive logo
  • Category: crm
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? No
  • Tools: 406
  • Triggers: 3
  • Slug: PIPEDRIVE
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Pipedrive OAuth credentials with Composio, see How to create OAuth credentials for Pipedrive.
Pipedrive usually shows “App not found” when the OAuth app used for the connection is not approved or available for that user/workspace.If you are using managed Pipedrive OAuth, this means the managed OAuth app is still under Pipedrive review/verification. If you are using your own Pipedrive OAuth app, check the app’s approval/verification status in Pipedrive and make sure the user is authorizing the same app configured in the auth config. After the app is approved or corrected, start a fresh connection.
Create the OAuth app in Pipedrive Developer Hub, then use that app’s client ID and client secret in a Pipedrive custom OAuth auth config.Do not start the user connection by clicking Install and Test inside Pipedrive’s OAuth app settings. That button starts Pipedrive’s own test/install flow, not the Composio connection flow, and can send the user to the callback URL without the Composio auth config context.After saving the custom auth config, start the connection from Composio and enter the Pipedrive subdomain when prompted. If Pipedrive shows “App not found”, verify that the client ID and secret match the same Pipedrive OAuth app, that the app is approved/available for the user, and that the redirect URI matches the Pipedrive auth setup guide.

Tools

Slug: PIPEDRIVE_ADD_ACTIVITY_TYPEAdds a new activity type.

Input Parameters

string
required
The name of the activity type
string
A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black)
string ("task" | "email" | "meeting" | "deadline" | "call" | "lunch" | "calendar" | "downarrow" | "document" | "smartphone" | "camera" | "scissors" | "cogs" | "bubble" | "uparrow" | "checkbox" | "signpost" | "shuffle" | "addressbook" | "linegraph" | "picture" | "car" | "world" | "search" | "clip" | "sound" | "brush" | "key" | "padlock" | "pricetag" | "suitcase" | "finish" | "plane" | "loop" | "wifi" | "truck" | "cart" | "bulb" | "bell" | "presentation")
required
Icon graphic to use for representing this activity type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_A_DEALCreates a Pipedrive deal with a title and optional properties such as owner, linked person or organization, pipeline, stage, value, and status. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use POST /api/v2/deals instead.

Input Parameters

string
required
The deal title
number
Monetary value of the deal
integer
ID of the organization
string
Status of the deal (open, won, lost). Defaults to open
integer
ID of the user who will be marked as owner of this deal
string
Currency for the deal value (3-letter ISO code)
integer
Stage ID for the deal
integer
ID of the person this deal is linked to
integer
Visibility of the deal (owner, entire company etc)
integer
Pipeline ID for the deal
number
Success probability percentage (0-100)
string
Expected close date in format YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

integer
Whether the activity is done (0 = not done, 1 = done)
string
Note/description of the activity
string
required
The type of the activity (matches ActivityTypes.key_string)
string
ID of the linked organization
string
ID of the linked deal (integer or numeric string)
string
ID of the linked lead (UUID string)
string
required
The subject/title of the activity
integer
ID of the user who owns the activity
string
Due date of the activity (YYYY-MM-DD)
string
Due time of the activity (HH:MM)
string
Duration of the activity (e.g., 00:30)
string
Location/address of the activity
array
Attendees of the activity (contacts or external emails)
boolean
Whether the activity marks the assignee as busy
integer
ID of the linked person
integer
ID of the linked project
array
Participants of the activity
string
Public description synced to external calendar

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_AN_ORGANIZATIONCreates a new organization in Pipedrive with a required name and optional owner and visibility settings.

Input Parameters

string
required
The name of the organization to create (required). This is typically a company or business name such as ‘Acme Corp’ or ‘Tech Solutions Inc.’
integer
Owner user ID
integer
Visibility (e.g., 1=owner only, 3=entire company)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
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.
string
required
The content of the note in HTML format. Subject to sanitization on the back-end.
integer
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.
string
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.
string
The optional creation date & time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
integer
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.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_A_PERSONAdds a new contact in Pipedrive. For Campaigns users, it can also set the marketing status.

Input Parameters

string
required
The name of the person. REQUIRED by Pipedrive API.
array
List of email objects: { value: string, label?: string, primary?: bool }
array
List of phone objects: { value: string, label?: string, primary?: bool }
integer
ID of the linked organization
string
Creation time (RFC 3339)
integer
ID of the user who will be marked as the owner of this person
array
IDs of labels to assign to the person
integer
Visibility of the person (e.g., 1=owner only, 3=entire company)
string
Last update time (RFC 3339)
string
Marketing status (no_consent, unsubscribed, subscribed, archived). Field is available only when Campaigns is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_CALL_LOGAdds a new call log.

Input Parameters

string
The note for the call log in HTML format
integer
The ID of the organization this call is associated with
integer
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.
string
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.
string ("connected" | "no_answer" | "left_message" | "left_voicemail" | "wrong_number" | "busy")
required
Describes the outcome of the call
string
The name of the activity this call is attached to
integer
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.
string
The duration of the call in seconds
string
required
The date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
integer
The ID of the person this call is associated with
string
required
The date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
integer
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.
string
required
The number called
string
The number that made the call

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the call log to attach the recording to. This is the ID received when you create the call log.
object
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_CHANNELRegisters a messaging channel for an admin, using the Messengers integration OAuth scope and a prepared Messaging app extension manifest. The Channels API is deprecated and its availability is no longer assured.

Input Parameters

string
required
The name of the channel
string
The URL for an icon that represents your channel
string ("facebook" | "whatsapp" | "other")
It controls the icons (like the icon next to the conversation)
boolean
If true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more here.
string
required
The channel ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal to add the discount to
string ("percentage" | "amount")
required
Determines whether the discount is applied as a percentage or a fixed amount
number
required
The discount amount. Must be a positive number (excluding 0).
string
required
The name of the discount

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the field
array
When field_type is either set or enum, possible options must be supplied [{“label”:“red”}, {“label”:“blue”}, {“label”:“lilac”}]
string ("varchar" | "varchar_auto" | "text" | "double" | "monetary" | "date" | "set" | "enum" | "user" | "org" | "people" | "phone" | "time" | "timerange" | "daterange" | "address")
required
The type of the field. Supported values: varchar, varchar_auto, text, double, monetary, date, set, enum, user, org, people, phone, time, timerange, daterange, address
boolean
Whether the field is available in “add new” modal or not (both in web and mobile app)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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.
string
required
The unique code identifying the deal field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_DEAL_FOLLOWERAdds a follower to a deal.

Input Parameters

integer
required
The ID of the deal
integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_DEAL_PARTICIPANTAdds a participant to a deal.

Input Parameters

integer
required
The ID of the deal
integer
required
The ID of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal to which the product will be added
number
The product tax percentage
string
Notes or comments about the product
number
The value of the discount (use with discount_type to specify if amount or percentage)
number
Duration value for the product
number
required
The quantity of the product to add
boolean
Whether this product is enabled for the deal (cannot be disabled if deal has installments and product is the last enabled one)
number
required
The price value at which this product is added to the deal
integer
required
The ID of the product to attach to the deal
string
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
string
Specifies whether discount is a ‘percentage’ or ‘amount’
string
How often the product is billed (Growth+ plans only): ‘one-time’, ‘annually’, ‘semi-annually’, ‘quarterly’, ‘monthly’, or ‘weekly’
string
Billing start date in YYYY-MM-DD format (within ±10 years from today)
number
Discount percentage (legacy parameter, use discount + discount_type instead)
integer
The ID of the product variation if applicable
integer
Number of times the billing frequency repeats (must be positive integer, maximum 208)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal to which products will be attached
array
required
Array of product objects to attach to the deal. Maximum 100 products per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
File to upload (base64 content supported)
integer
Org Id
integer
Deal Id
string
Lead Id (UUID)
integer
Person Id
integer
Product Id
integer
Activity Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the filter
string
required
The type of the filter. One of: deals, leads, org, people, products, activity, projects
object
required
Filter conditions object. Must follow structure with a top-level ‘and’ group containing two groups (one ‘and’ and one ‘or’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
The type of the goal and its parameters
string
The title of the goal
object
required
The assignee of the goal
object
required
Goal active duration
string ("weekly" | "monthly" | "quarterly" | "yearly")
required
The interval of the goal
object
required
Expected outcome configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_INCOMING_MESSAGESubmits an incoming message to a conversation using the Channels API, requiring the Messengers integration OAuth scope and a Messaging app extension manifest. The endpoint is deprecated and was guaranteed accessible only until February 1, 2026.

Input Parameters

string
required
The ID of the message
string ("sent" | "delivered" | "read" | "failed")
required
The status of the message
string
required
The body of the message
string
The date and time when the message can no longer receive a reply, in UTC. Format: YYYY-MM-DD HH:MM
string
required
The ID of the provider”s user that sent the message
string
required
The channel ID as in the provider
string
required
The date and time when the message was created in the provider, in UTC. Format: YYYY-MM-DD HH:MM
array
The list of attachments available in the message
string
required
The ID of the conversation
A URL that can open the conversation in the provider”s side

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_INSTALLMENT_SUBSCRIPTIONAdds an installment subscription for a deal using the supplied payment schedule. Individual deal installments may be created instead; creation is not atomic, so only some payments may be created, and the result may contain only the first created installment.

Input Parameters

integer
required
The ID of the deal this installment subscription is associated with
string
required
The currency of the installment subscription. Accepts a 3-character currency code.
array
required
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).
boolean
Indicates that the deal value must be set to the installment subscription”s total value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_LEADAdds a lead linked to a person or organization and tagged with an API source.

Input Parameters

string
required
The name of the lead
integer
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.
boolean
A flag indicating whether the lead was seen by someone in the Pipedrive UI
array
The IDs of the lead labels which will be associated with the lead
integer
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.
integer
Amount
integer
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.
string
Currency
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_LEAD_LABELCreates a lead label.

Input Parameters

string
required
The name of the lead label
string ("green" | "blue" | "red" | "yellow" | "purple" | "gray" | "brown" | "dark-gray" | "orange" | "pink")
required
The color of the label. Only a subset of colors can be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
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.
string
required
The content of the note in HTML format. Subject to sanitization on the back-end.
integer
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.
string
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.
integer
The ID of the user who will be marked as the author of the note. Only admins can change this.
string
The creation timestamp for the note in UTC. Format: YYYY-MM-DD HH:MM:SS
integer
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.
integer
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.
integer ("0" | "1")
If set to 1, the note will be pinned to the deal. 0 or omit to not pin.
integer ("0" | "1")
If set to 1, the note will be pinned to the lead. 0 or omit to not pin.
integer ("0" | "1")
If set to 1, the note will be pinned to the person. 0 or omit to not pin.
integer ("0" | "1")
If set to 1, the note will be pinned to the project. 0 or omit to not pin.
integer ("0" | "1")
If set to 1, the note will be pinned to the organization. 0 or omit to not pin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the note to add a comment to.
string
required
The content of the comment in HTML format. Subject to sanitization on the back-end.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_ORGANIZATION_FIELDAdds a custom field to Pipedrive organizations. Specify its name and type, options for set or enum fields, and optionally whether it appears in the add-new form. Requires admin scope.

Input Parameters

string
required
The name of the field
array
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"}]
string ("varchar" | "varchar_auto" | "text" | "double" | "monetary" | "date" | "set" | "enum" | "user" | "org" | "people" | "phone" | "time" | "timerange" | "daterange" | "address")
required
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>
boolean
Whether the field is available in “add new” modal or not (both in web and mobile app)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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.
string
required
The unique code identifying the organization field (enum or set type) to add options to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
required
The ID of the user to add as a follower to the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role
integer
required
Possible values for the default_visibility setting depending on the subscription plan:
<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>
<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>
Read more about visibility groups <a href=“https://support.pipedrive.com/en/article/visibility-groups”&gt;here&lt;/a>.
string ("deal_default_visibility" | "lead_default_visibility" | "org_default_visibility" | "person_default_visibility" | "product_default_visibility")
required
Setting Key

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_PERSON_FIELDAdds a custom field to Pipedrive person records. Specify its name and type, options for set or enum fields, and optionally whether it appears in the add-new form. Requires contact-fields:full or admin scope.

Input Parameters

string
required
The name of the field
array
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”}]
string
Optional API token to use as query parameter when OAuth scope does not permit POST; if provided, overrides Authorization header.
string ("address" | "date" | "daterange" | "double" | "enum" | "monetary" | "org" | "people" | "phone" | "set" | "text" | "time" | "timerange" | "user" | "varchar" | "varchar_auto" | "visible_to")
required
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.
boolean
Whether the field is available in the add new modal (web and mobile). Default true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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.
string
required
The unique code identifying the person field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person to add a follower to
integer
required
The ID of the user to add as a follower to the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
object
Image file to set as the person’s picture (GIF/JPG/PNG)
integer
Crop X (pixels)
integer
Crop Y (pixels)
integer
Crop width (pixels)
integer
Crop height (pixels)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_PIPELINEAdds a new pipeline (v2).

Input Parameters

string
required
The name of the pipeline
boolean
Whether deal probability is enabled for this pipeline

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Tax percentage
string
Product code
string
required
Product name; cannot be empty
string
Sales unit of the product
array
Array of prices per currency
integer
Product category
integer
Owner user ID; if omitted, authorized user ID is used
integer
Product visibility setting
string
Product description
boolean
Whether the product can be added to a deal
string
Billing frequency (one-time, annually, semi-annually, quarterly, monthly, weekly)
integer
Number of billing repeats (rules depend on billing_frequency)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The name of the field
array
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"}]
string ("varchar" | "varchar_auto" | "text" | "double" | "monetary" | "date" | "set" | "enum" | "user" | "org" | "people" | "phone" | "time" | "timerange" | "daterange" | "address")
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
Array of option objects to add. At least one option is required. Each option must have a label field.
string
required
The unique code identifying the field to add options to. This field must be of type enum or set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product to which the follower will be added
integer
required
The ID of the user to add as a follower to the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product to add the image to
object
required
The image file to upload (PNG, JPG, GIF). Provide the file content as base64-encoded string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product to add the variation to
string
required
The name of the product variation (maximum 255 characters)
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_PROJECTAdds a new project to Pipedrive. The response contains the API response body, including any reported error.

Input Parameters

string
required
The title of the project
array
IDs of labels for this project
integer
ID of associated organization
string
Project status
integer
required
The ID of a project board
array
IDs of deals associated with this project
string
Project end date (YYYY-MM-DD)
integer
Project owner’s ID
integer
required
The ID of a phase on the project board
integer
ID of associated person
string
Project start date (YYYY-MM-DD)
string
Project description
integer
ID of the template the project will be based on

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_RECURRING_SUBSCRIPTIONAdds a recurring subscription to a deal. The operation may instead create and attach a product representing recurring billing; a product attachment is not a recurring subscription.

Input Parameters

integer
required
The ID of the deal this recurring subscription is associated with
string
required
The currency of the recurring subscription. Accepts a 3-character currency code.
boolean
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
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).
string
required
The start date of the recurring subscription. Format: YYYY-MM-DD
string
The description of the recurring subscription
string ("weekly" | "monthly" | "quarterly" | "semi-annually" | "annually" | "yearly" | "custom")
required
The interval between payments
integer
required
The amount of each payment
integer
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.
boolean
Indicates that the deal value must be set to recurring subscription”s MRR value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_ROLEAdds a new role. Roles endpoints require the admin scope.

Input Parameters

string
required
The name of the role
integer
The ID of the parent role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role
integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_STAGEAdds a new stage, returns the ID upon success.

Input Parameters

string
required
The name of the stage
integer
required
The ID of the pipeline to add stage to
integer
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)
boolean
Whether deals in this stage can become rotten (v1: rotten_flag; v2: is_deal_rot_enabled)
integer
The success probability percentage of the deal. Used/shown when deal weighted values are used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_TASKAdds a new task.

Input Parameters

integer
0 = Not done, 1 = Done
string
required
The title of the task
string
The task’s due date (YYYY-MM-DD)
integer
required
The ID of a project
integer
The assignee user ID
string
The description of the task
integer
The ID of a parent task; cannot be a subtask’s ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_TEAMAdds a new team to the company and returns the created object.

Input Parameters

string
required
The team name
array
The list of user IDs
integer
required
The team manager ID
string
The team description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_TEAM_USERSAdds users to an existing team.

Input Parameters

integer
required
The ID of the team
array
required
The list of user IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ADD_USERAdds a new user to the company, returns the ID upon success.

Input Parameters

string
required
The email of the user
array
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" }]
boolean
Whether the user is active or not. false = Not activated, true = Activated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ARCHIVE_PROJECTArchives a project.

Input Parameters

integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_CANCEL_RECURRING_SUBSCRIPTIONCancels a recurring subscription, optionally specifying a termination date. The operation may instead disable product attachments on the deal whose ID matches the supplied ID; disabling attachments does not cancel the subscription, and changes can be partial.

Input Parameters

integer
required
The ID of the subscription. Fallback: treated as the deal ID when Subscriptions API is unavailable.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal to convert to a lead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the lead to convert (UUID format)
integer
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.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_CREATE_ORGANIZATION_RELATIONSHIPCreates and returns an organization relationship.

Input Parameters

string ("parent" | "related")
required
The type of organization relationship
integer
The ID of the base organization for the returned calculated values
integer
required
The owner of the relationship. If type is parent, then the owner is the parent and the linked organization is the daughter.
integer
required
The linked organization in the relationship. If type is parent, then the linked organization is the daughter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_CREATE_WEBHOOKCreates a webhook and returns its details. Specify an event action and object, including wildcards for supported events; webhook version 2.0 is the default, with version 1.0 also selectable.

Input Parameters

string
required
The webhook’s name
integer
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.
string ("1.0" | "2.0")
The webhook”s version
string ("added" | "updated" | "merged" | "deleted" | "create" | "change" | "delete" | "*")
required
The type of action to receive notifications about. Wildcard will match all supported actions.
string ("activity" | "activityType" | "deal" | "note" | "organization" | "person" | "pipeline" | "product" | "stage" | "user" | "lead" | "*")
required
The type of object to receive notifications about. Wildcard will match all supported objects.
string
The HTTP basic auth username of the subscription URL endpoint (if required)
string
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.
string
The HTTP basic auth password of the subscription URL endpoint (if required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Pagination limit for number of results to return. Default: 100, Maximum: 500
string
Marker for pagination to fetch the next page of results
string
Optional comma separated string array of additional data namespaces to include in response (e.g., ‘ui_visibility’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
number
Product tax amount (default: 0)
string
Product notes/comments
number
Discount value - amount or percentage based on discount_type (default: 0)
number
Quantity of the product
boolean
Whether product is active/enabled for the deal. Note: API v2 uses strict validation - only accepts true/false, not 1/0.
number
Price value for the product
integer
The product identifier
string ("exclusive" | "inclusive" | "none")
Tax application method - ‘exclusive’ (tax not included in price), ‘inclusive’ (tax included in price), or ‘none’ (no tax)
string ("percentage" | "amount")
Discount type - either ‘percentage’ or ‘amount’
string ("one-time" | "annually" | "semi-annually" | "quarterly" | "monthly" | "weekly")
Billing cycle option for Growth+ plans - ‘one-time’, ‘annually’, ‘semi-annually’, ‘quarterly’, ‘monthly’, or ‘weekly’
string
When billing commences (Growth+ plans). Format: YYYY-MM-DD
integer
Specific product variation identifier
integer
required
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.
integer
Number of billing frequency repetitions (Growth+ plans)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_ACTIVITIES_BULKMarks multiple Pipedrive activities as deleted by their comma-separated IDs. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use DELETE /api/v2/activities instead.

Input Parameters

string
required
The comma-separated IDs of activities that will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the activity to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the activity type to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_ACTIVITY_TYPES_BULKMarks multiple activity types as deleted.

Input Parameters

string
required
The comma-separated activity type IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_AN_ACTIVITYMarks an activity as deleted. After 30 days, the activity will be permanently deleted.

Input Parameters

integer
required
The ID of the activity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_A_PERSONMarks a person as deleted. After 30 days, the person will be permanently deleted.

Input Parameters

integer
required
The ID of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_A_STAGEMarks a stage as deleted. Uses the company-domain v2 endpoint.

Input Parameters

integer
required
The ID of the stage

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID received when you create the call log

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_CHANNELRequests deletion of a messenger channel along with its conversations and messages, using Messengers integration OAuth and a Messaging app extension manifest. The Channels API is deprecated; reported success can also result from a 404 or other unsuccessful responses.

Input Parameters

string
required
The ID of the channel provided by the integration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the note
string
required
The ID of the comment in UUID format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_CONVERSATIONDeletes a conversation from a messaging channel, using the Messengers integration OAuth scope and a Messaging app extension manifest. A not-found response is reported as success and does not confirm deletion. DEPRECATED: Pipedrive guaranteed access to this Channels API endpoint only until February 1, 2026; use an alternative solution.

Input Parameters

string
required
The ID of the channel provided by the integration
string
required
The ID of the conversation provided by the integration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
string
required
The ID of the discount to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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).
string
required
The unique code identifying the deal field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_DEAL_FIELDS_BULKMarks multiple deal fields as deleted. API error payloads may be returned as data, so a returned response does not itself confirm deletion.

Input Parameters

string
required
The comma-separated field IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
integer
required
The ID of the follower to be removed from the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_DEAL_PARTICIPANTDeletes a participant from a deal.

Input Parameters

integer
required
The ID of the deal
integer
required
The ID of the participant of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_DEALS_BULKMarks multiple deals as deleted using a comma-separated list of deal IDs. DEPRECATED: This API v1 endpoint is out of support and its availability and behavior are not guaranteed. Use DELETE /api/v2/deals instead.

Input Parameters

string
required
The comma-separated IDs that will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the file to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_FILTERTool to delete a filter in Pipedrive. Use when you need to remove a specific filter by its ID.

Input Parameters

integer
required
The ID of the filter to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_FILTERS_BULKMarks multiple filters as deleted.

Input Parameters

string
required
The comma-separated filter IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the goal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_LEADDeletes a specific lead.

Input Parameters

string
required
The ID of the lead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The UUID identifier of the lead label to be deleted. Must be in UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_MAIL_THREADMarks a mail thread as deleted.

Input Parameters

integer
required
The ID of the mail thread

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_MULTIPLE_PRODUCT_FIELDSMarks multiple product fields as deleted.

Input Parameters

string
required
The comma-separated field IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_MULTIPLE_STAGESMarks multiple Pipedrive stages as deleted using a comma-separated list of stage IDs. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use DELETE /api/v2/stages instead.

Input Parameters

string
required
The comma-separated stage IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_NOTEDeletes a specific note.

Input Parameters

integer
required
The ID of the note

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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.
string
required
The unique code identifying the organization field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_ORGANIZATION_FIELDS_BULKMarks multiple organization fields as deleted.

Input Parameters

string
required
The comma-separated field IDs to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
required
The ID of the follower to be removed from the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_ORGANIZATION_RELATIONSHIPDeletes an organization relationship and returns the deleted ID.

Input Parameters

integer
required
The ID of the organization relationship

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_ORGANIZATIONS_BULKMarks multiple Pipedrive organizations as deleted using a comma-separated list of IDs; the organizations are permanently deleted after 30 days. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use DELETE /api/v2/organizations instead.

Input Parameters

string
required
The comma-separated IDs that will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the person field to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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).
string
required
The unique code identifying the person field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PERSON_FIELDS_BULKMarks multiple person fields as deleted.

Input Parameters

string
required
The comma-separated field IDs to delete
string
Optional API token to use as query parameter when OAuth scope does not permit DELETE; if provided, overrides Authorization header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PERSON_FOLLOWERDeletes a follower from a person.

Input Parameters

integer
required
The ID of the person
integer
required
The ID of the follower

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PERSONS_BULKMarks multiple Pipedrive persons as deleted using a comma-separated list of IDs. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use DELETE /api/v2/persons instead.

Input Parameters

string
required
The comma-separated IDs that will be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PIPELINEMarks a pipeline as deleted.

Input Parameters

integer
required
The ID of the pipeline

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PRODUCTMarks a product as deleted. After 30 days, the product will be permanently deleted.

Input Parameters

integer
required
The ID of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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).
string
required
The unique code identifying the product field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PRODUCT_FOLLOWERDeletes a follower from a product.

Input Parameters

integer
required
The ID of the product
integer
required
The ID of the relationship between the follower and the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PRODUCT_IMAGETool to delete an image from a product in Pipedrive. Use when you need to remove a product image.

Input Parameters

integer
required
The ID of the product from which to delete the image
integer
required
The ID of the image to delete from the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product
integer
required
The ID of the product variation to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_PROJECTMarks a project as deleted.

Input Parameters

integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_ROLE_ASSIGNMENTRemoves the assigned user from a role and adds to the default role.

Input Parameters

integer
required
The ID of the role
integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_STAGEDeletes a Pipedrive pipeline stage by ID. DEPRECATED: The API v1 endpoint is out of support and its availability and behavior are not guaranteed. Use DELETE /api/v2/stages/{id} instead.

Input Parameters

integer
required
The ID of the stage to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_SUBSCRIPTIONMarks an installment or recurring subscription as deleted by ID. The operation may instead delete a deal product attachment with the same ID.

Input Parameters

integer
required
The ID of the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_TASKMarks a task as deleted. If the task has subtasks then those will also be deleted.

Input Parameters

integer
required
The ID of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_TEAM_USERSDeletes users from an existing team.

Input Parameters

integer
required
The ID of the team
array
required
The list of user IDs

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DELETE_WEBHOOKDeletes the specified Webhook.

Input Parameters

integer
required
The ID of the Webhook to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DOWNLOAD_FILEInitializes a file download.

Input Parameters

integer
required
The ID of the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_DUPLICATE_DEALDuplicates a deal.

Input Parameters

integer
required
The ID of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product to duplicate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ENUMERATE_ACCESSIBLE_USERS_FOR_LEADLists the users permitted to access a lead.

Input Parameters

string
required
The ID of the lead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_FIND_GOALSFind goals using supported criteria, including goal status and period. The status filter defaults to active goals; specify both period start and end for time-based searches.

Input Parameters

string
The title of the goal
boolean
Whether the goal is active or not
string ("deals_won" | "deals_progressed" | "activities_completed" | "activities_added" | "deals_started" | "revenue_forecast")
The type of the goal. If provided, everyone”s goals will be returned.
string
The end date of the period for which to find goals. Date in format of YYYY-MM-DD.
integer
The ID of the user who”s goal to fetch. When omitted, only your goals will be returned.
string
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.
string ("person" | "company" | "team")
The type of the goal”s assignee. If provided, everyone”s goals will be returned.
integer
The ID of the stage. Applicable to only deals_progressed type of goals. If provided, everyone”s goals will be returned.
integer
The numeric value of the outcome. If provided, everyone”s goals will be returned.
array
An array of pipeline IDs or null for all pipelines. If provided, everyone”s goals will be returned.
integer
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.
array
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.
string ("quantity" | "sum")
The tracking metric of the expected outcome of the goal. If provided, everyone”s goals will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_FIND_USERS_BY_NAMEFinds users by name or, when email search is enabled, by email address.

Input Parameters

string
required
The search term to look for
integer
When enabled, the term will only be matched against email addresses of users. Default: false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ACTIVITYReturns the details of a specific activity.

Input Parameters

integer
required
The ID of the activity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique code identifying the field (e.g., ‘subject’, ‘due_date’, or a 40-character hash for custom fields)
string ("ui_visibility")
Enum for additional data namespaces to include in response

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_ACTIVITIES_ASSIGNED_TO_A_PARTICULAR_USERReturns all activities assigned to a particular user.

Input Parameters

integer
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities.
string
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.
integer
Number of activities to return per page (defaults to 100 if not specified)
integer
For pagination, the position that represents the first result for the page
string
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.
integer
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.
string
Use the activity due date where you wish to stop fetching activities from. Insert due date in YYYY-MM-DD format.
integer
The ID of the filter to use (will narrow down results if used together with user_id parameter)
string
Use the activity due date where you wish to begin fetching activities from. Insert due date in YYYY-MM-DD format.
string ("minimal" | "full")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

boolean
Whether the activity is done or not. false = Not done, true = Done. If omitted, returns both done and not done activities.
string
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.
integer
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.
string
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.
string
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.
string
For pagination, the marker (an opaque string value) representing the first item on the next page
integer
The ID of the user whose activities will be fetched. If omitted, all activities are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_ACTIVITY_FIELDSReturns all activity fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_ACTIVITY_TYPESReturns all activity types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_DEAL_FIELDSReturns data about all deal fields.

Input Parameters

integer
Items shown per page. Must be > 0 if provided.
integer
Pagination start. Must be >= 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_DEALSLists deals with filtering, sorting and pagination. Archived deals are not returned by default.

Input Parameters

string
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).
integer
Items shown per page (1-500). If not provided, 100 items will be returned.
integer
Pagination start
string ("open" | "won" | "lost" | "deleted" | "all_not_deleted")
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.
integer
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.
integer
If supplied, only deals within the given stage will be returned
integer
The ID of the filter to use
integer
When supplied, only deals owned by you are returned. However, filter_id takes precedence over owned_by_you when both are supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
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.
string
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.
string
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.
string
For pagination, the marker (an opaque string value) representing the first item on the next page
string ("open" | "won" | "lost" | "deleted")
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.
integer
If supplied, only deals matching the given user will be returned
integer
If supplied, only deals within the given stage will be returned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_FILESReturns data about all files.

Input Parameters

string
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.
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_FILTER_HELPERSRetrieves filter helper information, including operators, relative dates and address field components.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_FILTERSReturns data about all filters.

Input Parameters

string ("deals" | "leads" | "org" | "people" | "products" | "activity" | "projects")
The types of filters to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_LEAD_LABELSReturns details of all lead labels. This endpoint does not support pagination and all labels are always returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_LEADSLists non-archived leads with pagination, optional filters and sorting. The archived-status parameter is ignored by Pipedrive.

Input Parameters

string
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).
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
integer
For pagination, the position that represents the first result for the page
integer
If supplied, only leads matching the given user will be returned. However, filter_id takes precedence over owner_id when supplied.
integer
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.
integer
If supplied, only leads matching the given person will be returned. However, filter_id takes precedence over person_id when supplied.
string ("archived" | "not_archived" | "all")
Filtering based on the archived status of a lead. If not provided, All is used.
integer
If supplied, only leads matching the given organization will be returned. However, filter_id takes precedence over organization_id when supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_NOTE_FIELDSReturns data about all note fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_NOTESReturns all notes.

Input Parameters

string
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.
integer
Items shown per page
integer
Pagination start
integer
The ID of the organization which notes to fetch. If omitted, notes about all organizations will be returned.
integer
The ID of the deal which notes to fetch. If omitted, notes about all deals will be returned.
string
The ID of the lead which notes to fetch. If omitted, notes about all leads will be returned.
integer
The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.
string
The date in format of YYYY-MM-DD until which notes to fetch to
integer
The ID of the person whose notes to fetch. If omitted, notes about all persons will be returned.
string
The date in format of YYYY-MM-DD from which notes to fetch
integer
If set, the results are filtered by note to deal pinning state
integer
If set, the results are filtered by note to lead pinning state
integer
If set, the results are filtered by note to person pinning state
integer
If set, the results are filtered by note to organization pinning state

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_ORGANIZATION_FIELDSReturns data about all organization fields.

Input Parameters

integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_ORGANIZATIONSReturns all organizations.

Input Parameters

string
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).
integer
Items shown per page
integer
Pagination start
integer
If supplied, only organizations owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.
integer
The ID of the filter to use
string
If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
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.
string
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.
string
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.
string
For pagination, the marker (an opaque string value) representing the first item on the next page
integer
If supplied, only organizations owned by the given user will be returned
string
If supplied, only organizations whose name starts with the specified letter will be returned (case-insensitive)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_PERMISSION_SETSReturns data about all permission sets.

Input Parameters

string ("sales" | "projects" | "campaigns" | "global" | "account_settings")
The app to filter the permission sets by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_PERSON_FIELDSReturns data about all person fields.
If a company uses the Campaigns product, then this endpoint will also return the data.marketing_status field.

Input Parameters

integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_PERSONSReturns all persons.

Input Parameters

string
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).
integer
Items shown per page
integer
Pagination start
integer
If supplied, only persons owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.
integer
The ID of the filter to use
string
If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
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.
string
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.
string
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.
string
For pagination, the marker (an opaque string value) representing the first item on the next page
integer
If supplied, only persons owned by the given user will be returned
string
If supplied, only persons whose name starts with the specified letter will be returned (case-insensitive)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_PRODUCT_FIELDSReturns data about all product fields.

Input Parameters

integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_PRODUCTSReturns data about all products.

Input Parameters

array
An array of integers with the IDs of the products that should be returned in the response
integer
Items shown per page
integer
Pagination start
integer
If supplied, only products owned by the given user will be returned
integer
The ID of the filter to use
string
If supplied, only products whose name starts with the specified letter will be returned (case-insensitive)
boolean
If supplied, the response will return the total numbers of products in the additional_data.summary.total_count property

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
string
For pagination, the marker (an opaque string value) representing the first item on the next page
string
If supplied, includes only projects with the specified statuses. Possible values are open, completed, canceled and deleted. By default deleted projects are not returned.
integer
If supplied, only projects in specified phase are returned
integer
The ID of the filter to use
boolean
If supplied with true then archived projects are also included in the response. By default only not archived projects are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_PROJECT_TEMPLATESRetrieves non-deleted project templates with cursor-based pagination; the Projects add-on must be enabled. HTTP errors produce an unsuccessful response with an empty template list.

Input Parameters

integer
For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned.
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_RELATIONSHIPS_FOR_ORGANIZATIONGets all of the relationships for a supplied organization ID.

Input Parameters

integer
required
The ID of the organization to get relationships for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_ROLESReturns roles within the company. The action requires the admin scope and supports pagination.

Input Parameters

integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_STAGESReturns data about all stages.

Input Parameters

integer
Items shown per page
integer
Pagination start
integer
The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional search term that is searched for from currency”s name and/or code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Whether the task is done or not. 0 = Not done, 1 = Done. If not omitted then returns both done and not done tasks.
integer
For pagination, the limit of entries to be returned. If not provided, up to 500 items will be returned.
string
For pagination, the marker (an opaque string value) representing the first item on the next page
integer
If supplied, only tasks that are assigned to this project are returned
integer
If supplied, only tasks that are assigned to this user are returned
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_TEAMSReturns data about teams within the company.

Input Parameters

string ("id" | "name" | "manager_id" | "active_flag")
The field name to sort returned teams by
integer
When enabled, the teams will not include IDs of member users

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_TEAMS_OF_A_USERReturns data about all teams which have the specified user as a member.

Input Parameters

integer
required
The ID of the user
string ("id" | "name" | "manager_id" | "active_flag")
The field name to sort returned teams by
integer
When enabled, the teams will not include IDs of member users

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_USER_CONNECTIONSReturns data about all connections for the authorized user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_USERSReturns data about all users within the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_USERS_IN_A_TEAMReturns a list of all user IDs within a team.

Input Parameters

integer
required
The ID of the team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ALL_WEBHOOKSReturns data about all the Webhooks of a company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ARCHIVED_DEALSRetrieves a page of archived deals with filtering and pagination using the API v1 archived-deals endpoint. Pipedrive described this v1 endpoint as temporary support through the end of 2025.

Input Parameters

string
Optional comma separated string array of up to 100 entity ids to fetch
integer
For pagination, the limit of entries to be returned. A maximum value of 500 is allowed (default: 100)
string
Pagination marker for the next page of results
integer
Filters to deals linked to the specified organization
string ("open" | "won" | "lost" | "deleted")
Deal status filter
string ("id" | "update_time" | "add_time")
Supported sort fields for archived deals
integer
Filters to deals owned by the specified user
integer
Filters to deals in the specified stage
integer
When supplied, returns only deals matching the specified filter
integer
Filters to deals linked to the specified person
integer
Filters to deals in the specified pipeline
string
Optional comma separated string array of custom fields keys to include. A maximum of 15 keys is allowed
string
RFC3339 format; returns deals with update_time >= this value
string
RFC3339 format; returns deals with update_time < this value
string
Additional optional fields (next_activity_id, last_activity_id, first_won_time, products_count, etc.)
string ("asc" | "desc")
Sort direction for archived deals

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("id" | "title" | "owner_id" | "creator_id" | "was_seen" | "expected_close_date" | "next_activity_id" | "add_time" | "update_time")
Supported sort fields for archived leads
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned.
integer
For pagination, the position that represents the first result for the page
integer
If supplied, only leads matching the given user will be returned. However, filter_id takes precedence over owner_id when supplied.
integer
The ID of the filter to use
integer
If supplied, only leads matching the given person will be returned. However, filter_id takes precedence over person_id when supplied.
integer
If supplied, only leads matching the given organization will be returned. However, filter_id takes precedence over organization_id when supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the call log to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_COMMENTReturns the details of a comment on a note.

Input Parameters

integer
required
The ID of the note
string
required
The ID of the comment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_COMPANY_ADD_ONSReturns the add-ons for a single company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_CONVERSATIONSTool to retrieve messaging conversations. Use after channel registration to sync conversations.

Input Parameters

string
Cursor for fetching the next page of conversations
string
required
Unique ID of the messaging channel
integer
Maximum number of messages per conversation
integer
Maximum number of conversations to return

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEALRetrieves a Pipedrive deal by ID, with options to request additional fields and up to 15 custom field keys. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use GET /api/v2/deals/{id} instead.

Input Parameters

integer
required
The ID of the deal to retrieve
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
integer
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both done and not done activities.
integer
Number of items displayed per page
integer
Pagination starting point
string
Comma-separated activity IDs to exclude from results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEAL_CHANGELOGLists a page of field-value changes for a specific deal, with cursor pagination.

Input Parameters

integer
required
The ID of the deal
integer
Number of items to display per page. Controls the size of each paginated response.
string
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEAL_FILESLists a page of files attached to a specific Pipedrive deal, with pagination and sorting.

Input Parameters

integer
required
The ID of the deal
string
Supported fields for sorting: id, update_time. Example: ‘id ASC’ or ‘update_time DESC’.
integer
Items shown per page. Maximum value of 100 is allowed.
integer
Pagination start. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEAL_FOLLOWERSLists a page of users following a specific deal, with cursor pagination.

Input Parameters

integer
required
The ID of the deal
integer
For pagination, the limit of entries to be returned. Maximum value of 500 is allowed.
string
For pagination, the marker (an opaque string value) representing the first item on the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
integer
Number of items returned per page. Maximum value is 500.
string
Pagination marker (opaque string) pointing to the first item on the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal to retrieve mail messages for
integer
Number of items shown per page. If not provided, API default will be used.
integer
Pagination start position. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEAL_PARTICIPANTSLists a page of persons participating in a specific Pipedrive deal, with pagination.

Input Parameters

integer
required
The ID of the deal
integer
Items shown per page. Maximum value of 500 is allowed. Default is 100.
integer
Pagination start. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEAL_PARTICIPANTS_CHANGELOGLists a page of participant changes for a specific deal, with cursor pagination.

Input Parameters

integer
required
The ID of the deal
integer
Number of items to display per page. Maximum value is 500.
string
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEAL_PRODUCTSLists a page of products attached to a specified Pipedrive deal, with pagination and sorting options. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use GET /api/v2/deals/{id}/products instead.

Input Parameters

integer
required
The ID of the deal
integer
For pagination, the limit of entries to be returned. Maximum value of 500 is allowed. Default is 100.
string
For pagination, the marker (opaque string value) representing the first item on the next page
string
The field to sort by. Supported values: id, add_time, update_time, order_nr. Default is ‘id’.
string
The sorting direction. Supported values: asc, desc. Default is ‘asc’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEALS_CONVERSION_RATES_IN_PIPELINEReturns all stage-to-stage conversion and pipeline-to-close rates for the given time period.

Input Parameters

integer
required
The ID of the pipeline
integer
The ID of the user who”s pipeline metrics statistics to fetch. If omitted, the authorized user will be used.
string
required
The end of the period. Date in format of YYYY-MM-DD.
string
required
The start of the period. Date in format of YYYY-MM-DD.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the deal
string
required
The ID of the conversion job. The ID has UUID format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEALS_IN_A_PIPELINELists deals in a specific pipeline across its stages, with optional filters and pagination. Archived deals are excluded by default.

Input Parameters

integer
required
The ID of the pipeline
integer
Items shown per page
integer
Pagination start
integer
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.
integer
If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned
integer
If supplied, only deals within the given stage will be returned
integer
If supplied, only deals matching the given filter will be returned
integer
Whether to include a summary of the pipeline in the additional_data or not
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEALS_IN_A_STAGELists deals in a specific stage, with optional filters and pagination. Archived deals are excluded by default.

Input Parameters

integer
required
The ID of the stage
integer
Items shown per page
integer
Pagination start
integer
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.
integer
If supplied, filter_id and user_id will not be considered – instead, deals owned by everyone will be returned
integer
If supplied, only deals matching the given filter will be returned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of entries per request (default: 100, max: 500)
string
Pagination marker to retrieve the next page of results
string
Field to sort by - supports ‘id’, ‘deal_id’, ‘add_time’, ‘update_time’, or ‘order_nr’ (default: ‘id’)
array
required
IDs of the deals for which attached products will be returned. Maximum 100 deal IDs allowed.
string
Sort order - ‘asc’ or ‘desc’ (default: ‘asc’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEALS_SUMMARYRequests a summary of deals, optionally filtered by status, user, filter or stage. Archived deals are excluded by default.

Input Parameters

string ("open" | "won" | "lost")
Only fetch deals with a specific status. open = Open, won = Won, lost = Lost.
integer
Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.
integer
Only deals within the given stage will be returned
integer
<code>user_id</code> will not be considered. Only deals matching the given filter will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("open" | "won" | "lost")
Deal status filter options
integer
Only deals matching the given user will be returned. user_id will not be considered if you use filter_id.
integer
Only deals within the given stage will be returned
integer
user_id will not be considered. Only deals matching the given filter will be returned.
integer
Only deals within the given pipeline will be returned

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEALS_TIMELINEReturns opened and won deals in time-based groups according to a specified deal date field. Archived deals are excluded by default.

Input Parameters

integer
required
The number of given intervals, starting from start_date, to fetch. E.g. 3 (months).
integer
If supplied, only deals matching the given user will be returned
string ("day" | "week" | "month" | "quarter")
required
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>
string
required
The date field key which deals will be retrieved from
integer
If supplied, only deals matching the given filter will be returned
string
required
The date when the first interval starts. Format: YYYY-MM-DD.
integer
If supplied, only deals matching the given pipeline will be returned
integer
Whether to exclude deals list (1) or not (0). Note that when deals are excluded, the timeline summary (counts and values) is still returned.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEAL_SUBSCRIPTIONFinds an installment or recurring subscription by deal ID. The result may instead contain the deal’s installments or attached products; products are not subscription details.

Input Parameters

integer
required
The ID of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DEALS_WITH_PRODUCTLists deals with a specified product attached, with status filtering and pagination. Archived deals are excluded by default.

Input Parameters

integer
required
The ID of the product
integer
Items shown per page
integer
Pagination start
string ("open" | "won" | "lost" | "deleted" | "all_not_deleted")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the deal
string
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
integer
Number of items to show per page for pagination
integer
Pagination starting point for retrieving results
string
Set to “1” to display custom field updates in the response; omit to exclude custom field changes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DETAILS_OF_AN_ORGANIZATIONRetrieves detailed information about an organization by ID.

Input Parameters

integer
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_DETAILS_OF_A_PERSONRetrieves details of a person by ID. This tool is deprecated.

Input Parameters

integer
required
The ID of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_FILEReturns data about a specific file.

Input Parameters

integer
required
The ID of the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_FILTERReturns data about a specific filter. Note that this also returns the condition lines of the filter.

Input Parameters

integer
required
The ID of the filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_GOAL_RESULTGets the progress of a goal for the specified period.

Input Parameters

string
required
The ID of the goal that the results are looked for
string
required
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The identifier for a specific lead (UUID format)
string
required
The identifier for the conversion job (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Number of items shown per page
integer
Pagination start position

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the lead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_MAIL_MESSAGEReturns data about a specific mail message.

Input Parameters

integer
required
The ID of the mail message to fetch
integer
Whether to include the full message body or not. 0 = Don”t include, 1 = Include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_MAIL_THREADReturns a specific mail thread.

Input Parameters

integer
required
The ID of the mail thread

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_MAIL_THREAD_MESSAGESReturns all the mail messages inside a specified mail thread.

Input Parameters

integer
required
The ID of the mail thread

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_MAIL_THREADSReturns mail threads in a specified folder ordered by the most recent message within.

Input Parameters

integer
Items shown per page
integer
Pagination start
string ("inbox" | "drafts" | "sent" | "archive")
required
The type of folder to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_MARKETPLACE_CLIENT_IDReturn a supplied marketplace client ID hint, or select an add-on code using an optional provider-name match. If no code is found, return a connection or consumer identifier or a test placeholder; the result is not necessarily an installed video integration’s client ID.

Input Parameters

string
Optional provider name to filter add-ons by code containing this string.
string
Hint for the marketplace client ID. If provided, returned immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_NOTEReturns details about a specific note.

Input Parameters

integer
required
The ID of the note

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_NOTE_COMMENTSLists comments associated with a note, with pagination.

Input Parameters

integer
required
The ID of the note
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ONE_LEADReturns details about a specific lead by ID.

Input Parameters

string
required
The ID of the lead

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization to retrieve
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
Number of items to display per page. Controls the size of each paginated response. Maximum value is 500.
string
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ORGANIZATION_DEALSLists deals associated with an organization, with optional filtering and pagination. Archived deals are not returned.

Input Parameters

integer
required
The ID of the organization
string
Field names and sorting mode separated by comma (e.g., ‘add_time ASC’). Only first-level field keys are supported (no nested keys).
integer
Items shown per page
integer
Pagination start. Default: 0
string ("open" | "won" | "lost" | "deleted" | "all_not_deleted")
Filter by deal status. Values: open, won, lost, deleted, all_not_deleted. If omitted, all not deleted deals are returned.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization field to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
string
Supported fields for sorting: id, update_time. Example: ‘id ASC’ or ‘update_time DESC’.
integer
Items shown per page. Maximum value of 100 is allowed.
integer
Pagination start. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
Number of items displayed per page (default: 100, max: 500)
integer
Pagination start point. Default: 0

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
Number of items shown per page. Defines how many records to return in one request.
integer
Pagination start position. Indicates from which record number to start returning results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ORGANIZATION_RELATIONSHIPFinds and returns an organization relationship from its ID.

Input Parameters

integer
required
The ID of the organization relationship
integer
The ID of the base organization for the returned calculated values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
string
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
integer
Items shown per page. Maximum value of 500 is allowed. If not provided, 100 items will be returned.
integer
Pagination start point. Use to skip initial items and start from a specific position in the results.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PERMISSION_SETReturns data about a specific permission set.

Input Parameters

string
required
The ID of the permission set

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the permission set
integer
Items shown per page
integer
Pagination start (default: 0)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person to retrieve
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
integer
Number of items to display per page. Controls the size of each paginated response.
string
Pagination cursor for the first item on the next page. Use the cursor returned in the response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PERSON_DEALSLists deals associated with a person, excluding archived deals by default. The API v1 endpoint used is out of support and may be changed or removed without notice.

Input Parameters

integer
required
The ID of the person
string
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.
integer
Number of items shown per page
integer
Pagination start position
string
Filter deals by status. Allowed values: ‘open’, ‘won’, ‘lost’, ‘deleted’, ‘all_not_deleted’. Default is ‘all_not_deleted’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
string
Field to sort by. Supported fields: id, update_time.
integer
Items shown per page. Maximum value of 100 is allowed.
integer
Pagination start. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value allowed is 500.
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
integer
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.
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
integer
Number of items shown per page. If not specified, all items are returned.
integer
Pagination start position. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person whose picture to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
integer
Items shown per page. If not provided, the default limit from API settings will be used.
integer
Pagination start position

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person whose updates should be retrieved
string
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
integer
Items shown per page for pagination
integer
Pagination start position. Default is 0.
string
Set to “1” to include custom field updates in the response. If omitted, returns changes without custom field updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PIPELINEReturns data about a specific pipeline.

Input Parameters

integer
required
The ID of the pipeline
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the pipeline
integer
The ID of the user who’s pipeline metrics statistics to fetch. If omitted, the authorized user will be used
string
required
The end of the period. Date in format of YYYY-MM-DD
string
required
The start of the period. Date in format of YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The pipeline’s identifier
integer
Specifies which team member’s statistics to retrieve; if absent, the authorized user’s data is used
string
required
Period end date in YYYY-MM-DD format
string
required
Period beginning date in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PRODUCTReturns data about a specific product.

Input Parameters

integer
required
The ID of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PRODUCT_DEALSLists deals associated with a product, excluding archived deals by default. Supports pagination and filtering by deal status.

Input Parameters

integer
required
The ID of the product
integer
Items shown per page. Maximum value allowed is 500.
integer
Pagination start. Default is 0.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PRODUCT_FIELDReturns data about a specific product field.

Input Parameters

integer
required
The ID of the product field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product
string
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.
integer
Number of items per page. Maximum value of 100 is allowed.
integer
Pagination start offset. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value: 500
integer
Pagination start offset for entries. Default is 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product to get permitted users for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PRODUCT_VARIATIONSRetrieve a page of variations for a specific product, including available prices across currencies. Use the returned cursor to request subsequent pages.

Input Parameters

integer
required
The ID of the product
integer
For pagination, the maximum entries returned. Default is 100; maximum allowed is 500
string
For pagination, an opaque marker representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PROJECTRetrieves a project by ID; custom field hashes in the returned project data can be matched to project field keys. API errors may be returned in the response data.

Input Parameters

integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PROJECT_ACTIVITIESReturns activities linked to a specific project.

Input Parameters

integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PROJECT_BOARDReturns the details of a specific project board.

Input Parameters

integer
required
The ID of the project board

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PROJECT_GROUPSReturns all active groups under a specific project.

Input Parameters

integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PROJECT_PHASERetrieves a project phase by ID. API error payloads can also be returned in the response data.

Input Parameters

integer
required
The ID of the project phase

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PROJECT_PHASESReturns all active project phases under a specific board.

Input Parameters

integer
required
ID of the board for which phases are requested

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_PROJECT_TASKSReturns tasks linked to a specific project.

Input Parameters

integer
required
The ID of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_RECENTSReturns data about all recent changes occurred after the given timestamp.

Input Parameters

string ("activity" | "activityType" | "deal" | "file" | "filter" | "note" | "person" | "organization" | "pipeline" | "product" | "stage" | "user")
Multiple selection of item types to include in the query (optional)
integer
Items shown per page
integer
Pagination start
string
required
The timestamp in UTC. Format: YYYY-MM-DD HH:MM:SS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_ROLE_ASSIGNMENTSList a page of user assignments for a specific role in Pipedrive, with pagination support.

Input Parameters

integer
required
The ID of the role
integer
Number of items shown per page
integer
Pagination start position

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role
boolean
Determines whether to retrieve visible or hidden pipelines. Defaults to true (visible pipelines).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_STAGEReturns data about a specific stage.

Input Parameters

integer
required
The ID of the stage
integer
If everyone=1 is provided, deals summary will return deals owned by every user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_SUBSCRIPTIONRetrieves an installment or recurring subscription by ID. The result may instead contain installments or products for a deal with the same ID.

Input Parameters

integer
required
The ID of the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_SUBSCRIPTION_PAYMENTSRetrieves payments for an installment or recurring subscription by subscription ID. An empty result does not necessarily mean the subscription has no payments.

Input Parameters

integer
required
The ID of the subscription

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_TASKReturns the details of a specific task.

Input Parameters

integer
required
The ID of the task

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_TEAMReturns data about a specific team.

Input Parameters

integer
required
The ID of the team
integer
When enabled, the teams will not include IDs of member users

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_TEMPLATERetrieves a project template by ID. API errors may be returned in the response data.

Input Parameters

integer
required
The ID of the project template

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_TEMPLATESTool to retrieve message templates for a channel. Use when template support is enabled.

Input Parameters

string
required
Unique ID of the messaging channel (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_USERReturns data about a specific user within the company.

Input Parameters

integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_USER_CALL_LOGSReturns all call logs assigned to a particular user.

Input Parameters

integer
For pagination, the limit of entries to be returned. The upper limit is 50.
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_USER_FOLLOWERSList a page of users following a specific Pipedrive user. Use the returned cursor to request subsequent pages.

Input Parameters

integer
required
The ID of the user
integer
For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Maximum value of 500 is allowed.
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The identifier of the user whose permissions to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_GET_USER_ROLE_ASSIGNMENTSList a page of role assignments for a specific Pipedrive user, with pagination support.

Input Parameters

integer
required
The ID of the user
integer
Items shown per page
integer
Pagination start position

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ACTIVITIESList activities, or select up to 100 IDs, with relationship and completion filters and cursor pagination.

Input Parameters

array
Activity IDs to return, with at most 100 IDs per request.
boolean
Whether to return completed or incomplete activities.
integer
Maximum number of activities to return.
string
Opaque cursor identifying the next page to return.
integer
The ID of the organization linked to the activities.
integer
The ID of the deal linked to the activities.
string
The UUID of the lead linked to the activities.
string ("id" | "update_time" | "add_time" | "due_date")
Field used to sort the activities.
integer
The ID of the user who owns the activities.
integer
The ID of the filter to apply.
integer
The ID of the person linked to the activities.
string
Return activities updated at or after this ISO 8601 timestamp.
string
Return activities updated before this ISO 8601 timestamp.
array
Additional activity fields to include in the response.
string ("asc" | "desc")
Direction used to sort the activities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEAL_ACTIVITIESLists activities associated with a deal.

Input Parameters

integer
required
The ID of the deal
integer
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
integer
Items shown per page
integer
Pagination start
string
A comma-separated string of activity IDs to exclude from result

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEAL_FILESLists files associated with a deal.

Input Parameters

integer
required
The ID of the deal
string
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.
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEAL_FOLLOWERSLists the followers of a deal.

Input Parameters

integer
required
The ID of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEAL_MAIL_MESSAGESLists mail messages associated with a deal.

Input Parameters

integer
required
The ID of the deal
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEAL_PRODUCTSLists products attached to a Pipedrive deal, with pagination and an option to include product data. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use GET /api/v2/deals/{id}/products instead.

Input Parameters

integer
required
The ID of the deal
integer
Items shown per page
integer
Pagination start
integer
Whether to fetch product data along with each attached product (1) or not (0, default)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEALSList non-archived deals with relationship and status filters, selected custom fields, and cursor pagination.

Input Parameters

array
Deal IDs to return, with at most 100 IDs per request.
integer
Maximum number of deals to return (1-500).
string
Opaque cursor returned by the previous page.
integer
Return deals linked to this organization ID.
array
Deal statuses to return: open, won, lost, or deleted.
string ("id" | "update_time" | "add_time")
Field used to sort deals.
integer
Return deals owned by this user ID.
integer
Return deals in this stage ID.
integer
ID of the filter to apply.
integer
Return deals linked to this person ID.
integer
Return deals in this pipeline ID.
array
Custom field keys to include, with at most 15 keys per request.
string
Return deals updated at or after this RFC 3339 timestamp.
string
Return deals updated before this RFC 3339 timestamp.
array
Additional deal fields to include in each result.
boolean
Whether to include deal label details.
string ("asc" | "desc")
Direction used to sort deals.
boolean
Whether to include labels for custom-field options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEAL_UPDATESLists updates about a deal.

Input Parameters

integer
required
The ID of the deal
string
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).
integer
Items shown per page
integer
Pagination start
string
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_DEAL_USERSLists the users permitted to access a deal.

Input Parameters

integer
required
The ID of the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_FILESLists a page of files across Pipedrive, regardless of the entity they are attached to, with pagination and sorting options.

Input Parameters

string
Field names and sorting mode separated by a comma. Supported fields: id, update_time. Example: ‘id ASC’ or ‘update_time DESC’.
integer
Number of items shown per page. Maximum value of 100 is allowed.
integer
Pagination start position. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ORGANIZATION_ACTIVITIESLists activities associated with an organization.

Input Parameters

integer
required
The ID of the organization
integer
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted returns both Done and Not done activities.
integer
Items shown per page
integer
Pagination start
string
A comma-separated string of activity IDs to exclude from result

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ORGANIZATION_DEALSLists non-archived deals associated with an organization, with status filtering and pagination.

Input Parameters

integer
required
The ID of the organization
string
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).
integer
Items shown per page
integer
Pagination start
string ("open" | "won" | "lost" | "deleted" | "all_not_deleted")
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.
integer
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ORGANIZATION_FILESLists files associated with an organization.

Input Parameters

integer
required
The ID of the organization
string
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.
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ORGANIZATION_FOLLOWERSLists the followers of an organization.

Input Parameters

integer
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ORGANIZATION_MAIL_MESSAGESLists mail messages associated with an organization.

Input Parameters

integer
required
The ID of the organization
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ORGANIZATION_PERSONSLists persons associated with an organization.
If a company uses the Campaigns product, then this endpoint will also return the data.marketing_status field.

Input Parameters

integer
required
The ID of the organization
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PARTICIPANTS_OF_A_DEALLists the participants associated with a deal.
If a company uses the Campaigns product, then this endpoint will also return the data.marketing_status field.

Input Parameters

integer
required
The ID of the deal
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the permission set
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSON_ACTIVITIESLists activities associated with a person.

Input Parameters

integer
required
The ID of the person
integer
Whether the activity is done or not. 0 = Not done, 1 = Done. If omitted, returns both Done and Not done activities.
integer
Items shown per page
integer
Pagination start
string
A comma-separated string of activity IDs to exclude from result

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSON_DEALSLists non-archived deals associated with a person, with status filtering and pagination.

Input Parameters

integer
required
The ID of the person
string
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).
integer
Items shown per page
integer
Pagination start
string ("open" | "won" | "lost" | "deleted" | "all_not_deleted")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSON_FILESLists files associated with a person.

Input Parameters

integer
required
The ID of the person
string
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.
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSON_FOLLOWERSLists the followers of a person.

Input Parameters

integer
required
The ID of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSON_MAIL_MESSAGESLists mail messages associated with a person.

Input Parameters

integer
required
The ID of the person
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSON_PRODUCTSLists products associated with a person.

Input Parameters

integer
required
The ID of the person
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSONSList persons, or select up to 100 IDs, with relationship filters, selected custom fields, and cursor pagination.

Input Parameters

array
IDs of up to 100 persons to return.
integer
Maximum number of persons to return (1-500).
string
Cursor returned by the previous page.
integer
Return persons linked to this organization ID.
integer
Return persons linked to this deal ID.
string ("id" | "update_time" | "add_time")
Field used to sort the persons.
integer
Return persons owned by this user ID.
integer
ID of the filter to use.
array
Keys of up to 15 custom fields to include.
string
Return persons updated after this RFC 3339 timestamp.
string
Return persons updated before this RFC 3339 timestamp.
array
Additional person fields to include. Marketing status fields require the Campaigns product.
boolean
Whether to include person label details.
string ("asc" | "desc")
Direction used to sort the persons.
boolean
Whether to include human-readable custom field option labels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PERSON_USERSList users permitted to access a person.

Input Parameters

integer
required
The ID of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PRODUCT_FILESLists files associated with a product.

Input Parameters

integer
required
The ID of the product
string
The field name and sorting mode (field_name_1 ASC or field_name_1 DESC). Supported fields: update_time, id.
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PRODUCT_FOLLOWERSLists the followers of a product.

Input Parameters

integer
required
The ID of the product
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_PRODUCT_USERSLists users permitted to access a product.

Input Parameters

integer
required
The ID of the product

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_ROLE_ASSIGNMENTSLists users assigned to a role, with pagination. The action declares the admin OAuth scope.

Input Parameters

integer
required
The ID of the role
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role
boolean
Whether to return the visible or hidden pipelines for the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_UPDATES_ABOUT_AN_ORGANIZATIONLists updates about an organization.

Input Parameters

integer
required
The ID of the organization
string
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).
integer
Items shown per page
integer
Pagination start
string
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted, returns changes without custom field updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_UPDATES_ABOUT_A_PERSONLists updates about a person.
If a company uses the Campaigns product, then this endpoint’s response will also include updates for the marketing_status field.

Input Parameters

integer
required
The ID of the person
string
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).
integer
Items shown per page
integer
Pagination start
string
Whether to show custom field updates or not. 1 = Include custom field changes. If omitted returns changes without custom field updates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
integer
Items shown per page
string
For pagination, the marker (an opaque string value) representing the first item on the next page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_USER_FOLLOWERSLists the followers of a specific user.

Input Parameters

integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_USER_PERMISSIONSLists aggregated permissions over all assigned permission sets for a user.

Input Parameters

integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_USER_ROLE_ASSIGNMENTSLists role assignments for a user.

Input Parameters

integer
required
The ID of the user
integer
Items shown per page
integer
Pagination start

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_USER_ROLE_SETTINGSLists the settings of user’s assigned role.

Input Parameters

integer
required
The ID of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_LIST_USER_SETTINGSLists the settings of an authorized user. Example response contains a shortened list of settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal that will be merged and removed from the account
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization that will be merged and removed from the account
integer
required
The ID of the organization that will remain in the account and receive the merged data. This organization takes priority in conflict scenarios.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person that will be merged and removed from Pipedrive
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
integer
required
The ID of the deal that the deal will be merged with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization
integer
required
The ID of the organization that the organization will be merged with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_ORGANIZATION_ACCESSIBLE_USER_LISTList users permitted to access an organization.

Input Parameters

integer
required
The ID of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique code identifying the field (40-character identifier for custom fields)
string
The name displayed for the field. At least one body parameter must be provided.
string
Text describing the field’s purpose
object
Settings controlling where the field appears in the web UI
object
Settings for marking as mandatory at certain stages
object
Configuration for highlighting at specific stages

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique code identifying the organization field to update
string
The new label/name for the organization field
string
Description text for the field (nullable)
object
Configuration for UI visibility settings
object
Configuration for making field required
object
Configuration for marking field as important

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique code identifying the field (40-character hash for custom fields)
string
Field display name (1-255 characters). At least one request body parameter must be provided
string
Field description text
object
Controls field appearance in Pipedrive interface
object
Marks field as mandatory
object
Configuration for highlighting field at specific deal stages

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique code identifying the field to update (40-character hash)
string
Field name (1-255 characters). At least one of field_name, ui_visibility, or description must be provided.
string
Field description. Can be null to remove the description.
object
UI visibility settings for the product field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
The client ID provided to you by the Pipedrive Marketplace when you register your app
string ("authorization_code" | "refresh_token")
Since you are to refresh your access_token, you must use the value “refresh_token”
string
The client secret provided to you by the Pipedrive Marketplace when you register your app
string
The refresh token that you received after you exchanged the authorization code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_REQUEST_AUTHORIZATIONRequests the Pipedrive OAuth authorization page for an app and returns the response status, any redirect location, and a short body snippet. A user must complete authorization separately.

Input Parameters

string
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.
string
required
The client ID provided to you by the Pipedrive Marketplace when you register your app
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
integer
Items shown per page. Maximum value is 100.
integer
Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
string ("custom_fields" | "notes" | "title")
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>.
string ("open" | "won" | "lost")
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.
integer
Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
boolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
string ("deal.cc_email")
Supports including optional fields in the results which are not provided by default
integer
Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
integer
Items shown per page
integer
Pagination start
string
required
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>.
string ("dealField" | "leadField" | "personField" | "organizationField" | "productField" | "projectField")
required
The type of the field to perform the search from
boolean
When enabled, only full exact matches against the given term are returned. The search <b>is</b> case sensitive.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
integer
Items shown per page
integer
Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
string ("custom_fields" | "notes" | "title")
A comma-separated string array. The fields to perform the search from. Defaults to all of them.
integer
Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
boolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
string ("lead.was_seen")
Supports including optional fields in the results which are not provided by default
integer
Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_SEARCH_MULTIPLE_ITEM_TYPESSearches across item types and fields, with optional selection of one item type and one field.

Input Parameters

string
required
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.
integer
Items shown per page
integer
Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
string ("address" | "code" | "custom_fields" | "email" | "name" | "notes" | "organization_name" | "person_name" | "phone" | "title" | "description")
A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:
<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>
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 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.
string ("deal" | "person" | "organization" | "product" | "lead" | "file" | "mail_attachment" | "project")
A comma-separated string array. The type of items to perform the search from. Defaults to all.
boolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
string ("deal.cc_email" | "person.picture" | "product.price")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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”&gt;/v1/itemSearch&lt;/a> with a narrower OAuth scope.

Input Parameters

string
required
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.
integer
Items shown per page
integer
Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
string ("address" | "custom_fields" | "notes" | "name")
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>.
boolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
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.
integer
Items shown per page
integer
Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
string ("custom_fields" | "email" | "notes" | "phone" | "name")
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.
boolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
string ("person.picture")
Supports including optional fields in the results which are not provided by default
integer
Will filter persons by the provided organization ID. The upper limit of found persons associated with the organization is 2000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_SEARCH_PRODUCTSSearches Pipedrive products by name, code or custom fields, with optional case-insensitive exact matching and pagination. DEPRECATED: The API v1 product search endpoint is out of support and its availability is not guaranteed; use GET /api/v2/products/search instead.

Input Parameters

string
required
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.
integer
Items shown per page
integer
Pagination start. Note that the pagination is based on main results and does not include related items when using search_for_related_items parameter.
string ("code" | "custom_fields" | "name")
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>.
boolean
When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
string ("product.price")
Supports including optional fields in the results which are not provided by default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the stage to update
string
The name of the stage
integer
The ID of the pipeline to add stage to
integer
Number of days before deals become rotten; applies only when is_deal_rot_enabled is enabled
integer
Success probability percentage for deals; utilized when deal weighted values are active. Must be between 0 and 100.
boolean
Whether deals in this stage can become rotten

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Unique identifier linking a user to the installed integration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the activity to update
boolean
Calendar availability flag (true=busy, false=available)
boolean
Completion status indicator (true=completed, false=not completed)
string
Internal activity comments/notes
string
The activity category/type (e.g., ‘call’, ‘meeting’, ‘task’)
integer
Associated organization identifier
integer
Associated deal identifier
string
Associated lead identifier (UUID format)
string
The activity’s title/subject
string
Activity date in YYYY-MM-DD format
string
Activity time in HH:MM format
string
Activity length in HH:MM format
string
Geographic information with address fields or simple string address
integer
User ID assigned to the activity
integer
Importance level of the activity
array
External and internal meeting participants with email, name, and status
integer
Primary participant identifier
integer
Associated project identifier
array
Multiple person associations for the activity
string
Calendar-synced event details visible in external calendars

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_ACTIVITY_IN_PROJECT_PLANUpdates an activity phase or group in a project.

Input Parameters

integer
required
The ID of the project
integer
The ID of a group on a project board
integer
The ID of a phase on a project board
integer
required
The ID of the activity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The identifier of the activity type to update
string
The designation of the activity type
string
Six-character hexadecimal color code (e.g., FFFFFF for white, 000000 for black)
string ("task" | "email" | "meeting" | "deadline" | "call" | "lunch" | "calendar" | "downarrow" | "document" | "smartphone" | "camera" | "scissors" | "cogs" | "bubble" | "uparrow" | "checkbox" | "signpost" | "shuffle" | "addressbook" | "linegraph" | "picture" | "car" | "world" | "search" | "clip" | "sound" | "brush" | "key" | "padlock" | "pricetag" | "suitcase" | "finish" | "plane" | "loop" | "wifi" | "truck" | "cart" | "bulb" | "bell" | "presentation")
Permitted icon values for activity types.
integer
An order number for this activity type. Order numbers should be used to order the types in the activity type selections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_DEALUpdates supported properties of a deal, such as its title, owner, stage, value, or status. Archived deals cannot be edited with this action. DEPRECATED: This API v1 endpoint is out of support and its availability and behavior are not guaranteed; use PATCH /api/v2/deals/{id} instead.

Input Parameters

integer
required
The ID of the deal
string
The deal title
number
Monetary value of the deal
integer
ID of the organization
string
Status of the deal (open, won, lost). Defaults to open
integer
ID of the user who will be marked as owner of this deal
string
Currency for the deal value (3-letter ISO code)
integer
Stage ID for the deal
integer
ID of the person this deal is linked to
integer
Visibility of the deal (owner, entire company etc)
string
Reason for losing the deal (only with status=lost)
integer
Pipeline ID for the deal
number
Success probability percentage (0-100)
string
Expected close date in format YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_DEAL_FIELDUpdates a deal field definition’s name, options, or visibility in the add-new dialog.

Input Parameters

integer
required
The ID of the field
string
The name of the field
array
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"}]
boolean
Whether the field is available in “add new” modal or not (both in web and mobile app)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the filter to update
string
The name assigned to the filter
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_LEADUpdates supported properties of a lead. Archived leads can only be unarchived; other edits require the lead to be unarchived first.

Input Parameters

string
required
The ID of the lead
string
The name of the lead
integer
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.
boolean
A flag indicating whether the lead was seen by someone in the Pipedrive UI
array
The IDs of the lead labels which will be associated with the lead
integer
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.
boolean
A flag indicating whether the lead is archived or not
integer
Amount
integer
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.
string
Currency
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_LEAD_LABELUpdates one or more properties of a lead label. Only properties included in the request will be updated.

Input Parameters

string
required
The ID of the lead label
string
The name of the lead label
string ("green" | "blue" | "red" | "yellow" | "purple" | "gray" | "brown" | "dark-gray" | "orange" | "pink")
The color of the label. Only a subset of colors can be used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_AN_ACTIVITYUpdates an activity by ID and returns the updated activity.

Input Parameters

integer
required
The ID of the activity
integer
Whether the activity is done (0 = not done, 1 = done)
string
The note of the activity (HTML supported)
string
The type of the activity (e.g., call, meeting), correlates with ActivityTypes key_string
integer
ID of the organization linked to the activity
integer
ID of the deal linked to the activity
string
The subject of the activity
integer
ID of the user who will own the activity
string
The due date of the activity (YYYY-MM-DD)
string
The due time of the activity (HH:MM)
string
The duration of the activity (e.g., 00:30)
string
Location of the activity
integer
ID of the person linked to the activity

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_AN_ACTIVITY_TYPEUpdates an activity type.

Input Parameters

integer
required
The ID of the activity type
string
The name of the activity type
string
A designated color for the activity type in 6-character HEX format (e.g. FFFFFF for white, 000000 for black)
string ("task" | "email" | "meeting" | "deadline" | "call" | "lunch" | "calendar" | "downarrow" | "document" | "smartphone" | "camera" | "scissors" | "cogs" | "bubble" | "uparrow" | "checkbox" | "signpost" | "shuffle" | "addressbook" | "linegraph" | "picture" | "car" | "world" | "search" | "clip" | "sound" | "brush" | "key" | "padlock" | "pricetag" | "suitcase" | "finish" | "plane" | "loop" | "wifi" | "truck" | "cart" | "bulb" | "bell" | "presentation")
Icon graphic to use for representing this activity type
integer
An order number for this activity type. Order numbers should be used to order the types in the activity type selections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_AN_ORGANIZATIONUpdates the properties of an organization.

Input Parameters

integer
required
The ID of the organization
string
Organization name
string
Formatted address string
string
Organization website URL
integer
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.
string
LinkedIn URL
integer
Owner user ID
array
IDs of labels to assign
integer
Visibility (e.g., 1=owner only, 3=entire company)
integer
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.
integer
Employee count

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the field
string
The name of the field
array
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"}]
boolean
Whether the field is available in “add new” modal or not (both in web and mobile app)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_AN_ORGANIZATION_RELATIONSHIPUpdates and returns an organization relationship.

Input Parameters

integer
required
The ID of the organization relationship
string ("parent" | "related")
The type of organization relationship
integer
The ID of the base organization for the returned calculated values
integer
The owner of this relationship. If type is parent, then the owner is the parent and the linked organization is the daughter.
integer
The linked organization in this relationship. If type is parent, then the linked organization is the daughter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_NOTEUpdates a note.

Input Parameters

integer
required
The ID of the note
integer
The ID of the organization the note will be attached to.
string
The content of the note in HTML format; subject to sanitization.
integer
The ID of the deal the note will be attached to.
string
The ID (UUID) of the lead the note will be attached to.
integer
The ID of the user to mark as the note’s author (admin only).
string
Optional creation date & time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
integer
The ID of the person the note will be attached to.
integer
The ID of the project the note will be attached to.
integer
If set, updates note-to-deal pinning state (requires deal_id). 0 or 1.
integer
If set, updates note-to-lead pinning state (requires lead_id). 0 or 1.
integer
If set, updates note-to-person pinning state (requires person_id). 0 or 1.
integer
If set, updates note-to-project pinning state (requires project_id). 0 or 1.
integer
If set, updates note-to-organization pinning state (requires org_id). 0 or 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person
string
The name of the person
array
List of email objects: { value: string, label?: string, primary?: bool }
array
List of phone objects: { value: string, label?: string, primary?: bool }
integer
ID of the linked organization
string
Creation time (RFC 3339)
integer
ID of the user who will be marked as the owner of this person
array
IDs of labels to assign to the person
integer
Visibility of the person (e.g., 1=owner only, 3=entire company)
string
Last update time (RFC 3339)
string
Marketing status (no_consent, unsubscribed, subscribed, archived). Field is available only when Campaigns is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_PERSON_FIELDUpdates a person field’s name, options, or availability in the add-new modal. Availability defaults to enabled if omitted.

Input Parameters

integer
required
The ID of the field
string
The name of the field
array
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"}]
boolean
Whether the field is available in “add new” modal or not (both in web and mobile app)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_PIPELINEUpdates the properties of a pipeline (v2).

Input Parameters

integer
required
The ID of the pipeline
string
The name of the pipeline
boolean
Whether deal probability is enabled for this pipeline

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_A_PRODUCTUpdates product data.

Input Parameters

integer
required
The ID of the product
number
Tax percentage
string
Product code
string
Product name
string
Sales unit of the product
array
Array of prices per currency
integer
Product category
integer
Owner user ID; if omitted, authorized user ID is used
integer
Product visibility setting
string
Product description
boolean
Whether the product can be added to a deal
string
Billing frequency (one-time, annually, semi-annually, quarterly, monthly, weekly)
integer
Number of billing repeats (rules depend on billing_frequency)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product field
string
The name of the field
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the note
string
required
The updated content of the comment in HTML format. Subject to sanitization on the back-end.
string
required
The ID of the comment in UUID format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_DEALUpdates an existing Pipedrive deal’s properties, such as title, value, status, stage, or associated contacts and organizations. Archived deals can only be unarchived. DEPRECATED: The API v1 endpoint is out of support and availability is not guaranteed; use PATCH /api/v2/deals/{id} instead.

Input Parameters

integer
required
The ID of the deal to update
string
The title/name of the deal
number
The monetary value of the deal
integer
The ID of the organization associated with the deal
string ("open" | "won" | "lost")
The status of the deal. Must be one of: open, won, lost
string
Three-letter ISO currency code for the deal value
integer
The ID of the user who owns the deal
integer
The ID of the stage within the pipeline
string
Date and time when status changed to won
array
Array of label IDs assigned to the deal
string
Date and time when status changed to lost
integer
The ID of the person/contact associated with the deal
string
Date and time of closing the deal (for won/lost status)
integer
Visibility setting for the deal
boolean
Whether the deal is archived. Note: From July 15, 2025, archived deals cannot be edited except for this property.
string
Reason for losing the deal. Required when status is set to ‘lost’
integer
The ID of the pipeline for the deal. When changed, stage_id auto-updates to first stage.
number
The success probability percentage (0-100)
string
Date and time of archiving in UTC in YYYY-MM-DD HH:MM:SS format
string
Expected closing date in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
string ("percentage" | "amount")
Determines whether the discount is applied as a percentage or a fixed amount.
number
The discount amount. Must be a positive number (excluding 0).
string
The name of the discount.
string
required
The ID of the discount to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal field to update
string
The name of the field
array
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”}]
boolean
Whether the field is available in “add new” modal or not (both in web and mobile app)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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).
string
required
The unique 40-character code identifying the deal field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the deal
number
The tax percentage or amount to apply
string
Comments or notes about this product attachment
number
The discount value. Use discount_type to specify whether this is a percentage or fixed amount
number
The quantity of the product in the deal
boolean
Whether the product is enabled in the deal. Disabled products are excluded from deal value calculations
number
The price at which this product will be updated in the deal
string ("exclusive" | "inclusive" | "none")
Tax calculation method: ‘exclusive’ (tax added to price), ‘inclusive’ (tax included in price), or ‘none’
string ("percentage" | "amount")
The type of discount: ‘percentage’ or ‘amount’
string ("one-time" | "annually" | "semi-annually" | "quarterly" | "monthly" | "weekly")
Billing frequency for recurring products
string
Billing start date in YYYY-MM-DD format
integer
required
The ID of the deal-product attachment (returned when adding a product to a deal)
integer
Number of billing cycles for recurring products

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_DEAL_PRODUCT_ATTACHMENTUpdates the details of the product that has been attached to a deal.

Input Parameters

integer
required
The ID of the deal
number
The tax percentage
string
A textual comment associated with this product-deal attachment
number
The value of the discount. The discount_type field can be used to specify whether the value is an amount or a percentage.
number
The duration of the product
number
How many items of this product will be added to the deal
number
The price at which this product will be added to the deal
integer
The ID of the product to use
string ("exclusive" | "inclusive" | "none")
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.
boolean
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.
string ("percentage" | "amount")
The type of the discount”s value.
integer
The ID of the product variation to use. When omitted, no variation will be used.
integer
required
The ID of the deal-product (the ID of the product attached to the deal)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_DEAL_V2Updates an existing deal using the Pipedrive v2 API, including custom fields, archive status, or deletion status. Archived deals cannot be edited except to unarchive them.

Input Parameters

integer
required
The ID of the deal to update
string
The title of the deal
number
The value of the deal
integer
The ID of the organization linked to the deal
string
The status of the deal
string
The currency associated with the deal
integer
The ID of the user who owns the deal
integer
The ID of the deal stage
string
The date and time of changing the deal status as won. Can only be set if deal status is won.
array
The IDs of labels assigned to the deal
string
The date and time of changing the deal status as lost. Can only be set if deal status is lost.
integer
The ID of the person linked to the deal
string
The date and time of closing the deal. Can only be set if deal status is won or lost.
boolean
Whether the deal is deleted or not
integer
The visibility of the deal
boolean
Whether the deal is archived or not
string
The reason for losing the deal. Can only be set if deal status is lost.
integer
The ID of the pipeline associated with the deal
integer
The success probability percentage of the deal (must be an integer)
string
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.
object
An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes
string
The expected close date of the deal in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_FILEUpdates the visible name and description of a Pipedrive file.

Input Parameters

integer
required
The ID of the file to update
string
The visible name of the file
string
The description of the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_FILE_DETAILSUpdates the visible name and description of a file.

Input Parameters

integer
required
The ID of the file
string
The visible name of the file
string
The description of the file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_FILTERUpdates the name of an existing filter.

Input Parameters

integer
required
The ID of the filter
string
The name of the filter

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the goal
object
The type of the goal and its parameters
string
The title of the goal
object
The assignee of the goal
object
Goal active duration
string ("weekly" | "monthly" | "quarterly" | "yearly")
The interval of the goal
object
Expected outcome configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_INSTALLMENT_SUBSCRIPTIONUpdates an installment subscription’s payment schedule. The operation may instead create installments or create and attach products to a deal whose ID matches the supplied subscription ID. Changes are not atomic and may be partial.

Input Parameters

integer
required
The ID of the subscription
array
required
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).
boolean
Indicates that the deal value must be set to installment subscription”s total value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_LEADUpdate an existing Pipedrive lead’s properties, such as title, value, archive status, or linked contacts. Archived leads can only be unarchived.

Input Parameters

string
required
The unique identifier of the lead to update in UUID format
string
The name/title of the lead
object
Schema for the value object containing amount and currency
integer
Marketing channel identifier
integer
The ID of the user who will own the lead
boolean
Flag indicating if lead was seen in Pipedrive UI
array
Array of lead label identifiers to assign to the lead
integer
ID of person to link to the lead. Lead requires person OR organization link. Set to null to unset.
string
Optional ID to distinguish the marketing channel
string
Visibility setting (values: 1, 3, 5, or 7 depending on plan)
boolean
Archive status flag. Set to true to archive the lead, false to unarchive.
integer
ID of organization to link to the lead. Lead requires person OR organization link. Set to null to unset.
string
Expected close date in ISO 8601 format (YYYY-MM-DD)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The ID of the lead label to update (UUID format)
string
The name of the lead label
string ("blue" | "brown" | "dark-gray" | "gray" | "green" | "orange" | "pink" | "purple" | "red" | "yellow")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_MAIL_THREADUpdates the properties of a mail thread.

Input Parameters

integer
required
The ID of the mail thread
integer
The ID of the deal this thread is associated with
string
The ID of the lead this thread is associated with
integer
Whether this thread is marked as read (0 or 1)
integer
Whether this thread is shared with other users (0 or 1)
integer
Whether this thread is archived (0 or 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the note to update
integer
The ID of the organization to attach the note to.
string
The content of the note in HTML format. Subject to sanitization on the back-end.
integer
The ID of the deal to attach the note to.
string
The ID of the lead to attach the note to (UUID format).
integer
The ID of the user to mark as the note’s author. Only administrators can change this.
string
Creation date and time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
integer
The ID of the person to attach the note to.
integer
The ID of the project to attach the note to.
integer ("0" | "1")
If set, updates the note-to-deal pinning state. Requires deal_id to be set. 0 to unpin, 1 to pin.
integer ("0" | "1")
If set, updates the note-to-lead pinning state. Requires lead_id to be set. 0 to unpin, 1 to pin.
integer ("0" | "1")
If set, updates the note-to-person pinning state. Requires person_id to be set. 0 to unpin, 1 to pin.
integer ("0" | "1")
If set, updates the note-to-project pinning state. Requires project_id to be set. 0 to unpin, 1 to pin.
integer ("0" | "1")
If set, updates the note-to-organization pinning state. Requires org_id to be set. 0 to unpin, 1 to pin.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the organization to update
string
The name of the organization
object
Address object with structured fields
integer
The ID of the user who owns the organization
array
The IDs of labels assigned to the organization
integer
The visibility of the organization. 1=owner only, 3=owner’s visibility group, 7=entire company

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization field to update
string
The name of the field
array
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’}]
boolean
Whether the field is available in ‘add new’ modal or not (both in web and mobile app)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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.
string
required
The unique code identifying the organization field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the organization relationship to update
string ("parent" | "related")
Permitted relationship types for organization relationships.
integer
The ID of the base organization for the returned calculated values
integer
The owner of this relationship. If type is ‘parent’, then the owner is the parent and the linked organization is the daughter.
integer
The linked organization in this relationship. If type is ‘parent’, then the linked organization is the daughter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_PERSONUpdates an existing Pipedrive person’s properties, such as name, contact information, owner or organization. Changing the owner requires appropriate permission. DEPRECATED: The API v1 endpoint is out of support and availability is not guaranteed; use PATCH /api/v2/persons/{id} instead.

Input Parameters

integer
required
The ID of the person to update
string
The person’s full name
array
Email addresses as an array of objects with properties: value (required), primary (optional), label (optional)
integer
Label ID for categorizing the person (deprecated in v2, use label_ids)
array
Phone numbers as an array of objects with properties: value (required), primary (optional), label (optional)
integer
The ID of the organization this person belongs to
string
The creation date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
integer
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
Array of label IDs to assign to the person
integer
Visibility of the person. Values: 1 (Owner & followers), 3 (Entire company), 5 (Owner only), 7 (Owner’s visibility group)
string
The last update date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
string ("no_consent" | "unsubscribed" | "subscribed" | "archived")
Marketing status. Only available if company uses Campaigns product. Must be one of: no_consent, unsubscribed, subscribed, archived

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person field to update
string
The field’s display name
array
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.
boolean
Controls whether the field is visible in ‘add new’ modal for web and mobile apps. Default is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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).
string
required
The unique code identifying the person field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the person to update
string
The person’s full name
array
Email addresses as objects with properties: value, primary, label
integer
The ID of the organization this person belongs to
array
Phone numbers as objects with properties: value, primary, label
string
The creation date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
integer
The ID of the user who will be the owner of the person
array
Array of label IDs to assign to the person
string
The person’s last name
string
The person’s first name
integer
Visibility of the person. Values: 1 (Owner & followers), 3 (Entire company), 5 (Owner only), 7 (Owner’s visibility group)
string
The last update date and time of the person in UTC. Format: YYYY-MM-DD HH:MM:SS
string
Marketing status. Values: ‘no_consent’, ‘unsubscribed’, ‘subscribed’, ‘archived’. Only available if company uses Campaigns product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_PIPELINEUpdates a Pipedrive pipeline’s name, deal probability, order, or active status by ID; only supplied fields are updated. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use PATCH /api/v2/pipelines/{id} instead.

Input Parameters

integer
required
The ID of the pipeline to update
string
The name of the pipeline
integer
Whether the pipeline is inactive/hidden (0) or active (1)
integer
Defines the order of pipelines. The pipeline with order_nr=0 is the default pipeline
integer
Whether deal probability is disabled (0) or enabled (1) for this pipeline

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_PIPELINE_VISIBILITY_FOR_ROLEUpdates pipeline visibility settings for different roles. For details, see the Pipedrive Visibility groups article.

Input Parameters

integer
required
The ID of the role
object
required
Object specifying pipelines to add (visible) and/or remove (hidden) for the role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product to update
number
Tax percentage. Default is 0.
string
Product code/identifier
string
Product name. Cannot be blank if provided.
string
Unit of measurement for the product
array
Array of price objects. There can only be one price per product per currency.
string
Product category
integer
ID of the user who will be marked as the owner. When omitted, the authorized user ID will be used.
boolean
Whether the product is selectable. Changed from integer to boolean as of April 3, 2023.
string
Visibility setting for the product. If omitted, default visibility will be used.
boolean
Whether the product is active. Changed from integer to boolean as of April 3, 2023.
string
Product description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product field to update
string
The name of the product field
array
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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
required
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).
string
required
The unique code identifying the product field

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product to update the image for
object
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the product
string
The name of the product variation. Maximum length is 255 characters.
array
Array of price objects for different currencies. When omitted, existing prices remain unchanged. Only one price per variation per currency is supported.
integer
required
The ID of the product variation to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_PROJECTUpdates a project.

Input Parameters

integer
required
The ID of the project
string
The title of the project
array
Array of IDs of labels the project has
integer
The ID of the associated organization
string
The status of the project
integer
The ID of the board this project is associated with
array
Array of IDs of associated deals
string
The end date (YYYY-MM-DD)
integer
The ID of a project owner
integer
The ID of the phase this project is associated with
integer
The ID of the associated person
string
The start date (YYYY-MM-DD)
string
The description of the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the subscription
array
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).
string
The description of the recurring subscription
integer
The amount of each payment
string
required
All payments after that date will be affected. Format: YYYY-MM-DD
boolean
Indicates that the deal value must be set to recurring subscription”s MRR value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role
string
The name of the role
integer
The ID of the parent role

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the role
object
required
Structure for managing pipeline visibility. Specify pipeline IDs to add (make visible) or remove (make hidden) for the role.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_STAGEUpdates a Pipedrive stage’s name, pipeline association, ordering, deal probability, or rotten deal settings. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use PATCH /api/v2/stages/{id} instead.

Input Parameters

integer
required
The ID of the stage to update
string
The name of the stage. Cannot be null or empty when provided.
integer
Numerical ordering position for the stage within its pipeline.
integer
The pipeline ID the stage belongs to. Must match an existing pipeline.
integer
Number of days before deals become rotten. Only applies when rotten_flag is enabled.
boolean
Whether deals in this stage can become rotten (deteriorate).
integer
Success probability percentage for deals in this stage. Must be between 0 and 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_STAGE_DETAILSUpdates a Pipedrive stage’s name, pipeline, ordering, deal probability, or rotten deal settings. API errors may be returned in the result rather than raised. DEPRECATED: The API v1 endpoint is out of support and its availability is not guaranteed; use PATCH /api/v2/stages/{id} instead.

Input Parameters

integer
required
The ID of the stage
string
The name of the stage
integer
Order number of this stage within its pipeline
integer
The ID of the pipeline to add the stage to
integer
Days until deals become rotten (applies when rotten_flag is true)
boolean
Whether deals in this stage can become rotten
integer
Success probability percentage (0–100)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_TASKUpdates a task.

Input Parameters

integer
required
The ID of the task
integer
0 = Not done, 1 = Done
string
The title of the task
string
The task’s due date (YYYY-MM-DD)
integer
The ID of a project
integer
The assignee user ID
string
The description of the task
integer
The ID of a parent task; cannot be a subtask’s ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_TASK_IN_PROJECT_PLANUpdates a task phase or group in a project.

Input Parameters

integer
required
The ID of the project
integer
required
The ID of the task
integer
The ID of a group on a project board
integer
The ID of a phase on a project board

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_TEAMUpdates an existing team and returns the updated object.

Input Parameters

integer
required
The ID of the team
string
The team name
array
The list of user IDs
integer
The team manager ID
integer
Flag that indicates whether the team is active (0/1)
string
The team description
integer
Flag that indicates whether the team is deleted (0/1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The ID of the user to update
boolean
required
Indicates user status. false = Not activated, true = Activated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_UPDATE_USER_DETAILSUpdates the properties of a user. Currently, only active_flag can be updated.

Input Parameters

integer
required
The ID of the user
boolean
required
Whether the user is active or not. false = Not activated, true = Activated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PIPEDRIVE_WHO_AM_IReturn the identity (name, email) of the connected Pipedrive account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: PIPEDRIVE_NEW_DEAL_TRIGGERType: webhookTriggered when a new deal is created in Pipedrive

Payload

string
Currency of the deal
string
ID of the deal
string
ID of the pipeline stage
string
Status of the deal
string
Title of the deal
string
ID of the user who created the deal
string
Value of the deal
Slug: PIPEDRIVE_NEW_NOTE_TRIGGERType: webhookTriggered when a new note is created in Pipedrive

Payload

string
Time when the note was added
string
Content of the note
string
ID of the associated deal
string
ID of the note
string
ID of the associated organization
string
ID of the associated person
string
ID of the user who created the note
Slug: PIPEDRIVE_NEW_ORGANIZATION_TRIGGERType: webhookTriggered when a new organization is created in Pipedrive

Payload

string
Address of the organization
string
Email of the organization
string
ID of the organization
string
Name of the organization
string
ID of the organization owner
string
Phone number of the organization
string
Website of the organization