# Pipedrive

Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing

- **Category:** crm
- **Auth:** OAUTH2, API_KEY
- **Tools:** 430
- **Triggers:** 3
- **Slug:** `PIPEDRIVE`
- **Version:** 20260217_00

## Frequently Asked Questions

### How do I set up custom OAuth credentials for Pipedrive?

For a step-by-step guide on creating and configuring your own Pipedrive OAuth credentials with Devcaster, see [How to create OAuth credentials for Pipedrive](https://devcaster.dev/auth/pipedrive).

### Why am I seeing "App not found" when connecting Pipedrive?

Devcaster's default Pipedrive OAuth credentials may have expired. Use your own OAuth app credentials until the default is restored.

---

## Tools

### Add a call log

**Slug:** `PIPEDRIVE_ADD_A_CALL_LOG`

Adds a new call log.

### Add a channel

**Slug:** `PIPEDRIVE_ADD_A_CHANNEL`

New messaging channel added; registration limited to admins. Utilizes getConversations endpoint for data retrieval. Requires Messengers integration OAuth scope and a prepared Messaging app extension manifest.

### Add a comment to a note

**Slug:** `PIPEDRIVE_ADD_A_COMMENT_TO_A_NOTE`

Adds a new comment to a note.

### Add a deal

**Slug:** `PIPEDRIVE_ADD_A_DEAL`

Add a new deal to Pipedrive with any custom fields, which vary by account and are identified by long hash keys. Check dealFields for existing custom fields. For details, visit the tutorial on adding a deal.

### Add a follower to a deal

**Slug:** `PIPEDRIVE_ADD_A_FOLLOWER_TO_A_DEAL`

Adds a follower to a deal.

### Add a follower to an organization

**Slug:** `PIPEDRIVE_ADD_A_FOLLOWER_TO_AN_ORGANIZATION`

Adds a follower to an organization.

### Add a follower to a person

**Slug:** `PIPEDRIVE_ADD_A_FOLLOWER_TO_A_PERSON`

Adds a follower to a person.

### Add a follower to a product

**Slug:** `PIPEDRIVE_ADD_A_FOLLOWER_TO_A_PRODUCT`

Adds a follower to a product.

### Add a lead

**Slug:** `PIPEDRIVE_ADD_A_LEAD`

Pipedrive API lets you add leads linked to people or organizations and tags them with 'API' source. Custom fields from deals apply to leads and appear in responses if set. Details are in the tutorials for adding and updating leads.

### Add a lead label

**Slug:** `PIPEDRIVE_ADD_A_LEAD_LABEL`

Creates a lead label.

### Add an activity

**Slug:** `PIPEDRIVE_ADD_AN_ACTIVITY`

New activity added. Response includes `more_activities_scheduled_in_context` to show if more are planned with the same entity. See tutorial on adding activities [here](https://pipedrive.readme.io/docs/adding-an-activity).

### Add a new deal field

**Slug:** `PIPEDRIVE_ADD_A_NEW_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" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

### Add a new filter

**Slug:** `PIPEDRIVE_ADD_A_NEW_FILTER`

New 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.

### Add a new goal

**Slug:** `PIPEDRIVE_ADD_A_NEW_GOAL`

Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.

### Add a new organization field

**Slug:** `PIPEDRIVE_ADD_A_NEW_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" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

### Add a new person field

**Slug:** `PIPEDRIVE_ADD_A_NEW_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" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

### Add a new pipeline

**Slug:** `PIPEDRIVE_ADD_A_NEW_PIPELINE`

Adds a new pipeline (v2).

### Add a new product field

**Slug:** `PIPEDRIVE_ADD_A_NEW_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" target="_blank" rel="noopener noreferrer">adding a new custom field</a>.

### Add a new stage

**Slug:** `PIPEDRIVE_ADD_A_NEW_STAGE`

Adds a new stage, returns the ID upon success.

### Add a new team

**Slug:** `PIPEDRIVE_ADD_A_NEW_TEAM`

Adds a new team to the company and returns the created object.

### Add a new user

**Slug:** `PIPEDRIVE_ADD_A_NEW_USER`

Adds a new user to the company, returns the ID upon success.

### Add an installment subscription

**Slug:** `PIPEDRIVE_ADD_AN_INSTALLMENT_SUBSCRIPTION`

Adds a new installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action overrides the default request behavior and uses the public API host (api.pipedrive.com) explicitly.

### Add an organization

**Slug:** `PIPEDRIVE_ADD_AN_ORGANIZATION`

Creates a new organization in Pipedrive. The 'name' parameter is required and represents the organization's name (e.g., 'Acme Corp'). Optionally specify 'owner_id' to assign an owner and 'visible_to' for visibility settings. Custom fields can also be added using field keys from organizationFields.

### Add a note

**Slug:** `PIPEDRIVE_ADD_A_NOTE`

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.

### Add a participant to a deal

**Slug:** `PIPEDRIVE_ADD_A_PARTICIPANT_TO_A_DEAL`

Adds a participant to a deal.

### Add a person

**Slug:** `PIPEDRIVE_ADD_A_PERSON`

Add a new contact in Pipedrive with optional custom fields unique to each account found using the `personFields` endpoint. The endpoint also handles `data.marketing_status` for Campaigns product users.

### Add a product

**Slug:** `PIPEDRIVE_ADD_A_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" target="_blank" rel="noopener noreferrer">adding a product</a>.

### Add a product to a deal

**Slug:** `PIPEDRIVE_ADD_A_PRODUCT_TO_A_DEAL`

Adds a product to a deal, creating a new item called a deal-product.

### Add a project

**Slug:** `PIPEDRIVE_ADD_A_PROJECT`

Adds a new project. Note that you can supply additional custom fields along with the request that are not described here. These custom fields are different for each Pipedrive account and can be recognized by long hashes as keys.

### Add a recurring subscription

**Slug:** `PIPEDRIVE_ADD_A_RECURRING_SUBSCRIPTION`

Adds a new recurring subscription.

### Add a role

**Slug:** `PIPEDRIVE_ADD_A_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. Example: https://{COMPANY}.pipedrive.com/api/v1/roles - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used.

### Add a task

**Slug:** `PIPEDRIVE_ADD_A_TASK`

Adds a new task.

### Add Call Log Audio File

**Slug:** `PIPEDRIVE_ADD_CALL_LOG_AUDIO_FILE`

Tool 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.

### Add participant to deal

**Slug:** `PIPEDRIVE_ADD_DEAL_PARTICIPANT`

Tool to add a participant to a deal in Pipedrive. Use when you need to associate a person with a deal as a participant.

### Add product to deal

**Slug:** `PIPEDRIVE_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, discount, and tax settings.

### Add file

**Slug:** `PIPEDRIVE_ADD_FILE`

Upload and link files to deals, people, organizations, activities, products, or leads in Pipedrive. See the "adding a file" tutorial for details.

### Add new activity type

**Slug:** `PIPEDRIVE_ADD_NEW_ACTIVITY_TYPE`

Adds a new activity type.

### Add Note

**Slug:** `PIPEDRIVE_ADD_NOTE`

Tool 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.

### Add comment to note

**Slug:** `PIPEDRIVE_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 Options

**Slug:** `PIPEDRIVE_ADD_ORGANIZATION_FIELD_OPTIONS`

Tool 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.

### Add organization follower

**Slug:** `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

**Slug:** `PIPEDRIVE_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 domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the base URL accordingly.

### Add a follower to a person

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_ADD_PERSON_PICTURE`

This service allows adding a photo to a person's profile, replacing any existing one. Images must be square with a minimum size of 128 pixels and in GIF, JPG, or PNG formats. They will be resized to 128 and 512 pixels.

### Add follower to product

**Slug:** `PIPEDRIVE_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 role assignment

**Slug:** `PIPEDRIVE_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, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/assignments - This action normalizes the base URL accordingly and ensures JSON body is sent.

### Add users to a team

**Slug:** `PIPEDRIVE_ADD_USERS_TO_A_TEAM`

Adds users to an existing team.

### Archive a project

**Slug:** `PIPEDRIVE_ARCHIVE_A_PROJECT`

Archives a project.

### Attach an audio file to the call log

**Slug:** `PIPEDRIVE_ATTACH_AN_AUDIO_FILE_TO_THE_CALL_LOG`

Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.

### Cancel a recurring subscription

**Slug:** `PIPEDRIVE_CANCEL_A_RECURRING_SUBSCRIPTION`

Cancels a recurring subscription. This action attempts to cancel a recurring subscription via Subscriptions API. If Subscriptions endpoints are unavailable (404), it gracefully falls back to disabling all product attachments on the given deal (interpreting `id` as `deal_id`) to mimic cancellation behavior.

### Create a new webhook

**Slug:** `PIPEDRIVE_CREATE_A_NEW_WEBHOOK`

Creates and returns details of a new Webhook. Trigger events combine `event_action` and `event_object`, like `*.*` for all events or `added.deal`, `deleted.persons` for specific actions. More info in the Webhooks guide.

### Create an organization relationship

**Slug:** `PIPEDRIVE_CREATE_AN_ORGANIZATION_RELATIONSHIP`

Creates and returns an organization relationship.

### Create a remote file and link it to an item

**Slug:** `PIPEDRIVE_CREATE_A_REMOTE_FILE_AND_LINK_IT_TO_AN_ITEM`

Creates an empty file on Google Drive linked to an item. For details, refer to the Pipedrive remote file adding tutorial.

### Get all ActivityFields

**Slug:** `PIPEDRIVE_CTIVITYIELDS_GET_ALL_ACTIVITYFIELDS`

Tool 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.

### Convert deal to lead

**Slug:** `PIPEDRIVE_DEALS_CONVERT_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 like notes, files, emails, and activities. Requires global admin or 'Convert deals to leads' permission.

### Delete deal

**Slug:** `PIPEDRIVE_DEALS_DELETE_DEAL`

Tool to delete a deal in Pipedrive. Use when you need to permanently remove a deal from the system.

### Delete deal

**Slug:** `PIPEDRIVE_DEALS_DELETE_DEAL_V2`

Tool to delete a deal in Pipedrive by marking it as deleted. Use when you need to remove a deal from the system. The deal will be permanently removed after 30 days.

### Get Deals Products

**Slug:** `PIPEDRIVE_DEALS_GET_DEALS_PRODUCTS`

Tool to retrieve products attached to specified deals (max 100 deals per request). Use when you need to get all products associated with multiple deals.

### Bulk add products to deal

**Slug:** `PIPEDRIVE_DEALS_POST_DEALS`

Tool to bulk add products to a Pipedrive deal. Use when attaching multiple products simultaneously, with maximum 100 products per request.

### Update deal product

**Slug:** `PIPEDRIVE_DEALS_UPDATE_DEAL`

Tool 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.

### Delete a call log

**Slug:** `PIPEDRIVE_DELETE_A_CALL_LOG`

Deletes 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.

### Delete a channel

**Slug:** `PIPEDRIVE_DELETE_A_CHANNEL`

The endpoint removes a messenger channel along with conversations and messages. Requires Messengers integration OAuth and Messaging app extension manifest.

### Delete a comment related to a note

**Slug:** `PIPEDRIVE_DELETE_A_COMMENT_RELATED_TO_A_NOTE`

Deletes a comment.

### Delete a conversation

**Slug:** `PIPEDRIVE_DELETE_A_CONVERSATION`

Deletes an existing conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

### Delete Activity

**Slug:** `PIPEDRIVE_DELETE_ACTIVITY`

Tool to delete an activity in Pipedrive. Use when you need to remove an activity. This is a soft delete operation - the activity will be permanently deleted after 30 days.

### Delete Activity Type

**Slug:** `PIPEDRIVE_DELETE_ACTIVITY_TYPE`

Tool to delete an activity type in Pipedrive. Use when you need to remove an activity type from the system. The activity type will be marked as deleted (active_flag set to false) rather than permanently removed.

### Delete a deal

**Slug:** `PIPEDRIVE_DELETE_A_DEAL`

Marks a deal as deleted. After 30 days, the deal will be permanently deleted.

### Delete a deal field

**Slug:** `PIPEDRIVE_DELETE_A_DEAL_FIELD`

Marks 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>.

### Delete a file

**Slug:** `PIPEDRIVE_DELETE_A_FILE`

Marks a file as deleted. After 30 days, the file will be permanently deleted.

### Delete a filter

**Slug:** `PIPEDRIVE_DELETE_A_FILTER`

Marks a filter as deleted.

### Delete a follower from a deal

**Slug:** `PIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_DEAL`

Deletes a follower from a deal.

### Delete a follower from an organization

**Slug:** `PIPEDRIVE_DELETE_A_FOLLOWER_FROM_AN_ORGANIZATION`

Deletes a follower from an organization. You can retrieve the `follower_id` from the <a href="https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationFollowers">List followers of an organization</a> endpoint.

### Delete a follower from a person

**Slug:** `PIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_PERSON`

Deletes a follower from a person.

### Delete a follower from a product

**Slug:** `PIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_PRODUCT`

Deletes a follower from a product.

### Delete a lead

**Slug:** `PIPEDRIVE_DELETE_A_LEAD`

Deletes a specific lead.

### Delete a lead label

**Slug:** `PIPEDRIVE_DELETE_A_LEAD_LABEL`

Deletes a specific lead label.

### Delete an activity

**Slug:** `PIPEDRIVE_DELETE_AN_ACTIVITY`

Marks an activity as deleted. After 30 days, the activity will be permanently deleted.

### Delete an activity type

**Slug:** `PIPEDRIVE_DELETE_AN_ACTIVITY_TYPE`

Marks an activity type as deleted.

### Delete an attached product from a deal

**Slug:** `PIPEDRIVE_DELETE_AN_ATTACHED_PRODUCT_FROM_A_DEAL`

Deletes a product attachment from a deal, using the `product_attachment_id`.

### Delete an organization

**Slug:** `PIPEDRIVE_DELETE_AN_ORGANIZATION`

Marks an organization as deleted. After 30 days, the organization will be permanently deleted.

### Delete an organization field

**Slug:** `PIPEDRIVE_DELETE_AN_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" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.

### Delete an organization relationship

**Slug:** `PIPEDRIVE_DELETE_AN_ORGANIZATION_RELATIONSHIP`

Deletes an organization relationship and returns the deleted ID.

### Delete a note

**Slug:** `PIPEDRIVE_DELETE_A_NOTE`

Deletes a specific note.

### Delete a participant from a deal

**Slug:** `PIPEDRIVE_DELETE_A_PARTICIPANT_FROM_A_DEAL`

Deletes a participant from a deal.

### Delete a person

**Slug:** `PIPEDRIVE_DELETE_A_PERSON`

Marks a person as deleted. After 30 days, the person will be permanently deleted.

### Delete a person field

**Slug:** `PIPEDRIVE_DELETE_A_PERSON_FIELD`

Marks 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>.

### Delete a pipeline

**Slug:** `PIPEDRIVE_DELETE_A_PIPELINE`

Marks a pipeline as deleted.

### Delete a product

**Slug:** `PIPEDRIVE_DELETE_A_PRODUCT`

Marks a product as deleted. After 30 days, the product will be permanently deleted.

### Delete a product field

**Slug:** `PIPEDRIVE_DELETE_A_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" target="_blank" rel="noopener noreferrer">deleting a custom field</a>.

### Delete a project

**Slug:** `PIPEDRIVE_DELETE_A_PROJECT`

Marks a project as deleted.

### Delete a role

**Slug:** `PIPEDRIVE_DELETE_A_ROLE`

Marks a role as deleted. Note: This endpoint requires admin permissions. The API token must have the 'admin' scope to delete roles. The default role (ID=1) cannot be deleted.

### Delete a role assignment

**Slug:** `PIPEDRIVE_DELETE_A_ROLE_ASSIGNMENT`

Removes the assigned user from a role and adds to the default role.

### Delete a stage

**Slug:** `PIPEDRIVE_DELETE_A_STAGE`

Marks a stage as deleted. Uses the company-domain v2 endpoint.

### Delete a subscription

**Slug:** `PIPEDRIVE_DELETE_A_SUBSCRIPTION`

Marks an installment or a recurring subscription as deleted.

### Delete a task

**Slug:** `PIPEDRIVE_DELETE_A_TASK`

Marks a task as deleted. If the task has subtasks then those will also be deleted.

### Delete comment from note

**Slug:** `PIPEDRIVE_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. Users can only delete comments they created or if they have admin privileges.

### Delete Deal

**Slug:** `PIPEDRIVE_DELETE_DEAL`

Tool to delete a deal in Pipedrive. Use when you need to remove a deal. This is a soft delete operation - the deal will be permanently deleted after 30 days.

### Delete a deal field

**Slug:** `PIPEDRIVE_DELETE_DEAL_FIELD`

Tool to delete a deal field in Pipedrive by marking it as deleted. Use when you need to remove a custom deal field.

### Delete deal field options

**Slug:** `PIPEDRIVE_DELETE_DEALFIELDS_OPTIONS`

Tool to remove existing options from a deal custom field atomically. Use when you need to delete options from a deal field.

### Delete deal follower

**Slug:** `PIPEDRIVE_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 Product

**Slug:** `PIPEDRIVE_DELETE_DEAL_PRODUCT`

Tool 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.

### Delete existing goal

**Slug:** `PIPEDRIVE_DELETE_EXISTING_GOAL`

Marks 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.

### Delete existing webhook

**Slug:** `PIPEDRIVE_DELETE_EXISTING_WEBHOOK`

Deletes the specified Webhook.

### Delete a file

**Slug:** `PIPEDRIVE_DELETE_FILE`

Tool to delete a file in Pipedrive. Use when you need to remove a file from the system. The file is marked as deleted immediately but will be permanently deleted after 30 days.

### Delete Pipedrive Filter

**Slug:** `PIPEDRIVE_DELETE_FILTER`

Tool to delete a filter in Pipedrive. Use when you need to remove a specific filter by its ID.

### Delete lead label

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_DELETE_MAIL_THREAD`

Marks a mail thread as deleted.

### Delete multiple activities in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_ACTIVITIES_IN_BULK`

Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.

### Delete multiple activity types in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_ACTIVITY_TYPES_IN_BULK`

Marks multiple activity types as deleted.

### Delete multiple deal fields in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_DEAL_FIELDS_IN_BULK`

Marks multiple deal fields as deleted.

### Delete multiple deals in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_DEALS_IN_BULK`

Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.

### Delete multiple filters in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_FILTERS_IN_BULK`

Marks multiple filters as deleted.

### Delete multiple organization fields in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_ORGANIZATION_FIELDS_IN_BULK`

Marks multiple fields as deleted.

### Delete multiple organizations in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_ORGANIZATIONS_IN_BULK`

Marks multiple organizations as deleted. After 30 days, the organizations will be permanently deleted.

### Delete multiple person fields in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_PERSON_FIELDS_IN_BULK`

Marks multiple fields as deleted.

### Delete multiple persons in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_PERSONS_IN_BULK`

Marks multiple persons as deleted. After 30 days, the persons will be permanently deleted.

### Delete multiple product fields in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_PRODUCT_FIELDS_IN_BULK`

Marks multiple fields as deleted.

### Delete multiple stages in bulk

**Slug:** `PIPEDRIVE_DELETE_MULTIPLE_STAGES_IN_BULK`

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 an organization

**Slug:** `PIPEDRIVE_DELETE_ORGANIZATION`

Tool to delete an organization in Pipedrive. Use when you need to mark an organization as deleted. The organization will be permanently deleted after 30 days.

### Delete organization field options

**Slug:** `PIPEDRIVE_DELETE_ORGANIZATION_FIELD_OPTIONS`

Tool 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.

### Delete organization follower

**Slug:** `PIPEDRIVE_DELETE_ORGANIZATION_FOLLOWER`

Tool to delete a follower from an organization in Pipedrive. Use when you need to remove a user from an organization's follower list.

### Delete a person

**Slug:** `PIPEDRIVE_DELETE_PERSON`

Tool to delete a person in Pipedrive. Use when you need to mark a person as deleted. The person will be permanently deleted after 30 days.

### Delete a person field

**Slug:** `PIPEDRIVE_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 person field options

**Slug:** `PIPEDRIVE_DELETE_PERSONFIELDS_OPTIONS`

Tool to remove existing options from a person custom field atomically. Use when you need to delete options from a person field.

### Delete person picture

**Slug:** `PIPEDRIVE_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. Since delete is idempotent, we treat this specific case as a successful no-op and return a normalized response rather than raising.

### Delete product field options

**Slug:** `PIPEDRIVE_DELETE_PRODUCTFIELDS_OPTIONS`

Tool to remove existing options from a product custom field atomically. Use when you need to delete options from a product field.

### Delete a stage

**Slug:** `PIPEDRIVE_DELETE_STAGE`

Tool to delete a stage in Pipedrive. Use when you need to mark a stage as deleted.

### Delete users from a team

**Slug:** `PIPEDRIVE_DELETE_USERS_FROM_A_TEAM`

Deletes users from an existing team.

### Delete existing webhook

**Slug:** `PIPEDRIVE_DELETE_WEBHOOK`

Tool to delete an existing webhook from Pipedrive. Use when you need to remove a webhook configuration.

### Download one file

**Slug:** `PIPEDRIVE_DOWNLOAD_ONE_FILE`

Initializes a file download.

### Duplicate deal

**Slug:** `PIPEDRIVE_DUPLICATE_DEAL`

Duplicates a deal.

### Enumerate accessible users for lead

**Slug:** `PIPEDRIVE_ENUMERATE_ACCESSIBLE_USERS_FOR_LEAD`

Lists the users permitted to access a lead.

### Find goals

**Slug:** `PIPEDRIVE_FIND_GOALS`

Query goal data by appending `{searchField}={searchValue}` to the URL with dot-notation fields and values. Include `is_active` to filter by goal status and specify both `period.start` and `period.end` for time-based searches.

### Find subscription by deal

**Slug:** `PIPEDRIVE_FIND_SUBSCRIPTION_BY_DEAL`

Returns details of an installment or a recurring subscription by the deal ID. Note: Subscriptions endpoints may not be available on company-specific hosts or may be deprecated. This action attempts multiple hosts and gracefully falls back to Installments (v2) or Deal Products (v1) to provide a useful response based on live API data.

### Find users by name

**Slug:** `PIPEDRIVE_FIND_USERS_BY_NAME`

Finds users by their name.

### Get all activities assigned to a particular user

**Slug:** `PIPEDRIVE_GET_ALL_ACTIVITIES_ASSIGNED_TO_A_PARTICULAR_USER`

Returns all activities assigned to a particular user.

### Get all activities beta

**Slug:** `PIPEDRIVE_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. Refer to Pipedrive's documentation for pagination and global permissions.

### Get all activity fields

**Slug:** `PIPEDRIVE_GET_ALL_ACTIVITY_FIELDS`

Returns all activity fields.

### Get all activity types

**Slug:** `PIPEDRIVE_GET_ALL_ACTIVITY_TYPES`

Returns all activity types.

### Get all add ons for a single company

**Slug:** `PIPEDRIVE_GET_ALL_ADD_ONS_FOR_A_SINGLE_COMPANY`

Returns the add-ons for a single company.

### Get all call logs assigned to a particular user

**Slug:** `PIPEDRIVE_GET_ALL_CALL_LOGS_ASSIGNED_TO_A_PARTICULAR_USER`

Returns all call logs assigned to a particular user.

### Get all comments for a note

**Slug:** `PIPEDRIVE_GET_ALL_COMMENTS_FOR_A_NOTE`

Returns all comments associated with a note.

### Get all deal fields

**Slug:** `PIPEDRIVE_GET_ALL_DEAL_FIELDS`

Returns data about all deal fields.

### Get all deals

**Slug:** `PIPEDRIVE_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" rel="noopener noreferrer">getting all deals</a>.

### Get all deals beta

**Slug:** `PIPEDRIVE_GET_ALL_DEALS_BETA`

This 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.

### Get all files

**Slug:** `PIPEDRIVE_GET_ALL_FILES`

Returns data about all files.

### Get all filter helpers

**Slug:** `PIPEDRIVE_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. It encourages consulting a tutorial for more details on adding a filter.

### Get all filters

**Slug:** `PIPEDRIVE_GET_ALL_FILTERS`

Returns data about all filters.

### Get all lead labels

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_GET_ALL_LEADS`

The API returns sorted leads by creation time, supporting pagination via `limit` and `start`. Custom field values are included if set, mimicking the `Deals` endpoint structure; unset fields are omitted. Leads share custom fields with deals.

### Get all lead sources

**Slug:** `PIPEDRIVE_GET_ALL_LEAD_SOURCES`

Returns all lead sources. Please note that the list of lead sources is fixed, it cannot be modified. All leads created through the Pipedrive API will have a lead source `API` assigned.

### Get all mail messages of mail thread

**Slug:** `PIPEDRIVE_GET_ALL_MAIL_MESSAGES_OF_MAIL_THREAD`

Returns all the mail messages inside a specified mail thread.

### Get all note fields

**Slug:** `PIPEDRIVE_GET_ALL_NOTE_FIELDS`

Returns data about all note fields.

### Get all notes

**Slug:** `PIPEDRIVE_GET_ALL_NOTES`

Returns all notes.

### Get all organization fields

**Slug:** `PIPEDRIVE_GET_ALL_ORGANIZATION_FIELDS`

Returns data about all organization fields.

### Get all organizations

**Slug:** `PIPEDRIVE_GET_ALL_ORGANIZATIONS`

Returns all organizations.

### Get all organizations beta

**Slug:** `PIPEDRIVE_GET_ALL_ORGANIZATIONS_BETA`

This 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.

### Get all payments of a subscription

**Slug:** `PIPEDRIVE_GET_ALL_PAYMENTS_OF_A_SUBSCRIPTION`

Returns all payments of an installment or recurring subscription.

### Get all permission sets

**Slug:** `PIPEDRIVE_GET_ALL_PERMISSION_SETS`

Returns data about all permission sets.

### Get all person fields

**Slug:** `PIPEDRIVE_GET_ALL_PERSON_FIELDS`

Returns data about all person fields.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.

### Get all persons

**Slug:** `PIPEDRIVE_GET_ALL_PERSONS`

Returns all persons.

### Get all persons beta

**Slug:** `PIPEDRIVE_GET_ALL_PERSONS_BETA`

This 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.

### Get all pipelines

**Slug:** `PIPEDRIVE_GET_ALL_PIPELINES`

Returns data about all pipelines.

### Get all product fields

**Slug:** `PIPEDRIVE_GET_ALL_PRODUCT_FIELDS`

Returns data about all product fields.

### Get all products

**Slug:** `PIPEDRIVE_GET_ALL_PRODUCTS`

Returns data about all products.

### Get all project boards

**Slug:** `PIPEDRIVE_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 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.

### Get all projects

**Slug:** `PIPEDRIVE_GET_ALL_PROJECTS`

Returns 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>.

### Get all project templates

**Slug:** `PIPEDRIVE_GET_ALL_PROJECT_TEMPLATES`

The endpoint retrieves all non-deleted project templates with cursor-based pagination. Refer to the provided documentation link for more details on pagination. Note: This endpoint requires the Pipedrive Projects add-on to be enabled. Projects is included in Power and Enterprise plans, or can be purchased as an add-on for Professional plans or lower.

### Get all relationships for organization

**Slug:** `PIPEDRIVE_GET_ALL_RELATIONSHIPS_FOR_ORGANIZATION`

Gets all of the relationships for a supplied organization ID.

### Get all roles

**Slug:** `PIPEDRIVE_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 base URL with `/api/v1` path. Example: https://{COMPANY}.pipedrive.com/api/v1/roles - This action normalizes the base_url provided by metadata to ensure `/api/v1` is used.

### Get all stages

**Slug:** `PIPEDRIVE_GET_ALL_STAGES`

Returns data about all stages.

### Get all supported currencies

**Slug:** `PIPEDRIVE_GET_ALL_SUPPORTED_CURRENCIES`

Returns 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.

### Get all tasks

**Slug:** `PIPEDRIVE_GET_ALL_TASKS`

Returns 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>.

### Get all teams

**Slug:** `PIPEDRIVE_GET_ALL_TEAMS`

Returns data about teams within the company.

### Get all teams of a user

**Slug:** `PIPEDRIVE_GET_ALL_TEAMS_OF_A_USER`

Returns data about all teams which have the specified user as a member.

### Get all user connections

**Slug:** `PIPEDRIVE_GET_ALL_USER_CONNECTIONS`

Returns data about all connections for the authorized user.

### Get all users

**Slug:** `PIPEDRIVE_GET_ALL_USERS`

Returns data about all users within the company.

### Get all users in a team

**Slug:** `PIPEDRIVE_GET_ALL_USERS_IN_A_TEAM`

Returns a list of all user IDs within a team.

### Get all webhooks

**Slug:** `PIPEDRIVE_GET_ALL_WEBHOOKS`

Returns data about all the Webhooks of a company.

### Get archived deals

**Slug:** `PIPEDRIVE_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 a single team

**Slug:** `PIPEDRIVE_GET_A_SINGLE_TEAM`

Returns data about a specific team.

### Get call log details

**Slug:** `PIPEDRIVE_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, participants, and timestamps.

### Get conversations for a channel

**Slug:** `PIPEDRIVE_GET_CONVERSATIONS`

Tool to retrieve messaging conversations. Use after channel registration to sync conversations.

### Get current user data

**Slug:** `PIPEDRIVE_GET_CURRENT_USER_DATA`

Returns data about an authorized user within the company with bound company data: company ID, company name, and domain. Note that the `locale` property means 'Date/number format' in the Pipedrive account settings, not the chosen language.

### Get Deal Details

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_GET_DEAL_ACTIVITIES`

Lists activities associated with a deal. Use when you need to retrieve all activities linked to a specific deal.

### Get deal by ID

**Slug:** `PIPEDRIVE_GET_DEAL_BY_ID`

Tool to retrieve detailed information for a specific deal by its ID. Use when you need to get complete deal data including value, stage, owner, and associated entities.

### Get Deal Changelog

**Slug:** `PIPEDRIVE_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 one deal field

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_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

**Slug:** `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

**Slug:** `PIPEDRIVE_GET_DEAL_FOLLOWERS_CHANGELOG`

Tool to retrieve changelogs about users who have followed a deal. Use when you need to track follower activity, showing when users were added or removed as followers.

### Get Deal Mail Messages

**Slug:** `PIPEDRIVE_GET_DEAL_MAIL_MESSAGES`

Tool 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.

### Get Deal Participants

**Slug:** `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

**Slug:** `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

**Slug:** `PIPEDRIVE_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

**Slug:** `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 in a pipeline

**Slug:** `PIPEDRIVE_GET_DEALS_IN_A_PIPELINE`

Lists deals in a specific pipeline across all its stages.

### Get deals in a stage

**Slug:** `PIPEDRIVE_GET_DEALS_IN_A_STAGE`

Lists deals in a specific stage.

### Get deals movements in pipeline

**Slug:** `PIPEDRIVE_GET_DEALS_MOVEMENTS_IN_PIPELINE`

Returns statistics for deals movements for the given time period.

### Get deals summary

**Slug:** `PIPEDRIVE_GET_DEALS_SUMMARY`

Returns a summary of all the deals.

### Get deals timeline

**Slug:** `PIPEDRIVE_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 deals where a product is attached to

**Slug:** `PIPEDRIVE_GET_DEALS_WHERE_A_PRODUCT_IS_ATTACHED_TO`

Returns data about deals that have a product attached to it.

### Get deal updates

**Slug:** `PIPEDRIVE_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 Permitted Users

**Slug:** `PIPEDRIVE_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 a board

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_BOARD`

Returns the details of a specific project board.

### Get details of a call log

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_CALL_LOG`

Returns details of a specific call log.

### Get details of a deal

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_DEAL`

Fetches specific deal details, including exclusive fields like deal age and pipeline stage duration. Custom fields show up as hashes, which can be matched using the 'key' from dealFields. See the deal details tutorial for more.

### Get details of an activity

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_AN_ACTIVITY`

Returns the details of a specific activity.

### Get details of an organization

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_AN_ORGANIZATION`

Provides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as long hashes to the 'key' value in organizationFields.

### Get details of a person

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_PERSON`

The text describes an API endpoint that returns detailed person information, including extra fields and custom fields as hashes. It also provides `data.marketing_status` if the Campaigns product is used.

### Get details of a phase

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_PHASE`

Returns the details of a specific project phase.

### Get details of a project

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_PROJECT`

Returns the details of a specific project. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of project fields.

### Get details of a subscription

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_SUBSCRIPTION`

Returns details of an installment or a recurring subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action tries multiple hosts and gracefully falls back to Installments (v2) and Deal Products (v1).

### Get details of a task

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_TASK`

Returns the details of a specific task.

### Get details of a template

**Slug:** `PIPEDRIVE_GET_DETAILS_OF_A_TEMPLATE`

Returns the details of a specific project template.

### Get one file

**Slug:** `PIPEDRIVE_GET_FILE`

Tool to retrieve metadata and details for a specific file stored in Pipedrive. Use when you need to get file properties, associated entity IDs, or download URL.

### Get Filter Details

**Slug:** `PIPEDRIVE_GET_FILTER`

Tool to get details of a specific filter in Pipedrive. Use when you need to retrieve comprehensive information about a filter by its ID.

### Get one lead

**Slug:** `PIPEDRIVE_GET_LEAD`

Tool to retrieve detailed information for a specific lead by its ID. Use when you need to get complete lead data including ownership, labels, associated entities, and monetary value.

### Get all lead fields

**Slug:** `PIPEDRIVE_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 Permitted Users

**Slug:** `PIPEDRIVE_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 threads

**Slug:** `PIPEDRIVE_GET_MAIL_THREADS`

Returns mail threads in a specified folder ordered by the most recent message within.

### Get Marketplace Client ID

**Slug:** `PIPEDRIVE_GET_MARKETPLACE_CLIENT_ID`

Tool to retrieve marketplace_client_id of an installed video integration. Use when you need the client ID for an installed integration.

### Get Note Details

**Slug:** `PIPEDRIVE_GET_NOTE`

Tool to get details of a specific note in Pipedrive. Use when you need to retrieve information about a note by its ID.

### Get Note Comments

**Slug:** `PIPEDRIVE_GET_NOTE_COMMENTS`

Tool to get all comments for a note. Use when you need to retrieve comment history or discussion associated with a specific note in Pipedrive.

### Get one comment

**Slug:** `PIPEDRIVE_GET_ONE_COMMENT`

Returns the details of a comment.

### Get one deal field

**Slug:** `PIPEDRIVE_GET_ONE_DEAL_FIELD`

Returns data about a specific deal field.

### Get one file

**Slug:** `PIPEDRIVE_GET_ONE_FILE`

Returns data about a specific file.

### Get one filter

**Slug:** `PIPEDRIVE_GET_ONE_FILTER`

Returns data about a specific filter. Note that this also returns the condition lines of the filter.

### Get one lead

**Slug:** `PIPEDRIVE_GET_ONE_LEAD`

API returns specific lead details with custom field values in the Deals format. Unset custom fields are omitted. Leads share custom fields with deals, not having a unique set.

### Get one mail message

**Slug:** `PIPEDRIVE_GET_ONE_MAIL_MESSAGE`

Returns data about a specific mail message.

### Get one mail thread

**Slug:** `PIPEDRIVE_GET_ONE_MAIL_THREAD`

Returns a specific mail thread.

### Get one note

**Slug:** `PIPEDRIVE_GET_ONE_NOTE`

Returns details about a specific note.

### Get one organization field

**Slug:** `PIPEDRIVE_GET_ONE_ORGANIZATION_FIELD`

Returns data about a specific organization field.

### Get one organization relationship

**Slug:** `PIPEDRIVE_GET_ONE_ORGANIZATION_RELATIONSHIP`

Finds and returns an organization relationship from its ID.

### Get one permission set

**Slug:** `PIPEDRIVE_GET_ONE_PERMISSION_SET`

Returns data about a specific permission set.

### Get one person field

**Slug:** `PIPEDRIVE_GET_ONE_PERSON_FIELD`

Returns data about a specific person field.

### Get one pipeline

**Slug:** `PIPEDRIVE_GET_ONE_PIPELINE`

Returns data about a specific pipeline. Also returns the summary of the deals in this pipeline across its stages.

### Get one product

**Slug:** `PIPEDRIVE_GET_ONE_PRODUCT`

Returns data about a specific product.

### Get one product field

**Slug:** `PIPEDRIVE_GET_ONE_PRODUCT_FIELD`

Returns data about a specific product field.

### Get one role

**Slug:** `PIPEDRIVE_GET_ONE_ROLE`

Returns the details of a specific 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} - This action normalizes the provided base_url to use `/api/v1` to avoid host/path mismatches.

### Get one stage

**Slug:** `PIPEDRIVE_GET_ONE_STAGE`

Returns data about a specific stage.

### Get one user

**Slug:** `PIPEDRIVE_GET_ONE_USER`

Returns data about a specific user within the company.

### Get Organization Details

**Slug:** `PIPEDRIVE_GET_ORGANIZATION`

Tool to get details of a specific organization in Pipedrive. Use when you need to retrieve comprehensive information about an organization by its ID.

### Get Organization Activities

**Slug:** `PIPEDRIVE_GET_ORGANIZATION_ACTIVITIES`

Tool to list activities associated with an organization. Use when you need to retrieve all activities linked to a specific organization in Pipedrive.

### Get Organization Changelog

**Slug:** `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 organization's field values.

### Get organization deals

**Slug:** `PIPEDRIVE_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 one organization field

**Slug:** `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 Organization Files

**Slug:** `PIPEDRIVE_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

**Slug:** `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

**Slug:** `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

**Slug:** `PIPEDRIVE_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

**Slug:** `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 one organization relationship

**Slug:** `PIPEDRIVE_GET_ORGANIZATION_RELATIONSHIP`

Tool to retrieve one organization relationship by its ID. Use when you need to get details about how organizations are related (parent-child or lateral relationships).

### Get Organization Updates

**Slug:** `PIPEDRIVE_GET_ORGANIZATION_UPDATES`

Tool 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.

### Get organization permitted users

**Slug:** `PIPEDRIVE_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 specific organization record.

### Get one permission set

**Slug:** `PIPEDRIVE_GET_PERMISSION_SET`

Tool to retrieve detailed information for a specific permission set by its ID. Use when you need to get complete permission set data including name, description, app association, type, assignment count, and specific permissions.

### Get Permission Set Assignments

**Slug:** `PIPEDRIVE_GET_PERMISSION_SET_ASSIGNMENTS`

Tool to list permission set assignments for a given permission set. Use when you need to retrieve all users assigned to a specific permission set.

### Get Person Details

**Slug:** `PIPEDRIVE_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 activities

**Slug:** `PIPEDRIVE_GET_PERSON_ACTIVITIES`

Lists activities associated with a person. Use when you need to retrieve all activities linked to a specific person.

### Get Person Changelog

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_GET_PERSON_DEALS`

Lists deals associated with a person. Use when you need to retrieve all deals linked to a specific person.

### Get one person field

**Slug:** `PIPEDRIVE_GET_PERSON_FIELD`

Tool to retrieve metadata for a specific person field by its ID. Use when you need to get field properties like name, type, order, and options.

### Get Person Files

**Slug:** `PIPEDRIVE_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

**Slug:** `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 Mail Messages

**Slug:** `PIPEDRIVE_GET_PERSON_MAIL_MESSAGES`

Tool to list mail messages associated with a person in Pipedrive. Use when you need to retrieve email communications linked to a specific person contact.

### Get Person Products

**Slug:** `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

**Slug:** `PIPEDRIVE_GET_PERSON_UPDATES`

Lists 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.

### Get Person Permitted Users

**Slug:** `PIPEDRIVE_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 Details

**Slug:** `PIPEDRIVE_GET_PIPELINE`

Tool to get details of a specific pipeline in Pipedrive. Use when you need to retrieve information about a pipeline by its ID.

### Get Pipeline by ID

**Slug:** `PIPEDRIVE_GET_PIPELINE_BY_ID`

Tool to get a specific pipeline by its ID. Use when you need to retrieve detailed information about a pipeline including its name, status, and configuration.

### Get Pipeline Conversion Statistics

**Slug:** `PIPEDRIVE_GET_PIPELINE_CONVERSION_STATISTICS`

Tool 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.

### Get Pipeline Deals

**Slug:** `PIPEDRIVE_GET_PIPELINE_DEALS`

Tool to get all deals within a specific pipeline. Use when you need to retrieve deals from a particular pipeline in Pipedrive, with optional filtering by user, stage, or custom filters.

### Get Pipeline Movement Statistics

**Slug:** `PIPEDRIVE_GET_PIPELINE_MOVEMENT_STATISTICS`

Tool 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.

### Get Product Details

**Slug:** `PIPEDRIVE_GET_PRODUCT`

Tool to get details of a specific product in Pipedrive. Use when you need to retrieve comprehensive information about a product by its ID.

### Get Product Deals

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_GET_PRODUCT_FIELD`

Tool to get details of a specific product field in Pipedrive. Use when you need to retrieve information about a product field by its ID.

### Get Product Files

**Slug:** `PIPEDRIVE_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

**Slug:** `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. Returns pagination metadata to handle large follower lists.

### List permitted users for product

**Slug:** `PIPEDRIVE_GET_PRODUCT_USERS`

Tool to list users permitted to access a product in Pipedrive. Use when you need to retrieve the list of users who have permission to view or manage a specific product.

### Get product variations

**Slug:** `PIPEDRIVE_GET_PRODUCT_VARIATIONS`

Tool to retrieve all product variations for a specific product with pagination support. Use when you need to get the complete list of variations available for a product, each with different prices across currencies.

### Get project phases

**Slug:** `PIPEDRIVE_GET_PROJECT_PHASES`

Returns all active project phases under a specific board.

### Get recents

**Slug:** `PIPEDRIVE_GET_RECENTS`

Returns data about all recent changes occurred after the given timestamp.

### Get result of a goal

**Slug:** `PIPEDRIVE_GET_RESULT_OF_A_GOAL`

Gets the progress of a goal for the specified period.

### Get one role

**Slug:** `PIPEDRIVE_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 status, assignment count, and default visibility settings.

### Get role assignments

**Slug:** `PIPEDRIVE_GET_ROLE_ASSIGNMENTS`

Tool to retrieve all users assigned to a specific role in Pipedrive. Use when you need to list role assignments for a given role.

### Get role pipelines

**Slug:** `PIPEDRIVE_GET_ROLE_PIPELINES`

Returns 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.

### Get role settings

**Slug:** `PIPEDRIVE_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, 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.

### Get one stage

**Slug:** `PIPEDRIVE_GET_STAGE`

Tool to get details of a specific stage in Pipedrive. Use when you need to retrieve information about a stage by its ID.

### Get Deals in Stage

**Slug:** `PIPEDRIVE_GET_STAGE_DEALS`

Tool to get all deals in a specific pipeline stage. Use when you need to retrieve deals based on their stage in the sales pipeline.

### Get templates for a channel

**Slug:** `PIPEDRIVE_GET_TEMPLATES`

Tool to retrieve message templates for a channel. Use when template support is enabled.

### Get User Details

**Slug:** `PIPEDRIVE_GET_USER`

Tool to get details of a specific user in Pipedrive. Use when you need to retrieve comprehensive information about a user by their ID.

### Get User Followers

**Slug:** `PIPEDRIVE_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.

### List user permissions

**Slug:** `PIPEDRIVE_GET_USER_PERMISSIONS`

Tool to list aggregated permissions over all assigned permission sets for a user. Use when you need to check what capabilities and access rights a specific user has across the system.

### Get User Role Assignments

**Slug:** `PIPEDRIVE_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

**Slug:** `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 and access levels for various entities. Note: This endpoint costs 10 API credits per request.

### Get lead conversion status by ID

**Slug:** `PIPEDRIVE_LEADS_GET_LEAD_BY_ID`

Tool to retrieve the conversion status for a specific lead conversion job. Use when you need to check the progress of a lead-to-deal conversion including current state and resulting deal ID upon completion.

### Convert Lead to Deal

**Slug:** `PIPEDRIVE_LEADS_POST_LEADS`

Tool 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.

### Link a remote file to an item

**Slug:** `PIPEDRIVE_LINK_A_REMOTE_FILE_TO_AN_ITEM`

Links 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>.

### Link User Video Integration

**Slug:** `PIPEDRIVE_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 activities associated with a deal

**Slug:** `PIPEDRIVE_LIST_ACTIVITIES_ASSOCIATED_WITH_A_DEAL`

Lists activities associated with a deal.

### List activities associated with an organization

**Slug:** `PIPEDRIVE_LIST_ACTIVITIES_ASSOCIATED_WITH_AN_ORGANIZATION`

Lists activities associated with an organization.

### List activities associated with a person

**Slug:** `PIPEDRIVE_LIST_ACTIVITIES_ASSOCIATED_WITH_A_PERSON`

Lists activities associated with a person.

### List all persons associated with a deal

**Slug:** `PIPEDRIVE_LIST_ALL_PERSONS_ASSOCIATED_WITH_A_DEAL`

The endpoint lists every person linked to a deal, including primary contacts and participants, and provides a `data.marketing_status` field for users of the Campaigns product.

### List deals associated with an organization

**Slug:** `PIPEDRIVE_LIST_DEALS_ASSOCIATED_WITH_AN_ORGANIZATION`

Lists deals associated with an organization.

### List deals associated with a person

**Slug:** `PIPEDRIVE_LIST_DEALS_ASSOCIATED_WITH_A_PERSON`

Lists deals associated with a person.

### List files attached to a deal

**Slug:** `PIPEDRIVE_LIST_FILES_ATTACHED_TO_A_DEAL`

Lists files associated with a deal.

### List files attached to an organization

**Slug:** `PIPEDRIVE_LIST_FILES_ATTACHED_TO_AN_ORGANIZATION`

Lists files associated with an organization.

### List files attached to a person

**Slug:** `PIPEDRIVE_LIST_FILES_ATTACHED_TO_A_PERSON`

Lists files associated with a person.

### List files attached to a product

**Slug:** `PIPEDRIVE_LIST_FILES_ATTACHED_TO_A_PRODUCT`

Lists files associated with a product.

### List followers of a deal

**Slug:** `PIPEDRIVE_LIST_FOLLOWERS_OF_A_DEAL`

Lists the followers of a deal.

### List followers of an organization

**Slug:** `PIPEDRIVE_LIST_FOLLOWERS_OF_AN_ORGANIZATION`

Lists the followers of an organization.

### List followers of a person

**Slug:** `PIPEDRIVE_LIST_FOLLOWERS_OF_A_PERSON`

Lists the followers of a person.

### List followers of a product

**Slug:** `PIPEDRIVE_LIST_FOLLOWERS_OF_A_PRODUCT`

Lists the followers of a product.

### List followers of a user

**Slug:** `PIPEDRIVE_LIST_FOLLOWERS_OF_A_USER`

Lists the followers of a specific user.

### List mail messages associated with a deal

**Slug:** `PIPEDRIVE_LIST_MAIL_MESSAGES_ASSOCIATED_WITH_A_DEAL`

Lists mail messages associated with a deal.

### List mail messages associated with an organization

**Slug:** `PIPEDRIVE_LIST_MAIL_MESSAGES_ASSOCIATED_WITH_AN_ORGANIZATION`

Lists mail messages associated with an organization.

### List mail messages associated with a person

**Slug:** `PIPEDRIVE_LIST_MAIL_MESSAGES_ASSOCIATED_WITH_A_PERSON`

Lists mail messages associated with a person.

### List participants of a deal

**Slug:** `PIPEDRIVE_LIST_PARTICIPANTS_OF_A_DEAL`

Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.

### List permission set assignments

**Slug:** `PIPEDRIVE_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 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.

### List permitted users

**Slug:** `PIPEDRIVE_LIST_PERMITTED_USERS`

Lists the users permitted to access a deal.

### List Person Access Users

**Slug:** `PIPEDRIVE_LIST_PERSON_ACCESS_USERS`

List users permitted to access a person.

### List persons of an organization

**Slug:** `PIPEDRIVE_LIST_PERSONS_OF_AN_ORGANIZATION`

Lists persons associated with an organization.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.

### List pipeline visibility for a role

**Slug:** `PIPEDRIVE_LIST_PIPELINE_VISIBILITY_FOR_A_ROLE`

Returns a list of visible or hidden pipeline IDs by role. See the "Visibility groups article" for details on pipeline visibility.

### List Product Permitted Users

**Slug:** `PIPEDRIVE_LIST_PRODUCT_PERMITTED_USERS`

Lists users permitted to access a product.

### List products associated with a person

**Slug:** `PIPEDRIVE_LIST_PRODUCTS_ASSOCIATED_WITH_A_PERSON`

Lists products associated with a person.

### List products attached to a deal

**Slug:** `PIPEDRIVE_LIST_PRODUCTS_ATTACHED_TO_A_DEAL`

Lists products attached to a deal.

### List role assignments

**Slug:** `PIPEDRIVE_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 `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/assignments - This action normalizes the base URL accordingly.

### List role settings

**Slug:** `PIPEDRIVE_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 domain with `/api/v1` path, e.g., https://{COMPANY}.pipedrive.com/api/v1/roles/{id}/settings - This action normalizes the base URL accordingly.

### List settings of an authorized user

**Slug:** `PIPEDRIVE_LIST_SETTINGS_OF_AN_AUTHORIZED_USER`

Lists the settings of an authorized user. Example response contains a shortened list of settings.

### List updates about a deal

**Slug:** `PIPEDRIVE_LIST_UPDATES_ABOUT_A_DEAL`

Lists updates about a deal.

### List updates about an organization

**Slug:** `PIPEDRIVE_LIST_UPDATES_ABOUT_AN_ORGANIZATION`

Lists updates about an organization.

### List updates about a person

**Slug:** `PIPEDRIVE_LIST_UPDATES_ABOUT_A_PERSON`

Lists updates about a person.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint's response will also include updates for the `marketing_status` field.

### List updates about participants of a deal

**Slug:** `PIPEDRIVE_LIST_UPDATES_ABOUT_PARTICIPANTS_OF_A_DEAL`

This endpoint provides cursor-paginated updates on deal participants. For pagination details, see the Pipedrive documentation.

### List user permissions

**Slug:** `PIPEDRIVE_LIST_USER_PERMISSIONS`

Lists aggregated permissions over all assigned permission sets for a user.

### List User Role Assignments

**Slug:** `PIPEDRIVE_LIST_USER_ROLE_ASSIGNMENTS`

Lists role assignments for a user.

### List user role settings

**Slug:** `PIPEDRIVE_LIST_USER_ROLE_SETTINGS`

Lists the settings of user's assigned role.

### Merge Deals

**Slug:** `PIPEDRIVE_MERGE_DEALS`

Tool 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.

### Merge Organizations

**Slug:** `PIPEDRIVE_MERGE_ORGANIZATIONS`

Tool 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.

### Merge two persons

**Slug:** `PIPEDRIVE_MERGE_PERSONS`

Tool 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.

### Merge two deals

**Slug:** `PIPEDRIVE_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" target="_blank" rel="noopener noreferrer">merging two deals</a>.

### Merge two organizations

**Slug:** `PIPEDRIVE_MERGE_TWO_ORGANIZATIONS`

Merges 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>.

### Merge two persons

**Slug:** `PIPEDRIVE_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" target="_blank" rel="noopener noreferrer">merging two persons</a>.

### Organization accessible user list

**Slug:** `PIPEDRIVE_ORGANIZATION_ACCESSIBLE_USER_LIST`

List users permitted to access an organization.

### Patch deal fields

**Slug:** `PIPEDRIVE_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. Note that field code and type are immutable and cannot be changed.

### Update deal field options

**Slug:** `PIPEDRIVE_PATCH_DEALFIELDS_OPTIONS`

Tool to update existing options for a deal custom field atomically. Use when you need to modify labels of options in a deal field.

### Update organization field (v2)

**Slug:** `PIPEDRIVE_PATCH_ORGANIZATION_FIELDS`

Tool to update an existing organization field in Pipedrive using the v2 API. Use when you need to modify field name, UI visibility, importance settings, required field settings, or description.

### Update Person Field Configuration

**Slug:** `PIPEDRIVE_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. Only provided properties will be updated; omitted properties retain their existing values. Note: field_code and field_type cannot be changed.

### Update person field options

**Slug:** `PIPEDRIVE_PATCH_PERSONFIELDS_OPTIONS`

Tool to update existing options for a person custom field atomically. Use when you need to modify labels of options in a person field.

### Update product field options

**Slug:** `PIPEDRIVE_PATCH_PRODUCTFIELDS_OPTIONS`

Tool to update existing options for a product custom field atomically. Use when you need to modify labels of options in a product field.

### Perform a search from multiple item types

**Slug:** `PIPEDRIVE_PERFORM_A_SEARCH_FROM_MULTIPLE_ITEM_TYPES`

Performs a search from your choice of item types and fields.

### Add deal field options

**Slug:** `PIPEDRIVE_POST_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 person field options

**Slug:** `PIPEDRIVE_POST_PERSONFIELDS_OPTIONS`

Tool to bulk add options to enum/set person fields atomically. Use when you need to add new options to a person field.

### Update product field

**Slug:** `PIPEDRIVE_PRODUCTFIELDS_PATCH_PRODUCTFIELDS`

Tool 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.

### Add product field options

**Slug:** `PIPEDRIVE_PRODUCTFIELDS_POST_PRODUCTFIELDS_OPTIONS`

Tool 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.

### Get Product by ID

**Slug:** `PIPEDRIVE_PRODUCTS_GET_PRODUCT_BY_ID`

Tool to retrieve detailed product information by product ID. Use when you need to get comprehensive details about a specific product including pricing, billing frequency, and custom fields.

### Create Product

**Slug:** `PIPEDRIVE_PRODUCTS_POST_PRODUCTS`

Tool to create a new product in the Pipedrive Products inventory. Use when you need to add new products that can be linked to deals.

### Create product variation

**Slug:** `PIPEDRIVE_PRODUCTS_POST_PRODUCT_VARIATION`

Tool 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.

### Add Product Variation

**Slug:** `PIPEDRIVE_PRODUCTS_POST_PRODUCT_VARIATIONS`

Tool to add a new product variation to an existing product. Use when you need to create product variations with different pricing across currencies. Each variation can have multiple prices in different currencies, but only one price per currency is supported.

### Receives an incoming message

**Slug:** `PIPEDRIVE_RECEIVES_AN_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 ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

### Refreshing the tokens

**Slug:** `PIPEDRIVE_REFRESHING_THE_TOKENS`

Access tokens expire after the time specified in `expires_in`. To continue accessing the API, use the `refresh_token` to obtain a new access token.

### Requesting authorization

**Slug:** `PIPEDRIVE_REQUESTING_AUTHORIZATION`

Authorize a user by redirecting them to the Pipedrive OAuth authorization page and request their permissions to act on their behalf. This step is necessary to implement only when you allow app installation outside of the Marketplace.

### Returns project activities

**Slug:** `PIPEDRIVE_RETURNS_PROJECT_ACTIVITIES`

Returns activities linked to a specific project.

### Returns project groups

**Slug:** `PIPEDRIVE_RETURNS_PROJECT_GROUPS`

Returns all active groups under a specific project.

### Returns project plan

**Slug:** `PIPEDRIVE_RETURNS_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.

### Returns project tasks

**Slug:** `PIPEDRIVE_RETURNS_PROJECT_TASKS`

Returns tasks linked to a specific project.

### Search deals

**Slug:** `PIPEDRIVE_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 /v1/itemSearch with limited OAuth scope.

### Search Item By Field

**Slug:** `PIPEDRIVE_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 field values), or the IDs of actual items (deals, leads, persons, organizations or products).

### Search leads

**Slug:** `PIPEDRIVE_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 /v1/itemSearch with limited OAuth scope.

### Search organizations

**Slug:** `PIPEDRIVE_SEARCH_ORGANIZATIONS`

Searches 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.

### Search persons

**Slug:** `PIPEDRIVE_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 filtering by organization ID.

### Search products

**Slug:** `PIPEDRIVE_SEARCH_PRODUCTS`

Searches all products by name, code and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope.

### Update stage

**Slug:** `PIPEDRIVE_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.

### Unlinkuserfromvideocallintegration

**Slug:** `PIPEDRIVE_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 a comment related to a note

**Slug:** `PIPEDRIVE_UPDATE_A_COMMENT_RELATED_TO_A_NOTE`

Updates a comment related to a note.

### Update an activity

**Slug:** `PIPEDRIVE_UPDATE_ACTIVITY`

Tool to update an existing activity in Pipedrive including scheduling, assignments, descriptions, and participants. Use when you need to modify any properties of an activity such as subject, due date/time, status, or associated entities.

### Update activity in project plan

**Slug:** `PIPEDRIVE_UPDATE_ACTIVITY_IN_PROJECT_PLAN`

Updates an activity phase or group in a project.

### Update activity type

**Slug:** `PIPEDRIVE_UPDATE_ACTIVITY_TYPE`

Tool to update an activity type in Pipedrive. Use when you need to modify the name, icon, color, or order of an existing activity type.

### Update a deal

**Slug:** `PIPEDRIVE_UPDATE_A_DEAL`

Updates the properties of a deal. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/updating-a-deal" target="_blank" rel="noopener noreferrer">updating a deal</a>.

### Update a deal field

**Slug:** `PIPEDRIVE_UPDATE_A_DEAL_FIELD`

Updates a deal field. For more information, see the tutorial for <a href= https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

### Update a filter

**Slug:** `PIPEDRIVE_UPDATE_A_FILTER`

Updates an existing filter in Pipedrive. Use when you need to modify filter name or conditions. Maximum of 16 conditions per filter allowed.

### Update a lead

**Slug:** `PIPEDRIVE_UPDATE_A_LEAD`

Updating lead properties modifies only specified fields; use `null` to unset. Custom field data matches `Deals`. Unset fields are omitted. Leads share deals' custom fields. For examples, refer to the tutorial.

### Update a lead label

**Slug:** `PIPEDRIVE_UPDATE_A_LEAD_LABEL`

Updates one or more properties of a lead label. Only properties included in the request will be updated.

### Update an activity

**Slug:** `PIPEDRIVE_UPDATE_AN_ACTIVITY`

Updates an activity. Includes `more_activities_scheduled_in_context` property in response's `additional_data` which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).

### Update an activity type

**Slug:** `PIPEDRIVE_UPDATE_AN_ACTIVITY_TYPE`

Updates an activity type.

### Update an installment subscription

**Slug:** `PIPEDRIVE_UPDATE_AN_INSTALLMENT_SUBSCRIPTION`

Updates an installment subscription. Note: Subscriptions endpoints may not be available on the company-specific base URL. To avoid 404s, this action overrides the default request behavior and uses multiple hosts along with a practical fallback to Deal Products when Subscriptions/Installments features are not accessible.

### Update an organization

**Slug:** `PIPEDRIVE_UPDATE_AN_ORGANIZATION`

Updates the properties of an organization.

### Update an organization field

**Slug:** `PIPEDRIVE_UPDATE_AN_ORGANIZATION_FIELD`

Updates 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>.

### Update an organization relationship

**Slug:** `PIPEDRIVE_UPDATE_AN_ORGANIZATION_RELATIONSHIP`

Updates and returns an organization relationship.

### Update a note

**Slug:** `PIPEDRIVE_UPDATE_A_NOTE`

Updates a note.

### Update a person

**Slug:** `PIPEDRIVE_UPDATE_A_PERSON`

Modifies a person’s details in Pipedrive. See the linked tutorial for guidance. If utilizing Campaigns, the endpoint also handles `data.marketing_status`.

### Update a person field

**Slug:** `PIPEDRIVE_UPDATE_A_PERSON_FIELD`

Updates a person field. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/updating-custom-field-value " target="_blank" rel="noopener noreferrer">updating custom fields' values</a>.

### Update a pipeline

**Slug:** `PIPEDRIVE_UPDATE_A_PIPELINE`

Updates the properties of a pipeline (v2).

### Update a product

**Slug:** `PIPEDRIVE_UPDATE_A_PRODUCT`

Updates product data.

### Update a product field

**Slug:** `PIPEDRIVE_UPDATE_A_PRODUCT_FIELD`

Updates 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>.

### Update a project

**Slug:** `PIPEDRIVE_UPDATE_A_PROJECT`

Updates a project.

### Update a recurring subscription

**Slug:** `PIPEDRIVE_UPDATE_A_RECURRING_SUBSCRIPTION`

Updates 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.

### Update a task

**Slug:** `PIPEDRIVE_UPDATE_A_TASK`

Updates a task.

### Update a team

**Slug:** `PIPEDRIVE_UPDATE_A_TEAM`

Updates an existing team and returns the updated object.

### Update comment for note

**Slug:** `PIPEDRIVE_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 a deal

**Slug:** `PIPEDRIVE_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 a deal field

**Slug:** `PIPEDRIVE_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. Note that field_code and field_type cannot be changed.

### Update Deal Product

**Slug:** `PIPEDRIVE_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 existing goal

**Slug:** `PIPEDRIVE_UPDATE_EXISTING_GOAL`

Updates 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.

### Update file details

**Slug:** `PIPEDRIVE_UPDATE_FILE`

Updates the properties of a file including its visible name and description. Use when you need to modify file metadata in Pipedrive.

### Update file details

**Slug:** `PIPEDRIVE_UPDATE_FILE_DETAILS`

Updates the properties of a file.

### Update filter

**Slug:** `PIPEDRIVE_UPDATE_FILTER`

Updates an existing filter.

### Update a lead

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_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. Only properties included in the request will be updated.

### Update mail thread details

**Slug:** `PIPEDRIVE_UPDATE_MAIL_THREAD_DETAILS`

Updates the properties of a mail thread.

### Update Note

**Slug:** `PIPEDRIVE_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, organizations, leads, or projects.

### Update Organization

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_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 field options

**Slug:** `PIPEDRIVE_UPDATE_ORGANIZATION_FIELD_OPTIONS`

Tool 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.

### Update organization relationship

**Slug:** `PIPEDRIVE_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 between two organizations.

### Update a person

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_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 person (v2)

**Slug:** `PIPEDRIVE_UPDATE_PERSON_V2`

Tool 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.

### Update a pipeline

**Slug:** `PIPEDRIVE_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. All fields except id are optional - only include the fields you want to update.

### Update pipeline visibility for a role

**Slug:** `PIPEDRIVE_UPDATE_PIPELINE_VISIBILITY_FOR_A_ROLE`

Updates pipeline visibility settings for different roles. For details, see the Pipedrive Visibility groups article.

### Update a product

**Slug:** `PIPEDRIVE_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

**Slug:** `PIPEDRIVE_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 role details

**Slug:** `PIPEDRIVE_UPDATE_ROLE_DETAILS`

Updates 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.

### Update role pipelines

**Slug:** `PIPEDRIVE_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 details

**Slug:** `PIPEDRIVE_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 probability, or rotten deal settings.

### Update stage details

**Slug:** `PIPEDRIVE_UPDATE_STAGE_DETAILS`

Updates the properties of a stage.

### Update task in project plan

**Slug:** `PIPEDRIVE_UPDATE_TASK_IN_PROJECT_PLAN`

Updates a task phase or group in a project.

### Update the product attached to a deal

**Slug:** `PIPEDRIVE_UPDATE_THE_PRODUCT_ATTACHED_TO_A_DEAL`

Updates the details of the product that has been attached to a deal.

### Update user details

**Slug:** `PIPEDRIVE_UPDATE_USER`

Tool to update user details in Pipedrive. Use when you need to activate or deactivate a user account. Requires admin-level permissions.

### Update user details

**Slug:** `PIPEDRIVE_UPDATE_USER_DETAILS`

Updates the properties of a user. Currently, only `active_flag` can be updated.


## Triggers

### New Deal Received Trigger

**Slug:** `PIPEDRIVE_NEW_DEAL_TRIGGER`

Triggered when a new deal is created in Pipedrive

### New Note Received Trigger

**Slug:** `PIPEDRIVE_NEW_NOTE_TRIGGER`

Triggered when a new note is created in Pipedrive

### New Organization Received Trigger

**Slug:** `PIPEDRIVE_NEW_ORGANIZATION_TRIGGER`

Triggered when a new organization is created in Pipedrive
