Pipedrive

Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing pipedrive · 402 tools · 3 triggers

Connect it

run auth pipedrive
run auth pipedrive --scope team    # shared with the organization

Or from the Integrations page in the console. See Connections for personal versus shared, and who may remove one.

Use it

run pipedrive          # common commands
run pipedrive --all    # every command

import { pipedrive } from "@boxd/run";

Common tools

Tool	What it does
`add-deal`	Add a new deal to Pipedrive with any custom fields, which vary by account and are identified by long hash keys.
`add-activity`	New activity added. Response includes `more_activities_scheduled_in_context` to show if more are planned with the same entity.
`add-note`	Tool to add a note to a deal, person, organization, lead, or project in Pipedrive.
`add-person`	Add a new contact in Pipedrive with optional custom fields unique to each account found using the `personFields` endpoint.
`add-deal-products`	Tool to bulk add products to a Pipedrive deal. Use when attaching multiple products simultaneously, with maximum 100 products per request.
`add-lead`	Pipedrive API lets you add leads linked to people or organizations and tags them with ‘API’ source.
`add-product`	Adds a new product to the Products inventory. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-product”…
`convert-lead-to-deal`	Tool to convert a Pipedrive lead to a deal asynchronously. Use when you need to convert an existing lead into a deal.
`deals-update-deal`	Tool to update product details attached to a deal in Pipedrive using the v2 API.
`delete-deal`	Tool to delete a deal in Pipedrive. Use when you need to remove a deal.
`delete-organization`	Tool to delete an organization in Pipedrive. Use when you need to mark an organization as deleted.
`delete-person`	Tool to delete a person in Pipedrive. Use when you need to mark a person as deleted.
`get-activity-field`	Tool to retrieve detailed metadata for a specific activity field by its field code.
`get-all-leads`	The API returns sorted leads by creation time, supporting pagination via `limit` and `start`.
`get-all-products`	Returns data about all products.
`get-deal`	Tool to get details of a specific deal in Pipedrive. Use when you need to retrieve comprehensive information about a deal by its ID.
`get-deal-field`	Tool to retrieve a specific deal field by ID. Use when you need to get metadata and configuration for a deal field.
`get-lead-conversion-status`	Tool to retrieve the conversion status for a specific lead conversion job.
`get-one-lead`	API returns specific lead details with custom field values in the Deals format.
`get-organization`	Tool to get details of a specific organization in Pipedrive.
`get-organization-field`	Tool to retrieve a specific organization field by ID. Use when you need to get metadata and configuration for an organization field.
`get-person`	Tool to get details of a specific person in Pipedrive. Use when you need to retrieve comprehensive information about a person by their ID.
`get-person-field`	Tool to retrieve metadata for a specific person field by its ID.
`get-person-picture`	Tool to get picture details of a specific person in Pipedrive.
`get-product-images`	Tool to retrieve image data for a specific product. Use when you need to get the public URL and metadata for a product’s image.

All 379 tools

Tool	What it does
`add-activity-type`	Adds a new activity type.
`add-deal`	Add a new deal to Pipedrive with any custom fields, which vary by account and are identified by long hash keys.
`add-activity`	New activity added. Response includes `more_activities_scheduled_in_context` to show if more are planned with the same entity.
`add-organization`	Creates a new organization in Pipedrive. The ‘name’ parameter is required and represents the organization’s name (e.g., ‘Acme Corp’).
`add-note`	Tool to add a note to a deal, person, organization, lead, or project in Pipedrive.
`add-person`	Add a new contact in Pipedrive with optional custom fields unique to each account found using the `personFields` endpoint.
`add-call-log`	Adds a new call log.
`add-call-log-audio-file`	Tool to attach an audio recording to an existing call log in Pipedrive.
`add-channel`	New messaging channel added; registration limited to admins.
`add-deal-discount`	Tool 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.
`add-deal-field`	Adds a new deal field. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-new-custom-field”…
`add-dealfields-options`	Tool to add new options to a deal custom field atomically. Use when you need to add options to enum or set type deal fields.
`add-deal-follower`	Adds a follower to a deal.
`add-deal-participant`	Adds a participant to a deal.
`add-deal-product`	Tool 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…
`add-deal-products`	Tool to bulk add products to a Pipedrive deal. Use when attaching multiple products simultaneously, with maximum 100 products per request.
`add-file`	Upload and link files to deals, people, organizations, activities, products, or leads in Pipedrive.
`add-filter`	New filter creation returns an ID. Only one primary condition group with ‘AND’ and two secondary groups (one ‘AND’, one ‘OR’) are supported.
`add-goal`	Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
`add-incoming-message`	Adds a message to a conversation. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest…
`add-installment-subscription`	Adds a new installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL.
`add-lead`	Pipedrive API lets you add leads linked to people or organizations and tags them with ‘API’ source.
`add-lead-label`	Creates a lead label.
`add-note-comment`	Tool 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.
`add-organization-field`	Adds a new organization field. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-new-custom-field”…
`add-organization-field-options`	Tool to add new options to an organization field in Pipedrive.
`add-organization-follower`	Tool 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.
`add-or-update-role-setting`	Adds or updates the visibility setting for a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company…
`add-person-field`	Adds a new person field. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-new-custom-field”…
`add-personfields-options`	Tool to bulk add options to enum/set person fields atomically.
`add-person-follower`	Tool 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.
`add-person-picture`	This service allows adding a photo to a person’s profile, replacing any existing one.
`add-pipeline`	Adds a new pipeline (v2).
`add-product`	Adds a new product to the Products inventory. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-product”…
`add-product-field`	Adds a new product field. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-new-custom-field”…
`add-productfields-options`	Tool to add new options to a product custom field that supports options (enum or set field types).
`add-product-follower`	Tool 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.
`add-product-image`	Tool to upload an image for a product in Pipedrive. Use when you need to add a visual representation to a product.
`add-product-variation`	Tool to create a new product variation for an existing product.
`add-project`	Adds a new project. Note that you can supply additional custom fields along with the request that are not described here.
`add-recurring-subscription`	Adds a new recurring subscription.
`add-role`	Adds a new role. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain base URL with `/api/v1` path.
`add-role-assignment`	Assigns a user to a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with `/api/v1` path…
`add-stage`	Adds a new stage, returns the ID upon success.
`add-task`	Adds a new task.
`add-team`	Adds a new team to the company and returns the created object.
`add-team-users`	Adds users to an existing team.
`add-user`	Adds a new user to the company, returns the ID upon success.
`archive-project`	Archives a project.
`cancel-recurring-subscription`	Cancels a recurring subscription. This action attempts to cancel a recurring subscription via Subscriptions API.
`convert-deal-to-lead`	Tool 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…
`convert-lead-to-deal`	Tool to convert a Pipedrive lead to a deal asynchronously. Use when you need to convert an existing lead into a deal.
`create-organization-relationship`	Creates and returns an organization relationship.
`create-remote-file-link`	Creates an empty file on Google Drive linked to an item. For details, refer to the Pipedrive remote file adding tutorial.
`create-webhook`	Creates and returns details of a new Webhook. Trigger events combine `event_action` and `event_object`, like `.` for all events or `added.deal`…
`ctivityields-get-all-activityfields`	Tool to retrieve metadata about all activity fields in the company.
`deals-update-deal`	Tool to update product details attached to a deal in Pipedrive using the v2 API.
`delete-activities-bulk`	Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.
`delete-activity`	Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
`delete-activity-type`	Tool to delete an activity type in Pipedrive. Use when you need to remove an activity type from the system.
`delete-activity-types-bulk`	Marks multiple activity types as deleted.
`delete-person`	Tool to delete a person in Pipedrive. Use when you need to mark a person as deleted.
`delete-person-field`	Tool to delete a person field from Pipedrive. Use when you need to remove a custom person field by its unique identifier.
`delete-stage`	Tool to delete a stage in Pipedrive. Use when you need to mark a stage as deleted.
`delete-call-log`	Deletes a call log. If there is an audio recording attached to it, it will also be deleted.
`delete-channel`	The endpoint removes a messenger channel along with conversations and messages.
`delete-comment`	Tool 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.
`delete-conversation`	Deletes an existing conversation. To use the endpoint, you need to have Messengers integration OAuth scope enabled and the Messaging manifest…
`delete-deal`	Tool to delete a deal in Pipedrive. Use when you need to remove a deal.
`delete-deal-discount`	Tool to delete a discount from a deal in Pipedrive. Use when you need to remove a discount that was previously applied to a deal.
`delete-deal-field`	Tool to delete a deal field in Pipedrive by marking it as deleted.
`delete-deal-field-options`	Tool to remove existing options from a deal custom field atomically.
`delete-deal-fields-bulk`	Marks multiple deal fields as deleted.
`delete-deal-follower`	Tool to delete a follower from a deal in Pipedrive. Use when you need to remove a user from a deal’s follower list.
`delete-deal-participant`	Deletes a participant from a deal.
`delete-deal-product`	Tool to delete an attached product from a deal in Pipedrive.
`delete-deal-products`	Tool to delete multiple products from a deal in Pipedrive. Use when you need to remove specific products or all products from a deal.
`delete-deals-bulk`	Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.
`delete-file`	Tool to delete a file in Pipedrive. Use when you need to remove a file from the system.
`delete-filter`	Tool to delete a filter in Pipedrive. Use when you need to remove a specific filter by its ID.
`delete-filters-bulk`	Marks multiple filters as deleted.
`delete-goal`	Marks a goal as deleted. Notes: - Pipedrive Goals endpoints for OAuth live under `{companydomain}/api/v1`.
`delete-lead`	Deletes a specific lead.
`delete-lead-label`	Tool to delete a specific lead label from Pipedrive. Use when you need to remove a lead label using its UUID identifier.
`delete-mail-thread`	Marks a mail thread as deleted.
`delete-multiple-product-fields`	Marks multiple fields as deleted.
`delete-multiple-stages`	Marks multiple stages as deleted (v1). Note: This endpoint may be deprecated; we keep compatibility and avoid raising to surface API errors in response.
`delete-note`	Deletes a specific note.
`delete-organization`	Tool to delete an organization in Pipedrive. Use when you need to mark an organization as deleted.
`delete-organization-field`	Marks a field as deleted. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/deleting-a-custom-field”…
`delete-organization-field-options`	Tool to delete specified options from an organization field in Pipedrive.
`delete-organization-fields-bulk`	Marks multiple fields as deleted.
`delete-organization-follower`	Tool to delete a follower from an organization in Pipedrive.
`delete-organization-relationship`	Deletes an organization relationship and returns the deleted ID.
`delete-organizations-bulk`	Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.
`delete-person-field-options`	Tool to remove existing options from a person custom field atomically.
`delete-person-fields-bulk`	Marks multiple fields as deleted.
`delete-person-follower`	Deletes a follower from a person.
`delete-person-picture`	Deletes a person’s picture. Note: Pipedrive may return a 400 with error “Item not found” when the person has no picture set.
`delete-persons-bulk`	Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.
`delete-pipeline`	Marks a pipeline as deleted.
`delete-product`	Marks a product as deleted. After 30 days, the product will be permanently deleted.
`delete-product-field`	Marks a product field as deleted. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/deleting-a-custom-field”…
`delete-product-field-options`	Tool to remove existing options from a product custom field atomically.
`delete-product-follower`	Deletes a follower from a product.
`delete-product-image`	Tool to delete an image from a product in Pipedrive. Use when you need to remove a product image.
`delete-product-variation`	Tool to delete a product variation from a product in Pipedrive.
`delete-project`	Marks a project as deleted.
`delete-role`	Marks a role as deleted. Note: This endpoint requires admin permissions.
`delete-role-assignment`	Removes the assigned user from a role and adds to the default role.
`delete-subscription`	Marks an installment or a recurring subscription as deleted.
`delete-task`	Marks a task as deleted. If the task has subtasks then those will also be deleted.
`delete-team-users`	Deletes users from an existing team.
`delete-webhook`	Deletes the specified Webhook.
`download-file`	Initializes a file download.
`duplicate-deal`	Duplicates a deal.
`duplicate-product`	Tool 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.
`enumerate-accessible-users-for-lead`	Lists the users permitted to access a lead.
`find-goals`	Query goal data by appending `{searchField}={searchValue}` to the URL with dot-notation fields and values.
`find-users-by-name`	Finds users by their name.
`get-activity`	Returns the details of a specific activity.
`get-activity-field`	Tool to retrieve detailed metadata for a specific activity field by its field code.
`get-all-activities-assigned-to-particular-user`	Returns all activities assigned to a particular user.
`get-all-activities-beta`	This BETA cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error.
`get-all-activity-fields`	Returns all activity fields.
`get-all-activity-types`	Returns all activity types.
`get-all-deal-fields`	Returns data about all deal fields.
`get-all-deals`	Returns all deals. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/getting-all-deals” target=“_blank”…
`get-all-deals-beta`	This endpoint returns all deals with cursor pagination (in BETA).
`get-all-files`	Returns data about all files.
`get-all-filter-helpers`	The text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an API.
`get-all-filters`	Returns data about all filters.
`get-all-lead-labels`	Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.
`get-all-leads`	The API returns sorted leads by creation time, supporting pagination via `limit` and `start`.
`get-all-lead-sources`	Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified.
`get-all-note-fields`	Returns data about all note fields.
`get-all-notes`	Returns all notes.
`get-all-organization-fields`	Returns data about all organization fields.
`get-all-organizations`	Returns all organizations.
`get-all-organizations-beta`	This BETA API endpoint lists all organizations with cursor pagination.
`get-all-permission-sets`	Returns data about all permission sets.
`get-all-person-fields`	Returns data about all person fields. If a company uses the Campaigns product, then…
`get-all-persons`	Returns all persons.
`get-all-persons-beta`	This BETA endpoint returns all persons, using cursor pagination.
`get-all-pipelines`	Returns data about all pipelines. This action retrieves all pipelines from the user’s Pipedrive instance using their instance-specific URL (e.g…
`get-all-product-fields`	Returns data about all product fields.
`get-all-products`	Returns data about all products.
`get-all-project-boards`	Returns all projects boards that are not deleted. Note: The Projects feature requires the Projects add-on which is available on Power and Enterprise…
`get-all-projects`	Returns all projects. This is a cursor-paginated endpoint.
`get-all-project-templates`	The endpoint retrieves all non-deleted project templates with cursor-based pagination.
`get-all-relationships-for-organization`	Gets all of the relationships for a supplied organization ID.
`get-all-roles`	Returns all the roles within the company. Note: - Roles endpoints require the `admin` scope. - For OAuth tokens, Pipedrive expects the company domain…
`get-all-stages`	Returns data about all stages.
`get-all-supported-currencies`	Returns all supported currencies in given account which should be used when saving monetary values with other objects.
`get-all-tasks`	Returns all tasks. This is a cursor-paginated endpoint.
`get-all-teams`	Returns data about teams within the company.
`get-all-teams-of-user`	Returns data about all teams which have the specified user as a member.
`get-all-user-connections`	Returns data about all connections for the authorized user.
`get-all-users`	Returns data about all users within the company.
`get-all-users-in-team`	Returns a list of all user IDs within a team.
`get-all-webhooks`	Returns data about all the Webhooks of a company.
`get-archived-deals`	Tool to get all archived deals from Pipedrive. Use when you need to retrieve deals that have been archived, with support for filtering and pagination.
`get-archived-leads`	Tool to get all archived leads from Pipedrive. Use when you need to retrieve leads that have been archived, with support for filtering by owner…
`get-call-log`	Tool 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…
`get-comment`	Returns the details of a comment.
`get-company-add-ons`	Returns the add-ons for a single company.
`get-conversations`	Tool to retrieve messaging conversations. Use after channel registration to sync conversations.
`get-current-user-data`	Returns data about an authorized user within the company with bound company data: company ID, company name, and domain.
`get-deal`	Tool to get details of a specific deal in Pipedrive. Use when you need to retrieve comprehensive information about a deal by its ID.
`get-deal-activities`	DEPRECATED: Use PIPEDRIVE_PIPEDRIVE_ACTIVITIES_UPDATE_ACTIVITY or PIPEDRIVE_LIST_ACTIVITIES instead.
`get-deal-changelog`	Tool to list updates about deal field values. Use when you need to retrieve the changelog history showing all changes made to a specific deal’s field values.
`get-deal-field`	Tool to retrieve a specific deal field by ID. Use when you need to get metadata and configuration for a deal field.
`get-deal-files`	Tool to list files attached to a deal. Use when you need to retrieve all files associated with a specific deal in Pipedrive.
`get-deal-followers`	Lists users who are following the deal. Use when you need to retrieve all followers of a specific deal.
`get-deal-followers-changelog`	Tool to retrieve changelogs about users who have followed a deal.
`get-deal-mail-messages`	Tool to list mail messages associated with a deal in Pipedrive.
`get-deal-participants`	Tool to list participants of a deal. Use when you need to retrieve all participants (persons) associated with a specific deal in Pipedrive.
`get-deal-participants-changelog`	Tool to list updates about participants of a deal. Use when you need to retrieve the changelog history showing all changes made to a specific deal’s participants.
`get-deal-products`	Tool to list products attached to a deal. Use when you need to retrieve all products associated with a specific deal in Pipedrive.
`get-deals-conversion-rates-in-pipeline`	Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
`get-deals-convert-status`	Tool to retrieve the conversion status for a deal-to-lead conversion operation.
`get-deals-discounts`	Tool to retrieve discounts for a specific deal. Use when you need to list all discounts added to a deal in Pipedrive.
`get-deals-in-pipeline`	Lists deals in a specific pipeline across all its stages.
`get-deals-in-stage`	Lists deals in a specific stage.
`get-deals-products`	Tool to retrieve products attached to specified deals (max 100 deals per request).
`get-deals-summary`	Returns a summary of all the deals.
`get-deals-summary-archived`	Tool to retrieve summary statistics for archived deals. Use when you need aggregated data about archived deals including total count, values, and…
`get-deals-timeline`	Returns opened and won deals in time-based groups according to a specified dealField, with examples of deals grouped by month over a 3-month period starting January 2012.
`get-deal-subscription`	Returns details of an installment or a recurring subscription by the deal ID.
`get-deals-with-product`	Returns data about deals that have a product attached to it.
`get-deal-updates`	Lists updates about a deal in chronological order. Use when you need to track deal changes, monitor activity timeline, or audit deal modifications.
`get-deal-users`	Tool 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.
`get-details-of-organization`	Provides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as…
`get-details-of-person`	DEPRECATED: Use PIPEDRIVE_PIPEDRIVE_GET_PERSON instead. The text describes an API endpoint that returns detailed person information, including extra…
`get-file`	Returns data about a specific file.
`get-filter`	Returns data about a specific filter. Note that this also returns the condition lines of the filter.
`get-goal-result`	Gets the progress of a goal for the specified period.
`get-lead-conversion-status`	Tool to retrieve the conversion status for a specific lead conversion job.
`get-lead-fields`	Tool to retrieve all lead fields. Use when you need to get the schema for leads in a company’s context.
`get-lead-users`	Tool 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.
`get-mail-message`	Returns data about a specific mail message.
`get-mail-thread`	Returns a specific mail thread.
`get-mail-thread-messages`	Returns all the mail messages inside a specified mail thread.
`get-mail-threads`	Returns mail threads in a specified folder ordered by the most recent message within.
`get-marketplace-client-id`	Tool to retrieve marketplace_client_id of an installed video integration.
`get-note`	Returns details about a specific note.
`get-note-comments`	Returns all comments associated with a note.
`get-one-lead`	API returns specific lead details with custom field values in the Deals format.
`get-organization`	Tool to get details of a specific organization in Pipedrive.
`get-organization-changelog`	Tool to list updates about organization field values. Use when you need to retrieve the changelog history showing all changes made to a specific…
`get-organization-deals`	Lists deals associated with an organization. Use when you need to retrieve all deals linked to a specific organization with optional filtering and pagination.
`get-organization-field`	Tool to retrieve a specific organization field by ID. Use when you need to get metadata and configuration for an organization field.
`get-organization-files`	Tool to list files attached to an organization. Use when you need to retrieve all files associated with a specific organization in Pipedrive.
`get-organization-followers`	Tool to list followers of an organization. Use when you need to retrieve all users who are following a specific organization in Pipedrive.
`get-organization-followers-changelog`	Tool to list changelog about organization followers. Use when you need to retrieve the history of users who have followed or unfollowed a specific organization.
`get-organization-mail-messages`	Tool to list mail messages associated with an organization. Use when you need to retrieve all email correspondence linked to a specific organization in Pipedrive.
`get-organization-persons`	Tool to list persons associated with an organization. Use when you need to retrieve all persons linked to a specific organization in Pipedrive.
`get-organization-relationship`	Finds and returns an organization relationship from its ID.
`get-organization-updates`	Tool to list updates about an organization including field value changes, activities, notes, files, and other related items.
`get-organization-users`	List 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…
`get-permission-set`	Returns data about a specific permission set.
`get-permission-set-assignments`	Tool to list permission set assignments for a given permission set.
`get-person`	Tool to get details of a specific person in Pipedrive. Use when you need to retrieve comprehensive information about a person by their ID.
`get-person-changelog`	Tool 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.
`get-person-deals`	Lists deals associated with a person. Use when you need to retrieve all deals linked to a specific person.
`get-person-field`	Tool to retrieve metadata for a specific person field by its ID.
`get-person-files`	Tool to list files attached to a person. Use when you need to retrieve all files associated with a specific person in Pipedrive.
`get-person-followers`	Tool to list followers of a person in Pipedrive. Use when you need to retrieve all users who are following a specific person.
`get-person-followers-changelog`	Tool to retrieve changelogs about users who have followed a person.
`get-person-mail-messages`	Tool to list mail messages associated with a person in Pipedrive.
`get-person-picture`	Tool to get picture details of a specific person in Pipedrive.
`get-person-products`	Tool to list products associated with a person. Use when you need to retrieve all products linked to a specific person in Pipedrive.
`get-person-updates`	Lists updates and activity history for a specific person in chronological order.
`get-person-users`	Tool 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.
`get-pipeline`	Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.
`get-pipeline-conversion-statistics`	Tool to get deals conversion rates in a pipeline for a given time period.
`get-pipeline-movement-statistics`	Tool to retrieve deal movement statistics within a pipeline for a specified time period.
`get-product`	Returns data about a specific product.
`get-product-deals`	Tool to list deals associated with a product. Use when you need to retrieve deals that have a specific product attached to them.
`get-product-field`	Returns data about a specific product field.
`get-product-files`	Tool to list files attached to a product. Use when you need to retrieve all files associated with a specific product in Pipedrive.
`get-product-followers`	Tool to list all followers of a product in Pipedrive. Use when you need to retrieve users following a specific product.
`get-product-followers-changelog`	Tool 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.
`get-product-images`	Tool to retrieve image data for a specific product. Use when you need to get the public URL and metadata for a product’s image.
`get-product-users`	Tool to list users permitted to access a product in Pipedrive.
`get-product-variations`	Tool to retrieve all product variations for a specific product with pagination support.
`get-project`	Returns the details of a specific project. Also note that custom fields appear as long hashes in the resulting data.
`get-project-activities`	Returns activities linked to a specific project.
`get-project-board`	Returns the details of a specific project board.
`get-project-groups`	Returns all active groups under a specific project.
`get-project-phase`	Returns the details of a specific project phase.
`get-project-phases`	Returns all active project phases under a specific board.
`get-project-plan`	Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.
`get-project-tasks`	Returns tasks linked to a specific project.
`get-recents`	Returns data about all recent changes occurred after the given timestamp.
`get-role`	Tool to retrieve details for a specific role by its ID. Use when you need to get complete role information including name, parent role, active…
`get-role-assignments`	Tool to retrieve all users assigned to a specific role in Pipedrive.
`get-role-pipelines`	Returns the visibility settings for pipelines associated with a specific role.
`get-role-settings`	Tool to retrieve visibility settings of a specific role. Use when you need to get default visibility levels and access levels for deals, leads…
`get-stage`	Returns data about a specific stage.
`get-subscription`	Returns details of an installment or a recurring subscription.
`get-subscription-payments`	Returns all payments of an installment or recurring subscription.
`get-task`	Returns the details of a specific task.
`get-team`	Returns data about a specific team.
`get-template`	Returns the details of a specific project template.
`get-templates`	Tool to retrieve message templates for a channel. Use when template support is enabled.
`get-user`	Returns data about a specific user within the company.
`get-user-call-logs`	Returns all call logs assigned to a particular user.
`get-user-followers`	Tool to list users who are following a specific user. Use when you need to retrieve all followers of a user in Pipedrive.
`get-user-permissions`	Tool to list aggregated permissions over all assigned permission sets for a user.
`get-user-role-assignments`	Tool to list role assignments for a user. Use when you need to retrieve all role assignments associated with a specific user in Pipedrive.
`get-user-role-settings`	Tool to list user role settings. Use when you need to retrieve the role configuration data for a specific user, including default visibility levels…
`link-remote-file`	Links an existing remote file (`googledrive`) to the item you supply.
`link-user-video-integration`	A video calling provider must call this endpoint after a user has installed the video calling app so that the new user’s information is sent.
`list-deal-activities`	Lists activities associated with a deal.
`list-deal-files`	Lists files associated with a deal.
`list-deal-followers`	Lists the followers of a deal.
`list-deal-mail-messages`	Lists mail messages associated with a deal.
`list-deal-persons`	The endpoint lists every person linked to a deal, including primary contacts and participants, and provides a `data.marketing_status` field for users…
`list-deal-products`	Lists products attached to a deal.
`list-deal-updates`	Lists updates about a deal.
`list-deal-users`	Lists the users permitted to access a deal.
`list-files`	Lists all files uploaded to Pipedrive with optional filtering via pagination and sorting.
`list-organization-activities`	Lists activities associated with an organization.
`list-organization-deals`	Lists deals associated with an organization.
`list-organization-files`	Lists files associated with an organization.
`list-organization-followers`	Lists the followers of an organization.
`list-organization-mail-messages`	Lists mail messages associated with an organization.
`list-organization-persons`	Lists persons associated with an organization. If a company uses the [Campaigns…
`list-participants-of-deal`	Lists the participants associated with a deal. If a company uses the [Campaigns…
`list-permission-set-assignments`	Returns the list of assignments for a permission set. Notes: - This endpoint requires the `admin` OAuth scope. - OAuth calls must target the company…
`list-person-activities`	Lists activities associated with a person.
`list-person-deals`	Lists deals associated with a person.
`list-person-files`	Lists files associated with a person.
`list-person-followers`	Lists the followers of a person.
`list-person-mail-messages`	Lists mail messages associated with a person.
`list-person-products`	Lists products associated with a person.
`list-person-users`	List users permitted to access a person.
`list-product-files`	Lists files associated with a product.
`list-product-followers`	Lists the followers of a product.
`list-product-users`	Lists users permitted to access a product.
`list-role-assignments`	Returns all users assigned to a role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company domain with…
`list-role-pipeline-visibility`	Returns a list of visible or hidden pipeline IDs by role. See the “Visibility groups article” for details on pipeline visibility.
`list-role-settings`	Returns the visibility settings of a specific role. Notes: - Roles endpoints require the `admin` OAuth scope. - OAuth calls must target the company…
`list-updates-about-organization`	Lists updates about an organization.
`list-updates-about-person`	Lists updates about a person. If a company uses the Campaigns product, then this…
`list-updates-about-participants-of-deal`	This endpoint provides cursor-paginated updates on deal participants.
`list-user-followers`	Lists the followers of a specific user.
`list-user-permissions`	Lists aggregated permissions over all assigned permission sets for a user.
`list-user-role-assignments`	Lists role assignments for a user.
`list-user-role-settings`	Lists the settings of user’s assigned role.
`list-user-settings`	Lists the settings of an authorized user. Example response contains a shortened list of settings.
`merge-deals`	Tool to merge two deals in Pipedrive. Use when you need to consolidate two deals into one.
`merge-organizations`	Tool to merge two organizations in Pipedrive. Use when you need to consolidate two organizations into one.
`merge-persons`	Tool to merge two persons in Pipedrive. Use when you need to combine two person records into one.
`merge-two-deals`	Merges a deal with another deal. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/merging-two-deals”…
`merge-two-organizations`	Merges an organization with another organization. For more information, see the tutorial for <a…
`merge-two-persons`	Merges a person with another person. For more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/merging-two-persons”…
`organization-accessible-user-list`	List users permitted to access an organization.
`patch-deal-fields`	Updates an existing deal custom field using PATCH method. Use when you need to modify field properties like name, visibility, or validation rules.
`patch-organization-fields`	Tool to update an existing organization field in Pipedrive using the v2 API.
`patch-person-fields`	Tool to update person field configuration in Pipedrive. Use when you need to modify field properties like name, description, visibility settings, or requirement status.
`productfields-patch-productfields`	Tool to update a product custom field. Use when you need to modify field name, UI visibility, or description.
`refresh-tokens`	Access tokens expire after the time specified in `expires_in`.
`request-authorization`	Authorize a user by redirecting them to the Pipedrive OAuth authorization page and request their permissions to act on their behalf.
`search-deals`	This API endpoint searches deals by title, notes, and custom fields, filters results by person or organization ID, and is a specific use case of…
`search-item-by-field`	Performs a search from the values of a specific field. Results can either be the distinct values of the field (useful for searching autocomplete…
`search-leads`	Endpoint searches leads by title, notes, custom fields, with options to filter by person and organization IDs, and is a more specific use of the…
`search-multiple-item-types`	Performs a search from your choice of item types and fields.
`search-organizations`	Searches all organizations by name, address, notes and/or custom fields.
`search-persons`	This endpoint searches for individuals by various identifiers and is a specific use case of /v1/itemSearch with limited OAuth scope, allowing results…
`search-products`	Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a…
`tages-update-stage`	Tool to update an existing stage in Pipedrive. Use when you need to modify stage properties such as name, deal probability, or rotten deal settings.
`unlink-user-from-video-call-integration`	A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
`update-comment-related-to-note`	Updates a comment related to a note.
`update-activity`	Updates an activity. Includes `more_activities_scheduled_in_context` property in response’s `additional_data` which indicates whether there are more…
`update-activity-in-project-plan`	Updates an activity phase or group in a project.
`update-activity-type`	Updates an activity type.
`update-deal`	Tool to update an existing deal in Pipedrive. Use when you need to modify properties of a deal such as title, value, status, stage, or associated contacts/organizations.
`update-deal-field`	Tool to update a deal field in Pipedrive. Use when you need to modify existing deal field properties such as name, visibility, or options.
`update-filter`	Updates an existing filter.
`update-lead`	Tool to update a lead in Pipedrive. Use when you need to modify properties of an existing lead such as title, value, status, or linked contacts.
`update-lead-label`	Tool to update a lead label in Pipedrive. Use when you need to modify the name or color of an existing lead label.
`update-organization`	Tool to update an existing organization in Pipedrive. Use when you need to modify organization properties such as name, owner, visibility, labels, or address.
`update-organization-field`	Tool to update an organization field in Pipedrive. Use when you need to modify the name, options, or visibility of an existing organization field.
`update-organization-relationship`	Tool to update an organization relationship in Pipedrive. Use when you need to modify the type or organizations involved in an existing relationship…
`update-note`	Tool to update an existing note in Pipedrive. Use when you need to modify the content or properties of a note attached to deals, persons…
`update-person`	Tool to update a person’s properties in Pipedrive. Use when you need to modify existing person details such as name, contact information, owner, or organization.
`update-person-field`	Tool to update a person field in Pipedrive. Use when you need to modify the name, options, or visibility settings of an existing person field.
`update-pipeline`	Tool to update a pipeline in Pipedrive. Use when you need to modify pipeline properties like name, deal probability, order, or active status.
`update-product`	Tool to update a product in Pipedrive. Use when you need to modify product details like name, code, price, tax, or other attributes.
`update-product-field`	Tool to update a product field definition in Pipedrive. Use when you need to modify the name or options of an existing product custom field.
`update-comment-for-note`	Tool 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.
`update-deal-discount`	Tool 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.
`update-dealfields-options`	Tool to update existing options for a deal custom field atomically.
`update-deal-product`	Updates 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.
`update-deal-product-attachment`	Updates the details of the product that has been attached to a deal.
`update-deal-v2`	Tool to update an existing deal using Pipedrive v2 API. Use when you need to modify deal properties including custom fields, archive status, or deletion status.
`update-file`	Updates the properties of a file including its visible name and description.
`update-file-details`	Updates the properties of a file.
`update-goal`	Updates an existing goal. Note: For OAuth, Goals API is available under {companydomain}/api/v1.
`update-installment-subscription`	Updates an installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL.
`update-mail-thread`	Updates the properties of a mail thread.
`update-organization-field-options`	Tool to update existing options for an organization custom field atomically.
`update-personfields-options`	Tool to update existing options for a person custom field atomically.
`update-person-v2`	Tool to update a person’s properties in Pipedrive using the v2 API.
`update-pipeline-visibility-for-role`	Updates pipeline visibility settings for different roles. For details, see the Pipedrive Visibility groups article.
`update-productfields-options`	Tool to update existing options for a product custom field atomically.
`update-product-image`	Tool to update an image for a product in Pipedrive. Use when you need to add or replace a product image.
`update-product-variation`	Tool to update a product variation in Pipedrive. Use when you need to modify variation details like name or prices across different currencies.
`update-project`	Updates a project.
`update-recurring-subscription`	Updates a recurring subscription. Note: Some company hosts may not expose Subscriptions endpoints.
`update-role`	Updates the parent role and/or the name of a specific role. Notes: - Roles endpoints require the `admin` scope. - With OAuth (Bearer) tokens…
`update-role-pipelines`	Updates pipeline visibility for a role. Use when you need to control which sales pipelines are accessible to users within a particular role group.
`update-stage`	Tool to update stage details in Pipedrive. Use when you need to modify properties of an existing stage such as name, pipeline association, deal…
`update-stage-details`	Updates the properties of a stage.
`update-task`	Updates a task.
`update-task-in-project-plan`	Updates a task phase or group in a project.
`update-team`	Updates an existing team and returns the updated object.

Triggers (3)

Subscribe with .on(...) in a script. A trigger with required configuration takes it as the second argument.

Trigger	Needs	What fires it
New Deal Received Trigger	nothing	Triggered when a new deal is created in Pipedrive
New Note Received Trigger	nothing	Triggered when a new note is created in Pipedrive
New Organization Received Trigger	nothing	Triggered when a new organization is created in Pipedrive

Open Pipedrive in the console →

Getting started

Guides

Integrations and automations

Use cases

References

Connect it

Use it

Common tools

Triggers (3)

​Connect it

​Use it

​Common tools

​Triggers (3)

Connect it

Use it

Common tools

Triggers (3)