- Category: crm
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? No
- Tools: 406
- Triggers: 3
- Slug:
PIPEDRIVE - Version: 20261101_00
Frequently Asked Questions
How do I set up custom OAuth credentials for Pipedrive?
How do I set up custom OAuth credentials for Pipedrive?
Why am I seeing "App not found" when connecting Pipedrive?
Why am I seeing "App not found" when connecting Pipedrive?
How should I connect with my own Pipedrive OAuth app?
How should I connect with my own Pipedrive OAuth app?
Tools
Add new activity type
Add new activity type
PIPEDRIVE_ADD_ACTIVITY_TYPEAdds a new activity type.Input Parameters
FFFFFF for white, 000000 for black)Output
Add a deal
Add a deal
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
Output
Add an activity
Add an activity
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
Output
Add an organization
Add an organization
PIPEDRIVE_ADD_AN_ORGANIZATIONCreates a new organization in Pipedrive with a required name and optional owner and visibility settings.Input Parameters
Output
Add a note (Deprecated)
Add a note (Deprecated)
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
Output
Add a person
Add a person
Add a call log
Add a call log
PIPEDRIVE_ADD_CALL_LOGAdds a new call log.Input Parameters
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.Output
Add Call Log Audio File
Add Call Log Audio File
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
Output
Add a channel
Add a channel
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
Output
Add discount to deal
Add discount to deal
Add a new deal field
Add a new deal field
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
field_type is either set or enum, possible options must be supplied [{“label”:“red”}, {“label”:“blue”}, {“label”:“lilac”}]Output
Add deal field options
Add deal field options
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
Output
Add a follower to a deal
Add a follower to a deal
Add a participant to a deal
Add a participant to a deal
Add product to deal
Add product to deal
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
Output
Bulk add products to deal
Bulk add products to deal
Add file
Add file
Add a new filter
Add a new filter
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
Output
Add a new goal
Add a new goal
Receives an incoming message
Receives an incoming message
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
Output
Add an installment subscription
Add an installment subscription
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
Output
Add a lead
Add a lead
PIPEDRIVE_ADD_LEADAdds a lead linked to a person or organization and tagged with an API source.Input Parameters
Output
Add a lead label
Add a lead label
Add Note
Add Note
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
Output
Add comment to note
Add comment to note
Add a new organization field
Add a new organization field
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
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"}]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
Add Organization Field Options
Add Organization Field Options
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
Output
Add organization follower
Add organization follower
Add or update role setting
Add or update role setting
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
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”>here</a>.
Output
Add a new person field
Add a new person field
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
Output
Add person field options
Add person field options
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
Output
Add a follower to a person
Add a follower to a person
Add person picture
Add person picture
Add a product
Add a product
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
Output
Add a new product field
Add a new product field
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
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"}]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
Add product field options
Add product field options
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
Output
Add follower to product
Add follower to product
Add Product Image
Add Product Image
Create product variation
Create product variation
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
Output
Add a project
Add a project
Add a recurring subscription
Add a recurring subscription
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
cycles_count or infinite.cycles_count or infinite. If cycles_count is set, then cycle_amount and start_date are also required.Output
Add a role
Add a role
Add role assignment
Add role assignment
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
Output
Add a new stage
Add a new stage
PIPEDRIVE_ADD_STAGEAdds a new stage, returns the ID upon success.Input Parameters
rotten_flag is set. (v2: days_to_rotten)Output
Add a new team
Add a new team
Add users to a team
Add users to a team
Add a new user
Add a new user
PIPEDRIVE_ADD_USERAdds a new user to the company, returns the ID upon success.Input Parameters
[{ app: "sales", permission_set_id: "62cc4d7f-4038-4352-abf3-a8c1c822b631" }, { app: "global", admin: true }, { app: "account_settings" }]Output
Archive a project
Archive a project
Cancel a recurring subscription
Cancel a recurring subscription
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
Output
Convert deal to lead
Convert deal to lead
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
Output
Convert Lead to Deal
Convert Lead to Deal
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
Output
Create an organization relationship
Create an organization relationship
PIPEDRIVE_CREATE_ORGANIZATION_RELATIONSHIPCreates and returns an organization relationship.Input Parameters
parent, then the owner is the parent and the linked organization is the daughter.parent, then the linked organization is the daughter.Output
Create a remote file and link it to an item
Create a remote file and link it to an item
Create a new webhook
Create a new webhook
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
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.subscription_url and the chosen URL must not redirect to another link.Output
Get all ActivityFields
Get all ActivityFields
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
Output
Update deal product
Update deal product
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
Output
Delete multiple activities in bulk
Delete multiple activities in bulk
Delete Activity
Delete Activity
Delete Activity Type
Delete Activity Type
Delete multiple activity types in bulk
Delete multiple activity types in bulk
Delete an activity
Delete an activity
Delete a person
Delete a person
Delete a person field
Delete a person field
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
Output
Delete a stage
Delete a stage
Delete a call log
Delete a call log
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
Output
Delete a channel
Delete a channel
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
Output
Delete comment from note
Delete comment from note
Delete a conversation
Delete a conversation
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
Output
Delete Deal
Delete Deal
Delete Deal Discount
Delete Deal Discount
Delete a deal field
Delete a deal field
Delete deal field options
Delete deal field options
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
Output
Delete multiple deal fields in bulk
Delete multiple deal fields in bulk
Delete deal follower
Delete deal follower
Delete a participant from a deal
Delete a participant from a deal
Delete Deal Product
Delete Deal Product
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
Output
Delete Deals Products
Delete Deals Products
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
Output
Delete multiple deals in bulk
Delete multiple deals in bulk
Delete a file
Delete a file
Delete Pipedrive Filter
Delete Pipedrive Filter
Delete multiple filters in bulk
Delete multiple filters in bulk
Delete existing goal
Delete existing goal
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
Output
Delete a lead
Delete a lead
Delete lead label
Delete lead label
Delete mail thread
Delete mail thread
Delete multiple product fields in bulk
Delete multiple product fields in bulk
Delete multiple stages in bulk
Delete multiple stages in bulk
Delete a note
Delete a note
Delete an organization
Delete an organization
Delete an organization field
Delete an organization field
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
Output
Delete organization field options
Delete organization field options
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
Output
Delete multiple organization fields in bulk
Delete multiple organization fields in bulk
Delete organization follower
Delete organization follower
Delete an organization relationship
Delete an organization relationship
Delete multiple organizations in bulk
Delete multiple organizations in bulk
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
Output
Delete a person
Delete a person
Delete a person field
Delete a person field
Delete person field options
Delete person field options
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
Output
Delete multiple person fields in bulk
Delete multiple person fields in bulk
Delete a follower from a person
Delete a follower from a person
Delete person picture
Delete person picture
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
Output
Delete multiple persons in bulk
Delete multiple persons in bulk
Delete a pipeline
Delete a pipeline
Delete a product
Delete a product
Delete a product field
Delete a product field
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
Output
Delete product field options
Delete product field options
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
Output
Delete a follower from a product
Delete a follower from a product
Delete Product Image
Delete Product Image
Delete Product Variation
Delete Product Variation
Delete a project
Delete a project
Delete a role
Delete a role
Delete a role assignment
Delete a role assignment
Delete a stage
Delete a stage
Delete a subscription
Delete a subscription
Delete a task
Delete a task
Delete users from a team
Delete users from a team
Delete existing webhook
Delete existing webhook
Download one file
Download one file
Duplicate deal
Duplicate deal
Duplicate Product
Duplicate Product
Enumerate accessible users for lead
Enumerate accessible users for lead
Find goals
Find goals
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
period.start is provided, period.end must be provided too.deals_progressed type of goals. If provided, everyone”s goals will be returned.null for all pipelines. If provided, everyone”s goals will be returned.expected_outcome.tracking_metric with value sum. If provided, everyone”s goals will be returned.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.Output
Find users by name
Find users by name
Get details of an activity
Get details of an activity
Get one activity field
Get one activity field
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
Output
Get all activities assigned to a particular user
Get all activities assigned to a particular user
PIPEDRIVE_GET_ALL_ACTIVITIES_ASSIGNED_TO_A_PARTICULAR_USERReturns all activities assigned to a particular user.Input Parameters
key_string parameter of ActivityTypes.user_id parameter)Output
Get all activities beta
Get all activities beta
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
false = Not done, true = Done. If omitted, returns both done and not done activities.key_string parameter of ActivityTypes.update_time field.update_time field.Output
Get all activity fields
Get all activity fields
Get all activity types
Get all activity types
Get all deal fields
Get all deal fields
Get all deals
Get all deals
PIPEDRIVE_GET_ALL_DEALSLists deals with filtering, sorting and pagination. Archived deals are not returned by default.Input Parameters
field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).filter_id and owned_by_you takes precedence over user_id when supplied.filter_id takes precedence over owned_by_you when both are supplied.Output
Get all deals beta
Get all deals beta
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
update_time field.update_time field.Output
Get all files
Get all files
PIPEDRIVE_GET_ALL_FILESReturns data about all files.Input Parameters
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.Output
Get all filter helpers
Get all filter helpers
Get all filters
Get all filters
Get all lead labels
Get all lead labels
Get all leads
Get all leads
PIPEDRIVE_GET_ALL_LEADSLists non-archived leads with pagination, optional filters and sorting. The archived-status parameter is ignored by Pipedrive.Input Parameters
filter_id takes precedence over owner_id when supplied.filter_id takes precedence over person_id when supplied.All is used.filter_id takes precedence over organization_id when supplied.Output
Get all lead sources
Get all lead sources
Get all note fields
Get all note fields
Get all notes
Get all notes
PIPEDRIVE_GET_ALL_NOTESReturns all notes.Input Parameters
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.Output
Get all organization fields
Get all organization fields
Get all organizations
Get all organizations
PIPEDRIVE_GET_ALL_ORGANIZATIONSReturns all organizations.Input Parameters
field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).filter_id takes precedence over user_id when both are supplied.Output
Get all organizations beta
Get all organizations beta
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
update_time field.update_time field.Output
Get all permission sets
Get all permission sets
Get all person fields
Get all person fields
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
Output
Get all persons
Get all persons
PIPEDRIVE_GET_ALL_PERSONSReturns all persons.Input Parameters
field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).filter_id takes precedence over user_id when both are supplied.Output
Get all persons beta
Get all persons beta
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
update_time field.update_time field.Output
Get all pipelines
Get all pipelines
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
Get all product fields
Get all product fields
Get all products
Get all products
PIPEDRIVE_GET_ALL_PRODUCTSReturns data about all products.Input Parameters
additional_data.summary.total_count propertyOutput
Get all project boards
Get all project boards
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
Get all projects
Get all projects
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
open, completed, canceled and deleted. By default deleted projects are not returned.true then archived projects are also included in the response. By default only not archived projects are returned.Output
Get all project templates
Get all project templates
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
Output
Get all relationships for organization
Get all relationships for organization
Get all roles
Get all roles
Get all stages
Get all stages
Get all supported currencies
Get all supported currencies
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
Output
Get all tasks
Get all tasks
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
0 = Not done, 1 = Done. If not omitted then returns both done and not done tasks.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
Get all teams
Get all teams
Get all teams of a user
Get all teams of a user
Get all user connections
Get all user connections
Get all users
Get all users
Get all users in a team
Get all users in a team
Get all webhooks
Get all webhooks
Get archived deals
Get archived deals
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
Output
Get archived leads
Get archived leads
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
Output
Get call log details
Get call log details
Get one comment
Get one comment
Get all add ons for a single company
Get all add ons for a single company
Get conversations for a channel
Get conversations for a channel
Get current user data
Get current user data
Get Deal Details
Get Deal Details
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
Output
Get deal activities (Deprecated)
Get deal activities (Deprecated)
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
Output
Get Deal Changelog
Get Deal Changelog
Get one deal field
Get one deal field
Get Deal Files
Get Deal Files
Get deal followers
Get deal followers
Get deal followers changelog
Get deal followers changelog
Get Deal Mail Messages
Get Deal Mail Messages
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
Output
Get Deal Participants
Get Deal Participants
Get Deal Participants Changelog
Get Deal Participants Changelog
Get Deal Products
Get Deal Products
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
Output
Get deals conversion rates in pipeline
Get deals conversion rates in pipeline
Get deal conversion status
Get deal conversion status
Get deals discounts
Get deals discounts
Get deals in a pipeline
Get deals in a pipeline
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
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.filter_id and user_id will not be considered – instead, deals owned by everyone will be returnedper_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
Get deals in a stage
Get deals in a stage
PIPEDRIVE_GET_DEALS_IN_A_STAGELists deals in a specific stage, with optional filters and pagination. Archived deals are excluded by default.Input Parameters
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.filter_id and user_id will not be considered – instead, deals owned by everyone will be returnedOutput
Get Deals Products
Get Deals Products
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
Output
Get deals summary
Get deals summary
PIPEDRIVE_GET_DEALS_SUMMARYRequests a summary of deals, optionally filtered by status, user, filter or stage. Archived deals are excluded by default.Input Parameters
user_id will not be considered if you use filter_id.Output
Get archived deals summary
Get archived deals summary
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
Output
Get deals timeline
Get deals timeline
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
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>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
Find subscription by deal
Find subscription by deal
Get deals where a product is attached to
Get deals where a product is attached to
PIPEDRIVE_GET_DEALS_WITH_PRODUCTLists deals with a specified product attached, with status filtering and pagination. Archived deals are excluded by default.Input Parameters
Output
Get deal updates
Get deal updates
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
Output
Get Deal Permitted Users
Get Deal Permitted Users
Get details of an organization
Get details of an organization
Get details of a person (Deprecated)
Get details of a person (Deprecated)
Get one file
Get one file
Get one filter
Get one filter
Get result of a goal
Get result of a goal
PIPEDRIVE_GET_GOAL_RESULTGets the progress of a goal for the specified period.Input Parameters
Output
Get lead conversion status by ID
Get lead conversion status by ID
Get all lead fields
Get all lead fields
Get Lead Permitted Users
Get Lead Permitted Users
Get one mail message
Get one mail message
Get one mail thread
Get one mail thread
Get all mail messages of mail thread
Get all mail messages of mail thread
Get mail threads
Get mail threads
Get Marketplace Client ID
Get Marketplace Client ID
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
Output
Get one note
Get one note
Get all comments for a note
Get all comments for a note
Get one lead
Get one lead
Get Organization Details
Get Organization Details
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
Output
Get Organization Changelog
Get Organization Changelog
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
Output
Get organization deals
Get organization deals
PIPEDRIVE_GET_ORGANIZATION_DEALSLists deals associated with an organization, with optional filtering and pagination. Archived deals are not returned.Input Parameters
Output
Get one organization field
Get one organization field
Get Organization Files
Get Organization Files
Get Organization Followers
Get Organization Followers
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
Output
Get Organization Followers Changelog
Get Organization Followers Changelog
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
Output
Get Organization Mail Messages
Get Organization Mail Messages
Get Organization Persons
Get Organization Persons
Get one organization relationship
Get one organization relationship
Get Organization Updates
Get Organization Updates
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
Output
Get organization permitted users
Get organization permitted users
Get one permission set
Get one permission set
Get Permission Set Assignments
Get Permission Set Assignments
Get Person Details
Get Person Details
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
Output
Get Person Changelog
Get Person Changelog
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
Output
Get person deals
Get person deals
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
Output
Get one person field
Get one person field
Get Person Files
Get Person Files
Get Person Followers
Get Person Followers
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
Output
Get person followers changelog
Get person followers changelog
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
Output
Get Person Mail Messages
Get Person Mail Messages
Get Person Picture
Get Person Picture
Get Person Products
Get Person Products
Get person updates
Get person updates
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
Output
Get Person Permitted Users
Get Person Permitted Users
Get one pipeline
Get one pipeline
PIPEDRIVE_GET_PIPELINEReturns data about a specific pipeline.Input Parameters
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
Get Pipeline Conversion Statistics
Get Pipeline Conversion Statistics
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
Output
Get Pipeline Movement Statistics
Get Pipeline Movement Statistics
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
Output
Get one product
Get one product
Get Product Deals
Get Product Deals
PIPEDRIVE_GET_PRODUCT_DEALSLists deals associated with a product, excluding archived deals by default. Supports pagination and filtering by deal status.Input Parameters
Output
Get one product field
Get one product field
Get Product Files
Get Product Files
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
id, update_time. Only first field is used for sorting.Output
Get product followers
Get product followers
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
Output
Get Product Followers Changelog
Get Product Followers Changelog
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
Output
Get product images
Get product images
List permitted users for product
List permitted users for product
Get product variations
Get product variations
Get details of a project
Get details of a project
Returns project activities
Returns project activities
Get details of a board
Get details of a board
Returns project groups
Returns project groups
Get details of a phase
Get details of a phase
Get project phases
Get project phases
Returns project plan
Returns project plan
Returns project tasks
Returns project tasks
Get recents
Get recents
PIPEDRIVE_GET_RECENTSReturns data about all recent changes occurred after the given timestamp.Input Parameters
Output
Get one role
Get one role
Get role assignments
Get role assignments
Get role pipelines
Get role pipelines
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
Output
Get role settings
Get role settings
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
Output
Get details of a subscription
Get details of a subscription
Get all payments of a subscription
Get all payments of a subscription
Get details of a task
Get details of a task
Get details of a template
Get details of a template
Get templates for a channel
Get templates for a channel
Get one user
Get one user
Get all call logs assigned to a particular user
Get all call logs assigned to a particular user
Get User Followers
Get User Followers
PIPEDRIVE_GET_USER_FOLLOWERSList a page of users following a specific Pipedrive user. Use the returned cursor to request subsequent pages.Input Parameters
Output
List user permissions
List user permissions
Get User Role Assignments
Get User Role Assignments
Get user role settings
Get user role settings
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
Output
Link a remote file to an item
Link a remote file to an item
PIPEDRIVE_LINK_REMOTE_FILELinks an existing remote file (googledrive) to the item you supply. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-remote-file” target=“_blank” rel=“noopener noreferrer”>adding a remote file</a>.Input Parameters
googledrive is supported at the moment.Output
Link User Video Integration
Link User Video Integration
List activities
List activities
List activities associated with a deal
List activities associated with a deal
List files attached to a deal
List files attached to a deal
PIPEDRIVE_LIST_DEAL_FILESLists files associated with a deal.Input Parameters
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.Output
List followers of a deal
List followers of a deal
List mail messages associated with a deal
List mail messages associated with a deal
List all persons associated with a deal
List all persons associated with a deal
List products attached to a deal
List products attached to a deal
List deals
List deals
List updates about a deal
List updates about a deal
PIPEDRIVE_LIST_DEAL_UPDATESLists updates about a deal.Input Parameters
Output
List permitted users
List permitted users
List all files
List all files
List activities associated with an organization
List activities associated with an organization
List deals associated with an organization
List deals associated with an organization
PIPEDRIVE_LIST_ORGANIZATION_DEALSLists non-archived deals associated with an organization, with status filtering and pagination.Input Parameters
field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).Output
List files attached to an organization
List files attached to an organization
PIPEDRIVE_LIST_ORGANIZATION_FILESLists files associated with an organization.Input Parameters
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.Output
List followers of an organization
List followers of an organization
List mail messages associated with an organization
List mail messages associated with an organization
List persons of an organization
List persons of an organization
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
Output
List participants of a deal
List participants of a deal
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
Output
List permission set assignments
List permission set assignments
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
Output
List activities associated with a person
List activities associated with a person
List deals associated with a person
List deals associated with a person
PIPEDRIVE_LIST_PERSON_DEALSLists non-archived deals associated with a person, with status filtering and pagination.Input Parameters
field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).Output
List files attached to a person
List files attached to a person
PIPEDRIVE_LIST_PERSON_FILESLists files associated with a person.Input Parameters
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.Output
List followers of a person
List followers of a person
List mail messages associated with a person
List mail messages associated with a person
List products associated with a person
List products associated with a person
List persons
List persons
List Person Access Users
List Person Access Users
List files attached to a product
List files attached to a product
List followers of a product
List followers of a product
List Product Permitted Users
List Product Permitted Users
List role assignments
List role assignments
List pipeline visibility for a role
List pipeline visibility for a role
List role settings
List role settings
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
Output
List updates about an organization
List updates about an organization
PIPEDRIVE_LIST_UPDATES_ABOUT_AN_ORGANIZATIONLists updates about an organization.Input Parameters
Output
List updates about a person
List updates about a person
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
Output
List updates about participants of a deal
List updates about participants of a deal
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
Output
List followers of a user
List followers of a user
List user permissions
List user permissions
List User Role Assignments
List User Role Assignments
List user role settings
List user role settings
Merge Deals
Merge Deals
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
Output
Merge Organizations
Merge Organizations
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
Output
Merge two persons
Merge two persons
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
Output
Merge two deals
Merge two deals
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
Output
Merge two organizations
Merge two organizations
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
Output
Merge two persons
Merge two persons
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
Output
Organization accessible user list
Organization accessible user list
Patch deal fields
Patch deal fields
Update organization field (v2)
Update organization field (v2)
Update Person Field Configuration
Update Person Field Configuration
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
Output
Update product field
Update product field
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
Output
Refreshing the tokens
Refreshing the tokens
Search deals
Search deals
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
search_for_related_items parameter.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>.Output
Search Item By Field
Search Item By Field
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
exact_match). Please note that the search term has to be URL encoded.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>.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
Search leads
Search leads
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
exact_match). Please note that the search term has to be URL encoded.search_for_related_items parameter.Output
Perform a search from multiple item types
Perform a search from multiple item types
PIPEDRIVE_SEARCH_MULTIPLE_ITEM_TYPESSearches across item types and fields, with optional selection of one item type and one field.Input Parameters
exact_match). Please note that the search term has to be URL encoded.search_for_related_items parameter.<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.Output
Search organizations
Search organizations
PIPEDRIVE_SEARCH_ORGANIZATIONSSearches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href=“https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem”>/v1/itemSearch</a> with a narrower OAuth scope.Input Parameters
exact_match). Please note that the search term has to be URL encoded.search_for_related_items parameter.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>.Output
Search persons
Search persons
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
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.search_for_related_items parameter.Output
Search products
Search products
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
exact_match). Please note that the search term has to be URL encoded.search_for_related_items parameter.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>.Output
Update stage
Update stage
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
Output
Unlinkuserfromvideocallintegration
Unlinkuserfromvideocallintegration
Update an activity
Update an activity
Update activity in project plan
Update activity in project plan
Update activity type
Update activity type
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
Output
Update a deal
Update a deal
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
Output
Update a deal field
Update a deal field
PIPEDRIVE_UPDATE_A_DEAL_FIELDUpdates a deal field definition’s name, options, or visibility in the add-new dialog.Input Parameters
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"}]Output
Update a filter
Update a filter
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
Output
Update a lead
Update a lead
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
Output
Update a lead label
Update a lead label
PIPEDRIVE_UPDATE_A_LEAD_LABELUpdates one or more properties of a lead label. Only properties included in the request will be updated.Input Parameters
Output
Update an activity
Update an activity
Update an activity type
Update an activity type
PIPEDRIVE_UPDATE_AN_ACTIVITY_TYPEUpdates an activity type.Input Parameters
FFFFFF for white, 000000 for black)Output
Update an organization
Update an organization
PIPEDRIVE_UPDATE_AN_ORGANIZATIONUpdates the properties of an organization.Input Parameters
Output
Update an organization field
Update an organization field
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
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"}]Output
Update an organization relationship
Update an organization relationship
PIPEDRIVE_UPDATE_AN_ORGANIZATION_RELATIONSHIPUpdates and returns an organization relationship.Input Parameters
parent, then the owner is the parent and the linked organization is the daughter.parent, then the linked organization is the daughter.Output
Update a person
Update a person
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
Output
Update a person field
Update a person field
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
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"}]Output
Update a pipeline
Update a pipeline
Update a product field
Update a product field
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
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
Update comment for note
Update comment for note
Update a deal
Update a deal
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
Output
Update deal discount
Update deal discount
Update a deal field
Update a deal field
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
Output
Update deal field options
Update deal field options
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
Output
Update Deal Product
Update Deal Product
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
Output
Update the product attached to a deal
Update the product attached to a deal
PIPEDRIVE_UPDATE_DEAL_PRODUCT_ATTACHMENTUpdates the details of the product that has been attached to a deal.Input Parameters
discount_type field can be used to specify whether the value is an amount or a percentage.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.Output
Update deal (v2 API)
Update deal (v2 API)
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
Output
Update file details
Update file details
Update file details
Update file details
Update filter
Update filter
Update existing goal
Update existing goal
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
Output
Update an installment subscription
Update an installment subscription
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
Output
Update a lead
Update a lead
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
Output
Update Lead Label
Update Lead Label
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
Output
Update mail thread details
Update mail thread details
Update Note
Update Note
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
Output
Update Organization
Update Organization
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
Output
Update organization field
Update organization field
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
Output
Update organization field options
Update organization field options
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
Output
Update organization relationship
Update organization relationship
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
Output
Update a person
Update a person
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
Output
Update person field
Update person field
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
Output
Update person field options
Update person field options
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
Output
Update person (v2)
Update person (v2)
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
Output
Update a pipeline
Update a pipeline
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
Output
Update pipeline visibility for a role
Update pipeline visibility for a role
Update a product
Update a product
Update product field
Update product field
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
Output
Update product field options
Update product field options
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
Output
Update product image
Update product image
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
Output
Update product variation
Update product variation
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
Output
Update a recurring subscription
Update a recurring subscription
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
Output
Update role details
Update role details
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
Output
Update role pipelines
Update role pipelines
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
Output
Update stage details
Update stage details
Update stage details
Update stage details
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
Output
Update task in project plan
Update task in project plan
Update a team
Update a team
Update user details
Update user details
Triggers
New Deal Received Trigger
New Deal Received Trigger
New Note Received Trigger
New Note Received Trigger