Pipedrive

Learn how to use Pipedrive with Composio

Overview

SLUG: PIPEDRIVE

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to contacts:full,leads:full,mail:full,activities:full,products:full,projects:full
subdomain
stringRequired
subdomain
stringRequired
generic_api_key
stringRequired

Connecting to Pipedrive

Create an auth config

Use the dashboard to create an auth config for the Pipedrive toolkit. This allows you to connect multiple Pipedrive accounts to Composio for agents to use.

1

Select App

Navigate to Pipedrive.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Pipedrive Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4pipedrive_auth_config_id = "ac_YOUR_PIPEDRIVE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Pipedrive: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, pipedrive_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4pipedrive_auth_config_id = "ac_YOUR_PIPEDRIVE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Pipedrive for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, pipedrive_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Pipedrive toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Add a call log

Description

Adds a new call log.

Action Parameters

activity_id
integer
deal_id
integer
duration
string
end_time
stringRequired
from_phone_number
string
lead_id
string
note
string
org_id
integer
outcome
stringRequired
person_id
integer
start_time
stringRequired
subject
string
to_phone_number
stringRequired
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a channel

Description

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.

Action Parameters

avatar_url
name
stringRequired
provider_channel_id
stringRequired
provider_type
stringDefaults to other
template_support
boolean

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a comment to a note

Description

Adds a new comment to a note.

Action Parameters

content
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a deal

Description

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.

Action Parameters

currency
expected_close_date
org_id
person_id
pipeline_id
probability
stage_id
status
title
stringRequired
user_id
value
visible_to

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a follower to a deal

Description

Adds a follower to a deal.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a follower to an organization

Description

Adds a follower to an organization.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a follower to a person

Description

Adds a follower to a person.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a follower to a product

Description

Adds a follower to a product.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a lead

Description

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.

Action Parameters

expected_close_date
string
label_ids
array
organization_id
integer
owner_id
integer
person_id
integer
title
stringRequired
value__amount
integer
value__currency
string
was_seen
boolean

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a lead label

Description

Creates a lead label.

Action Parameters

color
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add an activity

Description

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

Action Parameters

attendees
busy_flag
deal_id
done
due_date
due_time
duration
lead_id
location
note
org_id
participants
person_id
project_id
public_description
subject
stringRequired
type
stringRequired
user_id

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Add a new deal field

Description

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

Action Parameters

add_visible_flag
field_type
stringRequired
name
stringRequired
options

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new filter

Description

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.

Action Parameters

conditions
objectRequired
name
stringRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new goal

Description

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

Action Parameters

assignee
objectRequired
duration
objectRequired
expected_outcome
objectRequired
interval
stringRequired
title
type
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new organization field

Description

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

Action Parameters

add_visible_flag
field_type
stringRequired
name
stringRequired
options

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new person field

Description

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

Action Parameters

add_visible_flag
api_token
field_type
stringRequired
name
stringRequired
options

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new pipeline

Description

Adds a new pipeline (v2).

Action Parameters

is_deal_probability_enabled
name
stringRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Add a new product field

Description

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

Action Parameters

field_type
stringRequired
name
stringRequired
options
array

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new stage

Description

Adds a new stage, returns the ID upon success.

Action Parameters

deal_probability
name
stringRequired
pipeline_id
integerRequired
rotten_days
rotten_flag

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new team

Description

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

Action Parameters

description
string
manager_id
integerRequired
name
stringRequired
users
array

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a new user

Description

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

Action Parameters

access
arrayDefaults to [{'app': 'sales'}]
active_flag
booleanDefaults to True
email
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add an installment subscription

Description

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.

Action Parameters

currency
stringRequired
deal_id
integerRequired
payments
arrayRequired
update_deal_value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add an organization

Description

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.

Action Parameters

name
stringRequired
owner_id
visible_to

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a note

Description

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.

Action Parameters

add_time
content
stringRequired
deal_id
lead_id
org_id
person_id
project_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a participant to a deal

Description

Adds a participant to a deal.

Action Parameters

id
integerRequired
person_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a person

Description

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.

Action Parameters

add_time
email
label_ids
marketing_status
name
stringRequired
org_id
owner_id
phone
update_time
visible_to

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a product

Description

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

Action Parameters

billing_frequency
billing_frequency_cycles
category
code
description
is_linkable
name
stringRequired
owner_id
prices
tax
unit
visible_to

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a product to a deal

Description

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

Action Parameters

comments
discount
discount_type
duration
duration_unit
enabled_flag
id
integerRequired
item_price
numberRequired
product_id
integerRequired
product_variation_id
quantity
numberRequired
tax
tax_method

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a project

Description

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.

Action Parameters

board_id
integerRequired
deal_ids
description
end_date
labels
org_id
owner_id
person_id
phase_id
integerRequired
start_date
status
template_id
title
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a recurring subscription

Description

Adds a new recurring subscription.

Action Parameters

cadence_type
stringRequired
currency
stringRequired
cycle_amount
integerRequired
cycles_count
deal_id
integerRequired
description
infinite
payments
start_date
stringRequired
update_deal_value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a role

Description

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.

Action Parameters

name
stringRequired
parent_role_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a task

Description

Adds a new task.

Action Parameters

assignee_id
description
done
due_date
parent_task_id
project_id
integerRequired
title
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Call Log Audio File

Description

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.

Action Parameters

file
objectRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add participant to deal

Description

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

Action Parameters

id
integerRequired
person_id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Add product to deal

Description

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.

Action Parameters

billing_frequency
billing_frequency_cycles
billing_start_date
comments
discount
discount_percentage
discount_type
duration
id
integerRequired
is_enabled
item_price
numberRequired
product_id
integerRequired
product_variation_id
quantity
numberRequired
tax
tax_method

Action Response

data
error
success
successful
booleanRequired

Tool Name: Add file

Description

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

Action Parameters

activity_id
deal_id
file
lead_id
org_id
person_id
product_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add new activity type

Description

Adds a new activity type.

Action Parameters

color
icon_key
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add Note

Description

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.

Action Parameters

add_time
content
stringRequired
deal_id
lead_id
org_id
person_id
pinned_to_deal_flag
pinned_to_lead_flag
pinned_to_organization_flag
pinned_to_person_flag
pinned_to_project_flag
project_id
user_id

Action Response

data
error
success
successful
booleanRequired

Tool Name: Add comment to note

Description

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.

Action Parameters

content
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Add Organization Field Options

Description

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.

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Add organization follower

Description

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.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Add or update role setting

Description

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.

Action Parameters

id
integerRequired
setting_key
stringRequired
value
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add a follower to a person

Description

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.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Add person picture

Description

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.

Action Parameters

crop_height
crop_width
crop_x
crop_y
file
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add follower to product

Description

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.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Add role assignment

Description

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.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add users to a team

Description

Adds users to an existing team.

Action Parameters

id
integerRequired
users
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Archive a project

Description

Archives a project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Attach an audio file to the call log

Description

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

Action Parameters

file
objectRequired
id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Cancel a recurring subscription

Description

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.

Action Parameters

end_date
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create a new webhook

Description

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.

Action Parameters

event_action
stringRequired
event_object
stringRequired
http_auth_password
http_auth_user
name
stringRequired
subscription_url
stringRequired
user_id
version
stringDefaults to 2.0

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create an organization relationship

Description

Creates and returns an organization relationship.

Action Parameters

org_id
integer
rel_linked_org_id
integerRequired
rel_owner_org_id
integerRequired
type
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all ActivityFields

Description

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.

Action Parameters

cursor
include_fields
limit
Defaults to 100

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Convert deal to lead

Description

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.

Action Parameters

id
integerRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Delete deal

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete deal

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Get Deals Products

Description

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.

Action Parameters

cursor
deal_ids
arrayRequired
limit
sort_by
sort_direction

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Bulk add products to deal

Description

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

Action Parameters

data
arrayRequired
id
integerRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Update deal product

Description

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.

Action Parameters

billing_frequency
billing_frequency_cycles
billing_start_date
comments
discount
discount_type
id
integerRequired
is_enabled
item_price
product_attachment_id
integerRequired
product_id
product_variation_id
quantity
tax
tax_method

Action Response

data
error
success
successful
booleanRequired

Tool Name: Delete a call log

Description

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.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a channel

Description

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

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a conversation

Description

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

Action Parameters

channel__id
stringRequired
conversation__id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Activity

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete Activity Type

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Delete a deal

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a deal field

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a file

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a filter

Description

Marks a filter as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a follower from a deal

Description

Deletes a follower from a deal.

Action Parameters

follower_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a follower from an organization

Description

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.

Action Parameters

follower_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a follower from a person

Description

Deletes a follower from a person.

Action Parameters

follower_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a follower from a product

Description

Deletes a follower from a product.

Action Parameters

follower_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a lead

Description

Deletes a specific lead.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a lead label

Description

Deletes a specific lead label.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an activity

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an activity type

Description

Marks an activity type as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an attached product from a deal

Description

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

Action Parameters

id
integerRequired
product_attachment_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an organization

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an organization field

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an organization relationship

Description

Deletes an organization relationship and returns the deleted ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a note

Description

Deletes a specific note.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a participant from a deal

Description

Deletes a participant from a deal.

Action Parameters

deal_participant_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a person

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a person field

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a pipeline

Description

Marks a pipeline as deleted.

Action Parameters

id
integerRequired

Action Response

data
error
errorCode
error_info
success
successful
booleanRequired

Tool Name: Delete a product

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a product field

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a project

Description

Marks a project as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a role

Description

Marks a role as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a role assignment

Description

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

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a stage

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a subscription

Description

Marks an installment or a recurring subscription as deleted.

Action Parameters

id
integerRequired

Action Response

data
error
successful
booleanRequired

Tool Name: Delete a task

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete comment from note

Description

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.

Action Parameters

commentId
stringRequired
id
integerRequired

Action Response

data
booleanRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete Deal

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete a deal field

Description

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

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Delete deal field options

Description

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

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Delete deal follower

Description

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

Action Parameters

follower_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete Deal Product

Description

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.

Action Parameters

id
integerRequired
product_attachment_id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete existing goal

Description

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.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete existing webhook

Description

Deletes the specified Webhook.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete a file

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete Pipedrive Filter

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete lead label

Description

Tool to delete a specific lead label from Pipedrive. Use when you need to remove a lead label using its UUID identifier.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete mail thread

Description

Marks a mail thread as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple activities in bulk

Description

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

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple activity types in bulk

Description

Marks multiple activity types as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple deal fields in bulk

Description

Marks multiple deal fields as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple deals in bulk

Description

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

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple filters in bulk

Description

Marks multiple filters as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple organization fields in bulk

Description

Marks multiple fields as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple organizations in bulk

Description

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

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple person fields in bulk

Description

Marks multiple fields as deleted.

Action Parameters

api_token
ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple persons in bulk

Description

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

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple product fields in bulk

Description

Marks multiple fields as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete multiple stages in bulk

Description

Marks multiple stages as deleted (v1). Note: This endpoint may be deprecated; we keep compatibility and avoid raising to surface API errors in response.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete an organization

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Delete organization field options

Description

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.

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
null
data
arrayRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete organization follower

Description

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

Action Parameters

follower_id
integerRequired
id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete a person

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Delete a person field

Description

Tool to delete a person field from Pipedrive. Use when you need to remove a custom person field by its unique identifier.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete person field options

Description

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

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Delete person picture

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete product field options

Description

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

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Delete a stage

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Delete users from a team

Description

Deletes users from an existing team.

Action Parameters

id
integerRequired
users
arrayRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete existing webhook

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Download one file

Description

Initializes a file download.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Duplicate deal

Description

Duplicates a deal.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Enumerate accessible users for lead

Description

Lists the users permitted to access a lead.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Find goals

Description

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.

Action Parameters

assignee__id
assignee__type
expected__outcome__currency__id
expected__outcome__target
expected__outcome__tracking__metric
is_active
booleanDefaults to True
period__end
period__start
title
type__name
type__params__activity__type__id
type__params__pipeline__id
type__params__stage__id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Find subscription by deal

Description

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.

Action Parameters

dealId
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Find users by name

Description

Finds users by their name.

Action Parameters

search_by_email
integer
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all activities assigned to a particular user

Description

Returns all activities assigned to a particular user.

Action Parameters

done
integer
end_date
string
filter_id
integer
limit
integer
start
integer
start_date
string
type
string
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all activities beta

Description

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.

Action Parameters

cursor
string
done
boolean
limit
integer
since
string
type
string
until
string
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all activity fields

Description

Returns all activity fields.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all activity types

Description

Returns all activity types.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all add ons for a single company

Description

Returns the add-ons for a single company.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all call logs assigned to a particular user

Description

Returns all call logs assigned to a particular user.

Action Parameters

limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all comments for a note

Description

Returns all comments associated with a note.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all deal fields

Description

Returns data about all deal fields.

Action Parameters

limit
start

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all deals

Description

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

Action Parameters

filter_id
integer
limit
integer
owned_by_you
integer
sort
string
stage_id
integer
start
integer
status
stringDefaults to all_not_deleted
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all deals beta

Description

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.

Action Parameters

cursor
string
limit
integer
since
string
stage_id
integer
status
string
until
string
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all files

Description

Returns data about all files.

Action Parameters

limit
integer
sort
string
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all filter helpers

Description

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.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all filters

Description

Returns data about all filters.

Action Parameters

type
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all lead labels

Description

Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all leads

Description

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.

Action Parameters

archived_status
string
filter_id
integer
limit
integer
organization_id
integer
owner_id
integer
person_id
integer
sort
string
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all lead sources

Description

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.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all mail messages of mail thread

Description

Returns all the mail messages inside a specified mail thread.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all note fields

Description

Returns data about all note fields.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all notes

Description

Returns all notes.

Action Parameters

deal_id
integer
end_date
string
lead_id
string
limit
integer
org_id
integer
person_id
integer
pinned_to_deal_flag
integer
pinned_to_lead_flag
integer
pinned_to_organization_flag
integer
pinned_to_person_flag
integer
sort
string
start
integer
start_date
string
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all organization fields

Description

Returns data about all organization fields.

Action Parameters

limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all organizations

Description

Returns all organizations.

Action Parameters

filter_id
integer
first_char
string
limit
integer
sort
string
start
integer
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all organizations beta

Description

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.

Action Parameters

cursor
string
first_char
string
limit
integer
owner_id
integer
since
string
until
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all payments of a subscription

Description

Returns all payments of an installment or recurring subscription.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all permission sets

Description

Returns data about all permission sets.

Action Parameters

app

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all person fields

Description

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.

Action Parameters

limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all persons

Description

Returns all persons.

Action Parameters

filter_id
integer
first_char
string
limit
integer
sort
string
start
integer
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all persons beta

Description

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.

Action Parameters

cursor
string
first_char
string
limit
integer
owner_id
integer
since
string
until
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all pipelines

Description

Returns data about all pipelines.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all product fields

Description

Returns data about all product fields.

Action Parameters

limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all products

Description

Returns data about all products.

Action Parameters

filter_id
integer
first_char
string
get_summary
boolean
ids
array
limit
integer
start
integer
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all project boards

Description

Returns all projects boards that are not deleted.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all projects

Description

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

Action Parameters

cursor
filter_id
include_archived
limit
phase_id
status

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all project templates

Description

The endpoint retrieves all non-deleted project templates with cursor-based pagination. Refer to the provided documentation link for more details on pagination.

Action Parameters

cursor
limit

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all relationships for organization

Description

Gets all of the relationships for a supplied organization ID.

Action Parameters

org_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all roles

Description

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.

Action Parameters

limit
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all stages

Description

Returns data about all stages.

Action Parameters

limit
integer
pipeline_id
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all supported currencies

Description

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.

Action Parameters

term
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all tasks

Description

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

Action Parameters

assignee_id
cursor
done
limit
parent_task_id
project_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all teams

Description

Returns data about teams within the company.

Action Parameters

order_by
stringDefaults to id
skip_users
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all teams of a user

Description

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

Action Parameters

id
integerRequired
order_by
stringDefaults to id
skip_users
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all user connections

Description

Returns data about all connections for the authorized user.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all users

Description

Returns data about all users within the company.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all users in a team

Description

Returns a list of all user IDs within a team.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get all webhooks

Description

Returns data about all the Webhooks of a company.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get archived deals

Description

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.

Action Parameters

cursor
string
custom_fields
string
filter_id
integer
ids
string
include_fields
string
limit
integer
org_id
integer
owner_id
integer
person_id
integer
pipeline_id
integer
sort_by
string
sort_direction
string
stage_id
integer
status
string
updated_since
string
updated_until
string

Action Response

additional_data
object
data
error
success
boolean
successful
booleanRequired

Tool Name: Get a single team

Description

Returns data about a specific team.

Action Parameters

id
integerRequired
skip_users
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get call log details

Description

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.

Action Parameters

id
stringRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get conversations for a channel

Description

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

Action Parameters

after
channel_id
stringRequired
conversations_limit
messages_limit

Action Response

additional_data
objectRequired
data
arrayRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Get current user data

Description

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.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Deal Details

Description

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

Action Parameters

custom_fields
id
integerRequired
include_fields

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get deal activities

Description

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

Action Parameters

done
exclude
id
integerRequired
limit
start
integer

Action Response

additional_data
data
error
related_objects
success
successful
booleanRequired

Tool Name: Get deal by ID

Description

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.

Action Parameters

custom_fields
id
integerRequired
include_fields

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Deal Changelog

Description

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.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get one deal field

Description

Tool to retrieve a specific deal field by ID. Use when you need to get metadata and configuration for a deal field.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Deal Files

Description

Tool to list files attached to a deal. Use when you need to retrieve all files associated with a specific deal in Pipedrive.

Action Parameters

id
integerRequired
limit
sort
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get deal followers

Description

Lists users who are following the deal. Use when you need to retrieve all followers of a specific deal.

Action Parameters

cursor
id
integerRequired
limit
Defaults to 100

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get deal followers changelog

Description

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.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Deal Mail Messages

Description

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.

Action Parameters

id
integerRequired
limit
start

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Deal Participants

Description

Tool to list participants of a deal. Use when you need to retrieve all participants (persons) associated with a specific deal in Pipedrive.

Action Parameters

id
integerRequired
limit
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Deal Participants Changelog

Description

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.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Deal Products

Description

Tool to list products attached to a deal. Use when you need to retrieve all products associated with a specific deal in Pipedrive.

Action Parameters

cursor
id
integerRequired
limit
sort_by
sort_direction

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get deals conversion rates in pipeline

Description

Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.

Action Parameters

end_date
stringRequired
id
integerRequired
start_date
stringRequired
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deals in a pipeline

Description

Lists deals in a specific pipeline across all its stages.

Action Parameters

everyone
integer
filter_id
integer
get_summary
integer
id
integerRequired
limit
integer
stage_id
integer
start
integer
totals_convert_currency
string
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deals in a stage

Description

Lists deals in a specific stage.

Action Parameters

everyone
integer
filter_id
integer
id
integerRequired
limit
integer
start
integer
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deals movements in pipeline

Description

Returns statistics for deals movements for the given time period.

Action Parameters

end_date
stringRequired
id
integerRequired
start_date
stringRequired
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deals summary

Description

Returns a summary of all the deals.

Action Parameters

filter_id
integer
stage_id
integer
status
string
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deals timeline

Description

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.

Action Parameters

amount
integerRequired
exclude_deals
integer
field_key
stringRequired
filter_id
integer
interval
stringRequired
pipeline_id
integer
start_date
stringRequired
totals_convert_currency
string
user_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deals where a product is attached to

Description

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

Action Parameters

id
integerRequired
limit
integer
start
integer
status
stringDefaults to all_not_deleted

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get deal updates

Description

Lists updates about a deal in chronological order. Use when you need to track deal changes, monitor activity timeline, or audit deal modifications.

Action Parameters

all_changes
id
integerRequired
items
limit
start

Action Response

additional_data
data
error
related_objects
success
successful
booleanRequired

Tool Name: Get Deal Permitted Users

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get details of a board

Description

Returns the details of a specific project board.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a call log

Description

Returns details of a specific call log.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a deal

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of an activity

Description

Returns the details of a specific activity.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of an organization

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a person

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a phase

Description

Returns the details of a specific project phase.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a project

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a subscription

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a task

Description

Returns the details of a specific task.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get details of a template

Description

Returns the details of a specific project template.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one file

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Filter Details

Description

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

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get one lead

Description

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.

Action Parameters

id
stringRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get all lead fields

Description

Tool to retrieve all lead fields. Use when you need to get the schema for leads in a company's context.

Action Parameters

limit
start

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Lead Permitted Users

Description

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.

Action Parameters

id
stringRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get mail threads

Description

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

Action Parameters

folder
stringRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Marketplace Client ID

Description

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

Action Parameters

marketplace_client_id_hint
provider

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Note Details

Description

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

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Note Comments

Description

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.

Action Parameters

id
integerRequired
limit
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get one comment

Description

Returns the details of a comment.

Action Parameters

commentId
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one deal field

Description

Returns data about a specific deal field.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one file

Description

Returns data about a specific file.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one filter

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one lead

Description

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.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one mail message

Description

Returns data about a specific mail message.

Action Parameters

id
integerRequired
include_body
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one mail thread

Description

Returns a specific mail thread.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one note

Description

Returns details about a specific note.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one organization field

Description

Returns data about a specific organization field.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one organization relationship

Description

Finds and returns an organization relationship from its ID.

Action Parameters

id
integerRequired
org_id
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one permission set

Description

Returns data about a specific permission set.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one person field

Description

Returns data about a specific person field.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one pipeline

Description

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

Action Parameters

id
integerRequired
totals_convert_currency
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one product

Description

Returns data about a specific product.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one product field

Description

Returns data about a specific product field.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one role

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one stage

Description

Returns data about a specific stage.

Action Parameters

everyone
integer
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one user

Description

Returns data about a specific user within the company.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Organization Details

Description

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

Action Parameters

custom_fields
id
integerRequired
include_fields

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Organization Activities

Description

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

Action Parameters

done
exclude
id
integerRequired
limit
start

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Organization Changelog

Description

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.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get organization deals

Description

Lists deals associated with an organization. Use when you need to retrieve all deals linked to a specific organization with optional filtering and pagination.

Action Parameters

id
integerRequired
limit
only_primary_association
sort
start
integer
status
stringDefaults to all_not_deleted

Action Response

additional_data
data
error
related_objects
success
successful
booleanRequired

Tool Name: Get one organization field

Description

Tool to retrieve a specific organization field by ID. Use when you need to get metadata and configuration for an organization field.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Organization Files

Description

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

Action Parameters

id
integerRequired
limit
sort
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Organization Followers

Description

Tool to list followers of an organization. Use when you need to retrieve all users who are following a specific organization in Pipedrive.

Action Parameters

cursor
id
integerRequired
limit
Defaults to 100

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Organization Followers Changelog

Description

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.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Organization Mail Messages

Description

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.

Action Parameters

id
integerRequired
limit
start

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Organization Persons

Description

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

Action Parameters

id
integerRequired
limit
start

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get one organization relationship

Description

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

Action Parameters

id
integerRequired
org_id

Action Response

data
error
related_objects
success
successful
booleanRequired

Tool Name: Get Organization Updates

Description

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.

Action Parameters

all_changes
id
integerRequired
items
limit
start

Action Response

additional_data
data
error
related_objects
success
successful
booleanRequired

Tool Name: Get organization permitted users

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one permission set

Description

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.

Action Parameters

id
stringRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Permission Set Assignments

Description

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.

Action Parameters

id
stringRequired
limit
start

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Person Details

Description

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

Action Parameters

custom_fields
id
integerRequired
include_fields

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get person activities

Description

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

Action Parameters

done
exclude
id
integerRequired
limit
start
integer

Action Response

additional_data
data
error
related_objects
success
successful
booleanRequired

Tool Name: Get Person Changelog

Description

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.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get person deals

Description

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

Action Parameters

id
integerRequired
limit
sort
start
integer
status

Action Response

additional_data
data
error
related_objects
success
successful
booleanRequired

Tool Name: Get one person field

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Person Files

Description

Tool to list files attached to a person. Use when you need to retrieve all files associated with a specific person in Pipedrive.

Action Parameters

id
integerRequired
limit
sort
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Person Followers

Description

Tool to list followers of a person in Pipedrive. Use when you need to retrieve all users who are following a specific person.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Person Mail Messages

Description

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.

Action Parameters

id
integerRequired
limit
start

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Person Products

Description

Tool to list products associated with a person. Use when you need to retrieve all products linked to a specific person in Pipedrive.

Action Parameters

id
integerRequired
limit
start

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get person updates

Description

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.

Action Parameters

all_changes
id
integerRequired
items
limit
start

Action Response

additional_data
data
error
related_objects
success
successful
booleanRequired

Tool Name: Get Person Permitted Users

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Pipeline Details

Description

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

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Pipeline by ID

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Pipeline Conversion Statistics

Description

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.

Action Parameters

end_date
stringRequired
id
integerRequired
start_date
stringRequired
user_id

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Pipeline Deals

Description

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.

Action Parameters

everyone
filter_id
get_summary
id
integerRequired
limit
stage_id
start
totals_convert_currency
user_id

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Pipeline Movement Statistics

Description

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.

Action Parameters

end_date
stringRequired
id
integerRequired
start_date
stringRequired
user_id

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Product Details

Description

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

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Product Deals

Description

Tool to list deals associated with a product. Use when you need to retrieve deals that have a specific product attached to them.

Action Parameters

id
integerRequired
limit
start
status

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get Product Field

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Product Files

Description

Tool to list files attached to a product. Use when you need to retrieve all files associated with a specific product in Pipedrive.

Action Parameters

id
integerRequired
limit
sort
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get product followers

Description

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.

Action Parameters

id
integerRequired
limit
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: List permitted users for product

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get product variations

Description

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.

Action Parameters

cursor
id
integerRequired
limit

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get project phases

Description

Returns all active project phases under a specific board.

Action Parameters

board_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get recents

Description

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

Action Parameters

items
string
limit
integer
since_timestamp
stringRequired
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get result of a goal

Description

Gets the progress of a goal for the specified period.

Action Parameters

id
stringRequired
period__end
stringRequired
period__start
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get one role

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get role assignments

Description

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

Action Parameters

id
integerRequired
limit
start
integer

Action Response

additional_data
objectRequired
data
arrayRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Get role pipelines

Description

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.

Action Parameters

id
integerRequired
visible
Defaults to True

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Get role settings

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get one stage

Description

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

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get Deals in Stage

Description

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.

Action Parameters

everyone
filter_id
id
integerRequired
limit
start
user_id

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get templates for a channel

Description

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

Action Parameters

channel_id
stringRequired

Action Response

data
arrayRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Get User Details

Description

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

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get User Followers

Description

Tool to list users who are following a specific user. Use when you need to retrieve all followers of a user in Pipedrive.

Action Parameters

cursor
id
integerRequired
limit
Defaults to 100

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: List user permissions

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get User Role Assignments

Description

Tool to list role assignments for a user. Use when you need to retrieve all role assignments associated with a specific user in Pipedrive.

Action Parameters

id
integerRequired
limit
start
integer

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Get user role settings

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Get lead conversion status by ID

Description

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.

Action Parameters

conversion_id
stringRequired
id
stringRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Convert Lead to Deal

Description

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.

Action Parameters

id
stringRequired
pipeline_id
stage_id

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: List activities associated with a deal

Description

Lists activities associated with a deal.

Action Parameters

done
integer
exclude
string
id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List activities associated with an organization

Description

Lists activities associated with an organization.

Action Parameters

done
integer
exclude
string
id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List activities associated with a person

Description

Lists activities associated with a person.

Action Parameters

done
integer
exclude
string
id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List all persons associated with a deal

Description

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.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List deals associated with an organization

Description

Lists deals associated with an organization.

Action Parameters

id
integerRequired
limit
integer
only_primary_association
integer
sort
string
start
integer
status
stringDefaults to all_not_deleted

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List deals associated with a person

Description

Lists deals associated with a person.

Action Parameters

id
integerRequired
limit
integer
sort
string
start
integer
status
stringDefaults to all_not_deleted

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List files attached to a deal

Description

Lists files associated with a deal.

Action Parameters

id
integerRequired
limit
integer
sort
string
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List files attached to an organization

Description

Lists files associated with an organization.

Action Parameters

id
integerRequired
limit
integer
sort
string
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List files attached to a person

Description

Lists files associated with a person.

Action Parameters

id
integerRequired
limit
integer
sort
string
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List files attached to a product

Description

Lists files associated with a product.

Action Parameters

id
integerRequired
limit
integer
sort
string
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List followers of a deal

Description

Lists the followers of a deal.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List followers of an organization

Description

Lists the followers of an organization.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List followers of a person

Description

Lists the followers of a person.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List followers of a product

Description

Lists the followers of a product.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List followers of a user

Description

Lists the followers of a specific user.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List mail messages associated with a deal

Description

Lists mail messages associated with a deal.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List mail messages associated with an organization

Description

Lists mail messages associated with an organization.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List mail messages associated with a person

Description

Lists mail messages associated with a person.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List participants of a deal

Description

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.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List permission set assignments

Description

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.

Action Parameters

id
stringRequired
limit
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List permitted users

Description

Lists the users permitted to access a deal.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Person Access Users

Description

List users permitted to access a person.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List persons of an organization

Description

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.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List pipeline visibility for a role

Description

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

Action Parameters

id
integerRequired
visible
booleanDefaults to True

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List Product Permitted Users

Description

Lists users permitted to access a product.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List products associated with a person

Description

Lists products associated with a person.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List products attached to a deal

Description

Lists products attached to a deal.

Action Parameters

id
integerRequired
include_product_data
integer
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List role assignments

Description

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.

Action Parameters

id
integerRequired
limit
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List role settings

Description

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.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
success
boolean
successful
booleanRequired

Tool Name: List settings of an authorized user

Description

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

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List updates about a deal

Description

Lists updates about a deal.

Action Parameters

all_changes
string
id
integerRequired
items
string
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List updates about an organization

Description

Lists updates about an organization.

Action Parameters

all_changes
string
id
integerRequired
items
string
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List updates about a person

Description

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.

Action Parameters

all_changes
string
id
integerRequired
items
string
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List updates about participants of a deal

Description

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

Action Parameters

cursor
string
id
integerRequired
limit
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List user permissions

Description

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

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List User Role Assignments

Description

Lists role assignments for a user.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: List user role settings

Description

Lists the settings of user's assigned role.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Merge Deals

Description

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.

Action Parameters

id
integerRequired
merge_with_id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Merge Organizations

Description

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.

Action Parameters

id
integerRequired
merge_with_id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Merge two persons

Description

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.

Action Parameters

id
integerRequired
merge_with_id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Merge two deals

Description

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

Action Parameters

id
integerRequired
merge_with_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Merge two organizations

Description

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

Action Parameters

id
integerRequired
merge_with_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Merge two persons

Description

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

Action Parameters

id
integerRequired
merge_with_id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Organization accessible user list

Description

List users permitted to access an organization.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Patch deal fields

Description

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.

Action Parameters

description
field_code
stringRequired
field_name
important_fields
required_fields
ui_visibility

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update deal field options

Description

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

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Update organization field (v2)

Description

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.

Action Parameters

description
field_code
stringRequired
field_name
important_fields
required_fields
ui_visibility

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update Person Field Configuration

Description

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.

Action Parameters

description
field_code
stringRequired
field_name
important_fields
required_fields
ui_visibility

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update person field options

Description

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

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Update product field options

Description

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

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Perform a search from multiple item types

Description

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

Action Parameters

exact_match
boolean
fields
string
include_fields
string
item_types
string
limit
integer
search_for_related_items
boolean
start
integer
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Add deal field options

Description

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.

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Add person field options

Description

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

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Update product field

Description

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.

Action Parameters

description
field_code
stringRequired
field_name
ui_visibility

Action Response

data
error
success
successful
booleanRequired

Tool Name: Add product field options

Description

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.

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
arrayRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Get Product by ID

Description

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.

Action Parameters

id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Create Product

Description

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.

Action Parameters

billing_frequency
billing_frequency_cycles
category
code
description
is_linkable
name
stringRequired
owner_id
prices
tax
unit
visible_to

Action Response

data
error
success
successful
booleanRequired

Tool Name: Create product variation

Description

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.

Action Parameters

id
integerRequired
name
stringRequired
prices

Action Response

data
error
success
successful
booleanRequired

Tool Name: Add Product Variation

Description

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.

Action Parameters

id
integerRequired
name
stringRequired
prices

Action Response

data
error
success
successful
booleanRequired

Tool Name: Receives an incoming message

Description

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

Action Parameters

attachments
channel_id
stringRequired
conversation_id
stringRequired
conversation_link
created_at
stringRequired
id
stringRequired
message
stringRequired
reply_by
sender_id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Refreshing the tokens

Description

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.

Action Parameters

client_id
client_secret
grant_type
stringDefaults to refresh_token
refresh_token

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Requesting authorization

Description

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.

Action Parameters

client_id
stringRequired
redirect_uri
stringRequired
state

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Returns project activities

Description

Returns activities linked to a specific project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Returns project groups

Description

Returns all active groups under a specific project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Returns project plan

Description

Returns information about items in a project plan. Items consists of tasks and activities and are linked to specific project phase and group.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Returns project tasks

Description

Returns tasks linked to a specific project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search deals

Description

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.

Action Parameters

exact_match
fields
include_fields
limit
organization_id
person_id
start
integer
status
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Item By Field

Description

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

Action Parameters

exact_match
boolean
field_key
stringRequired
field_type
stringRequired
limit
integer
return_item_ids
boolean
start
integer
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search leads

Description

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.

Action Parameters

exact_match
boolean
fields
string
include_fields
string
limit
integer
organization_id
integer
person_id
integer
start
integer
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search organizations

Description

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.

Action Parameters

exact_match
fields
limit
start
integer
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search persons

Description

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.

Action Parameters

exact_match
boolean
fields
string
include_fields
string
limit
integer
organization_id
integer
start
integer
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search products

Description

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.

Action Parameters

exact_match
boolean
fields
string
include_fields
string
limit
integer
start
integer
term
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update stage

Description

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.

Action Parameters

days_to_rotten
deal_probability
id
integerRequired
is_deal_rot_enabled
name
pipeline_id

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update an activity

Description

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.

Action Parameters

attendees
busy
deal_id
done
due_date
due_time
duration
id
integerRequired
lead_id
location
note
org_id
owner_id
participants
person_id
priority
project_id
public_description
subject
type

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update activity in project plan

Description

Updates an activity phase or group in a project.

Action Parameters

activityId
integerRequired
group_id
id
integerRequired
phase_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update activity type

Description

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.

Action Parameters

color
icon_key
id
integerRequired
name
order_nr

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update a deal

Description

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

Action Parameters

currency
expected_close_date
id
integerRequired
lost_reason
org_id
person_id
pipeline_id
probability
stage_id
status
title
user_id
value
visible_to

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a deal field

Description

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

Action Parameters

add_visible_flag
id
integerRequired
name
options

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a filter

Description

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

Action Parameters

conditions
id
integerRequired
name

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update a lead

Description

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.

Action Parameters

expected_close_date
string
id
stringRequired
is_archived
boolean
label_ids
array
organization_id
integer
owner_id
integer
person_id
integer
title
string
value__amount
integer
value__currency
string
was_seen
boolean

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a lead label

Description

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

Action Parameters

color
string
id
stringRequired
name
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update an activity

Description

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

Action Parameters

deal_id
done
due_date
due_time
duration
id
integerRequired
location
note
org_id
person_id
subject
type
user_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update an activity type

Description

Updates an activity type.

Action Parameters

color
icon_key
id
integerRequired
name
order_nr

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update an installment subscription

Description

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.

Action Parameters

id
integerRequired
payments
arrayRequired
update_deal_value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update an organization

Description

Updates the properties of an organization.

Action Parameters

address
annual_revenue
employee_count
id
integerRequired
industry
label_ids
linkedin
name
owner_id
visible_to
website

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update an organization field

Description

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

Action Parameters

add_visible_flag
id
integerRequired
name
options

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update an organization relationship

Description

Updates and returns an organization relationship.

Action Parameters

id
integerRequired
org_id
integer
rel_linked_org_id
integer
rel_owner_org_id
integer
type
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a note

Description

Updates a note.

Action Parameters

add_time
content
deal_id
id
integerRequired
lead_id
org_id
person_id
pinned_to_deal_flag
pinned_to_lead_flag
pinned_to_organization_flag
pinned_to_person_flag
pinned_to_project_flag
project_id
user_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a person

Description

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

Action Parameters

add_time
email
id
integerRequired
label_ids
marketing_status
name
org_id
owner_id
phone
update_time
visible_to

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a person field

Description

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

Action Parameters

add_visible_flag
booleanDefaults to True
id
integerRequired
name
options

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a pipeline

Description

Updates the properties of a pipeline (v2).

Action Parameters

id
integerRequired
is_deal_probability_enabled
name

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update a product

Description

Updates product data.

Action Parameters

billing_frequency
billing_frequency_cycles
category
code
description
id
integerRequired
is_linkable
name
owner_id
prices
tax
unit
visible_to

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a product field

Description

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

Action Parameters

id
integerRequired
name
string
options
array

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a project

Description

Updates a project.

Action Parameters

board_id
deal_ids
description
end_date
id
integerRequired
labels
org_id
owner_id
person_id
phase_id
start_date
status
title

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a recurring subscription

Description

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.

Action Parameters

cycle_amount
description
effective_date
stringRequired
id
integerRequired
payments
update_deal_value

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a task

Description

Updates a task.

Action Parameters

assignee_id
description
done
due_date
id
integerRequired
parent_task_id
project_id
title

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a team

Description

Updates an existing team and returns the updated object.

Action Parameters

active_flag
deleted_flag
description
id
integerRequired
manager_id
name
users

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update comment for note

Description

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.

Action Parameters

commentId
stringRequired
content
stringRequired
id
integerRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update a deal

Description

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.

Action Parameters

archive_time
close_time
currency
expected_close_date
id
integerRequired
is_archived
label_ids
lost_reason
lost_time
org_id
owner_id
person_id
pipeline_id
probability
stage_id
status
title
value
visible_to
won_time

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update a deal field

Description

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.

Action Parameters

add_visible_flag
id
integerRequired
name
options

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update Deal Product

Description

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.

Action Parameters

billing_frequency
billing_frequency_cycles
billing_start_date
comments
discount
discount_type
id
integerRequired
is_enabled
item_price
product_attachment_id
integerRequired
quantity
tax
tax_method

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update existing goal

Description

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.

Action Parameters

assignee
duration
expected_outcome
id
stringRequired
interval
title
type

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update file details

Description

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

Action Parameters

description
id
integerRequired
name

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update file details

Description

Updates the properties of a file.

Action Parameters

description
string
id
integerRequired
name
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update filter

Description

Updates an existing filter.

Action Parameters

id
integerRequired
name
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a lead

Description

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.

Action Parameters

channel
channel_id
expected_close_date
id
stringRequired
is_archived
label_ids
organization_id
owner_id
person_id
title
value
visible_to
was_seen

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update Lead Label

Description

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.

Action Parameters

color
id
stringRequired
name

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update mail thread details

Description

Updates the properties of a mail thread.

Action Parameters

archived_flag
deal_id
id
integerRequired
lead_id
read_flag
shared_flag

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Note

Description

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.

Action Parameters

add_time
content
deal_id
id
integerRequired
lead_id
org_id
person_id
pinned_to_deal_flag
pinned_to_lead_flag
pinned_to_organization_flag
pinned_to_person_flag
pinned_to_project_flag
project_id
user_id

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update Organization

Description

Tool to update an existing organization in Pipedrive. Use when you need to modify organization properties such as name, owner, visibility, labels, or address.

Action Parameters

address
id
integerRequired
label_ids
name
owner_id
visible_to

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update organization field

Description

Tool to update an organization field in Pipedrive. Use when you need to modify the name, options, or visibility of an existing organization field.

Action Parameters

add_visible_flag
id
integerRequired
name
options

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update organization field options

Description

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.

Action Parameters

field_code
stringRequired
options
arrayRequired

Action Response

additional_data
data
error
success
successful
booleanRequired

Tool Name: Update organization relationship

Description

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.

Action Parameters

id
integerRequired
org_id
rel_linked_org_id
rel_owner_org_id
type

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update a person

Description

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.

Action Parameters

add_time
email
id
integerRequired
label
label_ids
marketing_status
name
org_id
owner_id
phone
update_time
visible_to

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update person field

Description

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.

Action Parameters

add_visible_flag
id
integerRequired
name
options

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update person (v2)

Description

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.

Action Parameters

add_time
emails
first_name
id
integerRequired
label_ids
last_name
marketing_status
name
org_id
owner_id
phones
update_time
visible_to

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update a pipeline

Description

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.

Action Parameters

active
deal_probability
id
integerRequired
name
order_nr

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update pipeline visibility for a role

Description

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

Action Parameters

id
integerRequired
visible_pipeline_ids
objectRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update a product

Description

Tool to update a product in Pipedrive. Use when you need to modify product details like name, code, price, tax, or other attributes.

Action Parameters

active_flag
category
code
description
id
integerRequired
name
owner_id
prices
selectable
tax
unit
visible_to

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update product field

Description

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.

Action Parameters

id
integerRequired
name
options

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update role details

Description

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.

Action Parameters

id
integerRequired
name
parent_role_id

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update role pipelines

Description

Updates pipeline visibility for a role. Use when you need to control which sales pipelines are accessible to users within a particular role group.

Action Parameters

id
integerRequired
visible_pipeline_ids
objectRequired

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update stage details

Description

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.

Action Parameters

deal_probability
id
integerRequired
name
order_nr
pipeline_id
rotten_days
rotten_flag

Action Response

data
objectRequired
error
success
booleanRequired
successful
booleanRequired

Tool Name: Update stage details

Description

Updates the properties of a stage.

Action Parameters

deal_probability
id
integerRequired
name
order_nr
pipeline_id
rotten_days
rotten_flag

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update task in project plan

Description

Updates a task phase or group in a project.

Action Parameters

group_id
id
integerRequired
phase_id
taskId
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update the product attached to a deal

Description

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

Action Parameters

comments
string
discount
integer
discount_type
stringDefaults to percentage
duration
integerDefaults to 1
enabled_flag
booleanDefaults to True
id
integerRequired
item_price
integer
product_attachment_id
integerRequired
product_id
integer
product_variation_id
integer
quantity
integer
tax
integer
tax_method
string

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update user details

Description

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

Action Parameters

active_flag
booleanRequired
id
integerRequired

Action Response

data
error
success
successful
booleanRequired

Tool Name: Update user details

Description

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

Action Parameters

active_flag
booleanRequired
id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired