> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipedrive

> How to set up the Pipedrive connector, plus the actions and events that are available.

![Pipedrive](https://stackone-logos.com/api/pipedrive/filled/svg)

v1.3.2[See changelog](https://docs.stackone.com/connectors/pipedrive/changelog.md)

[132 actions](#actions) · [11 events](#events) · 2 auth methods

CRM
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/pipedrive/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an app in the Pipedrive Developer Hub.

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/pipedrive/guides/connector-profile/api-token.md)
>
> Best for personal scripts and single-account integrations. Quick to set up, no app registration needed.

Optionally, configure receiving Events for Pipedrive into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/pipedrive/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/pipedrive/guides/link-account/oauth-2-0.md)

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/pipedrive/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Token

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

activities:full

activities:read

admin

contacts:full

contacts:read

deals:full

deals:read

goals:full

goals:read

leads:full

leads:read

products:full

products:read

projects:full

projects:read

search:read

users:read

No scopes found

132 actions

ActionDescriptionRequired scopes

List Users`pipedrive_list_users`

Retrieve all users in the Pipedrive company account, including active and inactive team members

`users:read`

Get User`pipedrive_get_user`

Retrieve full profile details of a specific Pipedrive user by their numeric ID

`users:read`

Get Current User`pipedrive_get_current_user`

Retrieve the profile of the currently authenticated user — used as the credential test action

`users:read`

Find Users`pipedrive_find_users`

Search for Pipedrive users by name or email address to resolve user IDs

`users:read`

Add User`pipedrive_add_user`

Invite a new user to the Pipedrive company account by email with configurable app access

`admin`

Update User`pipedrive_update_user`

Activate or deactivate a Pipedrive user account — uses HTTP PUT and requires active\_flag in the body

`admin`

List Permission Sets`pipedrive_list_permission_sets`

Retrieve all permission sets to use when assigning role-based access levels to new or existing users

`users:read`

Get User Permissions`pipedrive_get_user_permissions`

Retrieve the full aggregated permission set for a specific user showing what they can access and modify

`users:read`

List Pipelines`pipedrive_list_pipelines`

Retrieve all sales pipelines in the Pipedrive account using cursor-based pagination

`deals:read`

Get Pipeline`pipedrive_get_pipeline`

Retrieve the full record of a single pipeline by its numeric ID, including name, active status, and deal probability set...

`deals:read`

Add Pipeline`pipedrive_add_pipeline`

Create a new named sales pipeline in Pipedrive with optional per-stage deal probability tracking

`deals:full`

Update Pipeline`pipedrive_update_pipeline`

Perform a partial update on an existing pipeline by ID — rename it or toggle deal probability tracking

`deals:full`

Delete Pipeline`pipedrive_delete_pipeline`

Permanently delete a pipeline by its ID — deals in the pipeline are not deleted but become unlinked from the pipeline

`deals:full`

Get Pipeline Conversion Rates`pipedrive_get_pipeline_conversion_rates`

Retrieve stage-by-stage deal conversion rate statistics for a pipeline over a specified date range to identify bottlenec...

`deals:read`

Get Pipeline Movement Statistics`pipedrive_get_pipeline_movement_stats`

Retrieve deal movement statistics for a pipeline over a date range — counts of new deals, stage moves, won deals, and lo...

`deals:read`

List Stages`pipedrive_list_stages`

Retrieve all pipeline stages in the Pipedrive account with optional filtering by pipeline ID

`deals:read`

Get Stage`pipedrive_get_stage`

Retrieve the full record of a single pipeline stage by its numeric ID, including pipeline assignment, deal probability,...

`deals:read`

Add Stage`pipedrive_add_stage`

Create a new stage in a pipeline with a name, optional deal probability, and optional deal rot detection

`deals:full`

Update Stage`pipedrive_update_stage`

Perform a partial update on an existing pipeline stage by ID — rename it, move it to another pipeline, or change its dea...

`deals:full`

Delete Stage`pipedrive_delete_stage`

Permanently delete a stage by its ID — deals in the stage are not deleted but become detached from the stage

`deals:full`

List Organizations`pipedrive_list_organizations`

Retrieve a paginated list of all organizations (companies/accounts) in Pipedrive with rich filtering by owner, update ti...

`contacts:read`

Get Organization`pipedrive_get_organization`

Retrieve the full record of a single organization by its numeric ID, including address, owner, visibility, and optional...

`contacts:read`

Add Organization`pipedrive_add_organization`

Create a new organization (company/account) record in Pipedrive, optionally setting address, owner, visibility, labels,...

`contacts:full`

Update Organization`pipedrive_update_organization`

Perform a partial update on an existing organization by ID using HTTP PATCH — only fields provided in the request body a...

`contacts:full`

Delete Organization`pipedrive_delete_organization`

Mark an organization as deleted by its ID — the record enters a 30-day grace period before permanent removal

`contacts:full`

Search Organizations`pipedrive_search_organizations`

Full-text search across organizations by name, address, notes, or custom fields using GET /api/v2/organizations/search

`contacts:read`

Merge Organizations`pipedrive_merge_organizations`

Permanently merge a source organization into a target organization — the source is deleted and all associated data is tr...

`contacts:full`

List Persons`pipedrive_list_persons`

Retrieve a paginated list of all persons (contacts) in Pipedrive with filtering by owner, organization, deal, and update...

`contacts:read`

Get Person`pipedrive_get_person`

Retrieve the full record of a single person (contact) by their numeric ID, including emails, phones, linked organization...

`contacts:read`

Add Person`pipedrive_add_person`

Create a new person (contact) record in Pipedrive with name, emails, phones, linked organization, and custom fields

`contacts:full`

Update Person`pipedrive_update_person`

Perform a partial update on an existing person by ID using HTTP PATCH — only fields provided in the request body are mod...

`contacts:full`

Delete Person`pipedrive_delete_person`

Mark a person as deleted by their ID — the record enters a 30-day grace period before permanent removal

`contacts:full`

Search Persons`pipedrive_search_persons`

Full-text search across persons by name, email, phone, notes, or custom fields using GET /api/v2/persons/search with opt...

`contacts:read`

Merge Persons`pipedrive_merge_persons`

Permanently merge a source person into a target person — the source is deleted and all associated data is transferred to...

`contacts:full`

List Deals`pipedrive_list_deals`

Retrieve a paginated list of all Pipedrive deals with rich filtering by owner, person, organization, pipeline, stage, st...

`deals:read`

Get Deal`pipedrive_get_deal`

Retrieve complete details of a single deal by ID, including value, pipeline position, linked contacts, and optional comp...

`deals:read`

Add Deal`pipedrive_add_deal`

Create a new sales deal in Pipedrive, optionally linking it to a person, organization, pipeline, and stage

`deals:full`

Update Deal`pipedrive_update_deal`

Perform a partial update on an existing deal by ID using HTTP PATCH — only fields provided in the request body are modif...

`deals:full`

Delete Deal`pipedrive_delete_deal`

Mark a deal as deleted by its ID — the deal enters a 30-day grace period before permanent removal

`deals:full`

Search Deals`pipedrive_search_deals`

Full-text search across deals by title, custom fields, or notes with optional filters for person, organization, and stat...

`deals:read`

List Deal Products`pipedrive_list_deal_products`

Retrieve all products attached to a specific deal, including per-product pricing, quantity, tax, discount, and variation...

`deals:read`

Add Product To Deal`pipedrive_add_deal_product`

Attach an existing product to a deal as a line item with a specified price, quantity, tax, and discount — the product mu...

`deals:full`

Duplicate Deal`pipedrive_duplicate_deal`

Create an exact copy of an existing deal in the same pipeline and stage — useful for creating similar deals quickly

`deals:full`

Merge Deals`pipedrive_merge_deals`

Permanently merge a source deal into a target deal — the source is deleted and all its associated data is transferred to...

`deals:full`

Get Deals Summary`pipedrive_get_deals_summary`

Retrieve aggregated deal totals and counts with optional filtering — identical to get\_deal\_summary but available as a st...

`deals:read`

List Products`pipedrive_list_products`

Retrieve a paginated list of products from the Pipedrive inventory with optional filtering by owner, IDs, and update tim...

`products:read`

Get Product`pipedrive_get_product`

Retrieve full details of a single product by its numeric ID, including pricing, tax, visibility, and custom fields

`products:read`

Add Product`pipedrive_add_product`

Add a new product to the Pipedrive product inventory with pricing, tax, visibility, and custom field support

`products:full`

Update Product`pipedrive_update_product`

Update one or more properties of an existing product by its numeric ID — only provided fields are changed

`products:full`

Delete Product`pipedrive_delete_product`

Soft-delete a product by its numeric ID — the product is recoverable for 30 days before permanent deletion

`products:full`

Search Products`pipedrive_search_products`

Full-text search for products by name, SKU code, or custom field values with optional exact matching

`products:read`

List Activities`pipedrive_list_activities`

Retrieve a paginated list of activities (calls, meetings, tasks, emails) with filtering by owner, deal, person, lead, or...

`activities:read`

Get Activity`pipedrive_get_activity`

Retrieve full details of a single activity by its numeric ID, including type, due date, participants, and linked entitie...

`activities:read`

Add Activity`pipedrive_add_activity`

Create a new activity (call, meeting, task, email, etc.) in Pipedrive and optionally link it to a deal, lead, person, or...

`activities:full`

Update Activity`pipedrive_update_activity`

Update one or more properties of an existing activity by its numeric ID — only provided fields are changed

`activities:full`

Delete Activity`pipedrive_delete_activity`

Soft-delete an activity by its numeric ID — the activity is recoverable for 30 days before permanent deletion

`activities:full`

List Activity Types`pipedrive_list_activity_types`

Retrieve all activity type definitions (call, meeting, task, email, etc.) — use the key values when creating activities

`activities:read`

Add Activity Type`pipedrive_add_activity_type`

Create a new custom activity type with a name, icon, and optional color to categorize activities

`admin`

List Leads`pipedrive_list_leads`

Retrieve a paginated list of non-archived leads with optional filtering by owner, person, organization, or filter ID

`leads:read`

Get Lead`pipedrive_get_lead`

Retrieve full details of a single lead by its UUID, including value, expected close date, labels, and linked contact

`leads:read`

Add Lead`pipedrive_add_lead`

Create a new unqualified sales lead linked to a person or organization, before it enters a sales pipeline as a deal

`leads:full`

Update Lead`pipedrive_update_lead`

Update one or more properties of an existing lead by its UUID — only provided fields are changed

`leads:full`

Delete Lead`pipedrive_delete_lead`

Permanently and immediately delete a lead by its UUID — this cannot be undone

`leads:full`

Search Leads`pipedrive_search_leads`

Full-text search for leads by title, notes, or custom field values with optional filtering by linked person or organizat...

`leads:read`

List Lead Labels`pipedrive_list_lead_labels`

Retrieve all lead label definitions (hot, warm, cold, and custom) — use the returned UUIDs in add\_lead and update\_lead

`leads:read`

List Lead Sources`pipedrive_list_lead_sources`

Retrieve all predefined lead source types to understand how leads entered the Pipedrive system

`leads:read`

List Notes`pipedrive_list_notes`

Retrieve a paginated list of notes with filtering by linked entity (deal, person, org, lead), author, date range, and pi...

`deals:read`

Get Note`pipedrive_get_note`

Retrieve the full content and metadata of a specific note by its numeric ID

`deals:read`

Add Note`pipedrive_add_note`

Create a new HTML note and attach it to a deal, person, organization, or lead with optional pinning

`deals:full`

Update Note`pipedrive_update_note`

Update an existing note's content, linked entities, pin status, or author — uses HTTP PUT but omitted fields are preserv...

`deals:full`

Delete Note`pipedrive_delete_note`

Soft-delete a note by its numeric ID — the note is hidden but remains fetchable with active\_flag=false

`deals:full`

List Projects`pipedrive_list_projects`

Retrieve all projects in Pipedrive with optional filtering by status or phase — requires Pipedrive Professional plan or...

`projects:read`

Get Project`pipedrive_get_project`

Retrieve the full record of a single project by its numeric ID — requires Pipedrive Professional plan or higher

`projects:read`

Add Project`pipedrive_add_project`

Create a new project in Pipedrive with title, board, phase, status, linked deals/person/organization, and template — req...

`projects:full`

Update Project`pipedrive_update_project`

Update properties of an existing project by ID — only fields provided are modified — requires Pipedrive Professional pla...

`projects:full`

Delete Project`pipedrive_delete_project`

Permanently delete a project by its ID — requires Pipedrive Professional plan or higher

`projects:full`

List Filters`pipedrive_list_filters`

Retrieve all saved Pipedrive filters with optional filtering by entity type (deals, leads, persons, organizations, produ...

`deals:read`

Get Filter`pipedrive_get_filter`

Retrieve the full definition of a single saved filter by its ID, including the nested condition logic

`deals:read`

Add Filter`pipedrive_add_filter`

Create a new saved filter with AND/OR condition logic to reuse in list\_deals, list\_persons, list\_organizations, and othe...

`deals:full`

Update Filter`pipedrive_update_filter`

Update an existing saved filter's name or conditions — the conditions object is required even when only updating the nam...

`deals:full`

Delete Filter`pipedrive_delete_filter`

Permanently delete a saved filter by its ID — any list actions currently using this filter\_id will no longer be able to...

`deals:full`

Find Goals`pipedrive_get_goals`

Search for goals using type, title, assignee, active status, expected outcome, or date period filters

`goals:read`

Get Goal Results`pipedrive_get_goal_results`

Retrieve actual vs expected progress results for a specific goal within a date period

`goals:read`

Add Goal`pipedrive_add_goal`

Create a new sales or activity goal with an assignee, type, target metric, duration, and tracking interval — Pipedrive a...

`goals:full`

Update Goal`pipedrive_update_goal`

Update an existing goal's title, assignee, type, expected outcome, duration, or interval — uses HTTP PUT; include all fi...

`goals:full`

Delete Goal`pipedrive_delete_goal`

Permanently delete a goal by its ID — this also removes the associated goal progress report

`goals:full`

List Roles`pipedrive_list_roles`

Retrieve all user roles within the Pipedrive company account — roles define permissions and data visibility for users

`admin`

Get Role`pipedrive_get_role`

Retrieve the full record of a single user role by its numeric ID, including its name and parent role relationship

`admin`

Add Role`pipedrive_add_role`

Create a new user role in Pipedrive with an optional parent role for hierarchical permission structures — requires admin...

`admin`

Update Role`pipedrive_update_role`

Update an existing role's name or parent role assignment — uses HTTP PUT; include all fields you want to preserve

`admin`

Delete Role`pipedrive_delete_role`

Permanently delete a role by its ID — users assigned to the deleted role are automatically reassigned to the default rol...

`admin`

List Webhooks`pipedrive_list_webhooks`

Retrieve all configured webhook subscriptions for the Pipedrive company account — requires admin scope

`admin`

Create Webhook`pipedrive_create_webhook`

Create a new webhook subscription to receive real-time event notifications at a public URL when Pipedrive records are cr...

`admin`

Delete Webhook`pipedrive_delete_webhook`

Permanently delete a webhook subscription by its ID — Pipedrive will immediately stop sending events to the subscription...

`admin`

List Deal Fields`pipedrive_list_deal_fields`

Retrieve all deal field definitions (standard and custom) to understand deal schema and discover custom field hash keys

`deals:read`

Get Deal Field`pipedrive_get_deal_field`

Retrieve the full metadata of a single deal field by its field code, including type, options, and key

`deals:read`

Add Deal Field`pipedrive_add_deal_field`

Create a new custom field on deal records to capture additional deal-specific data

`deals:full`

Update Deal Field`pipedrive_update_deal_field`

Rename an existing custom deal field — field type and field code cannot be changed after creation

`deals:full`

Delete Deal Field`pipedrive_delete_deal_field`

Permanently delete a custom deal field by its field code — standard system fields cannot be deleted

`deals:full`

List Person Fields`pipedrive_list_person_fields`

Retrieve all person field definitions (standard and custom) to understand the contact schema and discover custom field h...

`contacts:read`

Get Person Field`pipedrive_get_person_field`

Retrieve the full metadata of a single person field by its field code, including type, options, and UI visibility

`contacts:read`

Add Person Field`pipedrive_add_person_field`

Create a new custom field on person (contact) records to capture additional contact-specific data

`contacts:full`

Update Person Field`pipedrive_update_person_field`

Rename an existing custom person field or update its UI visibility settings — field type and field code are immutable

`contacts:full`

Delete Person Field`pipedrive_delete_person_field`

Permanently delete a custom person field by its field code — standard system fields cannot be deleted

`contacts:full`

List Organization Fields`pipedrive_list_organization_fields`

Retrieve all organization field definitions (standard and custom) to understand the organization schema and discover cus...

`contacts:read`

Get Organization Field`pipedrive_get_organization_field`

Retrieve the full metadata of a single organization field by its field code, including type, options, and UI visibility

`contacts:read`

Add Organization Field`pipedrive_add_organization_field`

Create a new custom field on organization records to capture additional company-specific data

`contacts:full`

Update Organization Field`pipedrive_update_organization_field`

Rename an existing custom organization field or update its UI visibility settings

`contacts:full`

Delete Organization Field`pipedrive_delete_organization_field`

Permanently delete a custom organization field by its field code — standard system fields cannot be deleted

`contacts:full`

List Product Fields`pipedrive_list_product_fields`

Retrieve all product field definitions (standard and custom) to discover field keys, category IDs, and enum options

`products:read`

Get Product Field`pipedrive_get_product_field`

Retrieve the full metadata of a single product field by its field code, including type, options, and optional UI visibil...

`products:read`

Add Product Field`pipedrive_add_product_field`

Create a new custom field on product records to capture additional product-specific attributes

`products:full`

Update Product Field`pipedrive_update_product_field`

Rename an existing custom product field or update its add product modal visibility — field type and code are immutable

`products:full`

Delete Product Field`pipedrive_delete_product_field`

Permanently delete a custom product field by its field code — standard system fields cannot be deleted

`products:full`

List Files`pipedrive_list_files`

Retrieve all files attached to Pipedrive records (deals, persons, organizations, products, notes, activities) using offs...

`deals:read`

Get File`pipedrive_get_file`

Retrieve full metadata of a specific file by its ID, including name, size, MIME type, associated entity, and download UR...

`deals:read`

Add File`pipedrive_add_file`

Upload a file to Pipedrive and optionally associate it with a deal, person, organization, product, activity, lead, or pr...

`deals:full`

Update File Details`pipedrive_update_file`

Update the visible name or description of an existing file — does not modify the file content itself

`deals:full`

Delete File`pipedrive_delete_file`

Mark a file as deleted by its ID — the file enters a 30-day grace period before permanent removal and is unlinked from i...

`deals:full`

Search Items`pipedrive_search_items`

Perform a global full-text search across all Pipedrive record types — deals, persons, organizations, products, leads, fi...

`search:read`

Search Items By Field`pipedrive_search_items_by_field`

Search within a specific entity type by a specific field value — useful for field-level lookups and autocomplete functio...

`search:read`

Get Unified Credentials`pipedrive_unified_get_me`

Get the current Pipedrive connection's unified credentials and identity.

`users:read`

List Unified Groups`pipedrive_unified_list_groups`

List unified groups in Pipedrive.

`admin``users:read`

Get Unified Group`pipedrive_unified_get_group`

Get a unified Pipedrive group by ID.

`admin``users:read`

List Unified Organizations`pipedrive_unified_list_organizations`

List unified organizations in Pipedrive.

`users:read`

Get Unified Organization`pipedrive_unified_get_organization`

Get a unified Pipedrive organization by ID.

`users:read`

List Unified Resource Types`pipedrive_unified_list_resource_types`

List unified resource types in Pipedrive.

`admin`

List Unified Resource Users`pipedrive_unified_list_resource_users`

List unified resource users in Pipedrive.

`admin``users:read`

List Unified Roles`pipedrive_unified_list_roles`

List unified roles in Pipedrive.

`users:read`

Get Unified Role`pipedrive_unified_get_role`

Get a unified Pipedrive role by ID.

`users:read`

List Unified Users`pipedrive_unified_list_users`

List unified users in Pipedrive.

`users:read`

Get Unified User`pipedrive_unified_get_user`

Get a unified Pipedrive user by ID.

`users:read`

## Events

Tags

Select all
|
Clear

Activities

Deals

Leads

Notes

Organizations

Persons

Pipelines

Products

Projects

Stages

Users

Webhooks

No tags found

11 events

EventDescriptionTags

Activity Events Webhook`pipedrive_webhook_activity`

Processes Pipedrive activity events (create.activity, change.activity, delete.activity), emitted whenever an activity is...

ActivitiesWebhooks

Deal Events Webhook`pipedrive_webhook_deal`

Processes Pipedrive deal events (create.deal, change.deal, delete.deal), emitted whenever a deal is created, changed (in...

DealsWebhooks

Lead Events Webhook`pipedrive_webhook_lead`

Processes Pipedrive lead events (create.lead, change.lead, delete.lead), emitted whenever a lead is created, changed, or...

LeadsWebhooks

Note Events Webhook`pipedrive_webhook_note`

Processes Pipedrive note events (create.note, change.note, delete.note), emitted whenever a note is created, changed, or...

NotesWebhooks

Organization Events Webhook`pipedrive_webhook_organization`

Processes Pipedrive organization events (create.organization, change.organization, delete.organization), emitted wheneve...

OrganizationsWebhooks

Person Events Webhook`pipedrive_webhook_person`

Processes Pipedrive person events (create.person, change.person, delete.person), emitted whenever a person contact is cr...

PersonsWebhooks

Pipeline Events Webhook`pipedrive_webhook_pipeline`

Processes Pipedrive pipeline events (create.pipeline, change.pipeline, delete.pipeline), emitted whenever a sales pipeli...

PipelinesWebhooks

Product Events Webhook`pipedrive_webhook_product`

Processes Pipedrive product events (create.product, change.product, delete.product), emitted whenever a product is creat...

ProductsWebhooks

Project Events Webhook`pipedrive_webhook_project`

Processes Pipedrive project events (create.project, change.project, delete.project), emitted whenever a project is creat...

ProjectsWebhooks

Stage Events Webhook`pipedrive_webhook_stage`

Processes Pipedrive stage events (create.stage, change.stage, delete.stage), emitted whenever a pipeline stage is create...

StagesWebhooks

User Events Webhook`pipedrive_webhook_user`

Processes Pipedrive user events (create.user, change.user), emitted whenever a company user is added or changed. Pipedri...

UsersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.