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
bearer_token
string
subdomain
stringRequired
token
stringRequired
subdomain
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 the Pipedrive toolkit page and click “Setup Integration”.

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

Using Bearer Token

1from composio import Composio
2from composio.types import auth_scheme
3
4# Auth config ID created above
5pipedrive_auth_config_id = "ac_YOUR_PIPEDRIVE_CONFIG_ID"
6
7# UUID from database/application
8user_id = "0000-0000-0000"
9
10composio = Composio()
11
12
13def authenticate_toolkit(user_id: str, auth_config_id: str):
14 # Replace this with a method to retrieve the Bearer Token from the user.
15 bearer_token = input("[!] Enter bearer token")
16 connection_request = composio.connected_accounts.initiate(
17 user_id=user_id,
18 auth_config_id=auth_config_id,
19 config={"auth_scheme": "BEARER_TOKEN", "val": bearer_token}
20 )
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

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["PIPEDRIVE"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

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

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Add a note

Description

Adds a new note.

Action Parameters

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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

id
integerRequired

Action Response

data
objectRequired
error
string
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

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add an installment subscription

Description

Adds a new installment subscription.

Action Parameters

currency
stringRequired
deal_id
integerRequired
payments
arrayRequired
update_deal_value
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add an organization

Description

Set up a new pipedrive organization using custom fields with unique key hashes. retrieve `organizationfields` for configuration. check the linked tutorial for guidance.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

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
string
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
string
name
stringRequired
provider_channel_id
stringRequired
provider_type
stringDefaults to other
template_support
boolean

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Add a lead label

Description

Creates a lead label.

Action Parameters

color
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
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

name
stringRequired

Action Response

data
objectRequired
error
string
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

interval
stringRequired
title
string

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add a new pipeline

Description

Adds a new pipeline.

Action Parameters

name
stringRequired
order_nr
integer

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Add a new stage

Description

Adds a new stage, returns the id upon success.

Action Parameters

deal_probability
integer
name
stringRequired
pipeline_id
integerRequired
rotten_days
integer
rotten_flag
boolean

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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

id
integerRequired

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
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
integer
deal_id
integerRequired
description
string
infinite
boolean
payments
array
start_date
stringRequired
update_deal_value
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add a role

Description

Adds a new role.

Action Parameters

name
stringRequired
parent_role_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add a task

Description

Adds a new task.

Action Parameters

Action Response

data
objectRequired
error
string
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
integer
deal_id
integer
file
object
lead_id
object
org_id
integer
person_id
integer
product_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add new activity type

Description

Adds a new activity type.

Action Parameters

color
string
icon_key
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add or update role setting

Description

Adds or updates the visibility setting for a role.

Action Parameters

id
integerRequired
setting_key
stringRequired
value
integerRequired

Action Response

data
objectRequired
error
string
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
integer
crop_width
integer
crop_x
integer
crop_y
integer
file
object
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add role assignment

Description

Assigns a user to a role.

Action Parameters

id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Archive a project

Description

Archives a project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
object
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Cancel a recurring subscription

Description

Cancels a recurring subscription.

Action Parameters

end_date
string
id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
http_auth_user
string
subscription_url
stringRequired
user_id
integer
version
stringDefaults to 1.0

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Delete an activity type

Description

Marks an activity type as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Delete a filter

Description

Marks a filter as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Delete a lead

Description

Deletes a specific lead.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a lead label

Description

Deletes a specific lead label.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a note

Description

Deletes a specific note.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Delete a pipeline

Description

Marks a pipeline as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
successful
booleanRequired

Tool Name: Delete a project

Description

Marks a project as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a role

Description

Marks a role as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Delete a stage

Description

Marks a stage as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete a subscription

Description

Marks an installment or a recurring subscription as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Delete existing goal

Description

Marks a goal as deleted.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete existing webhook

Description

Deletes the specified webhook.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete mail thread

Description

Marks a mail thread as deleted.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Delete multiple filters in bulk

Description

Marks multiple filters as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Delete multiple person fields in bulk

Description

Marks multiple fields as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Delete multiple stages in bulk

Description

Marks multiple stages as deleted.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete person picture

Description

Deletes a person’s picture.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Download one file

Description

Initializes a file download.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Duplicate deal

Description

Duplicates a deal.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
integer
assignee__type
string
expected__outcome__currency__id
integer
expected__outcome__target
integer
expected__outcome__tracking__metric
string
is_active
booleanDefaults to True
period__end
string
period__start
string
title
string
type__name
string
type__params__activity__type__id
array
type__params__pipeline__id
array
type__params__stage__id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Find subscription by deal

Description

Returns details of an installment or a recurring subscription by the deal id.

Action Parameters

dealId
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get all activity fields

Description

Returns all activity fields.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all activity types

Description

Returns all activity types.

Action Parameters

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get all deal fields

Description

Returns data about all deal fields.

Action Parameters

limit
integer
start
integer

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Get all filters

Description

Returns data about all filters.

Action Parameters

type
string

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get all note fields

Description

Returns data about all note fields.

Action Parameters

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get all permission sets

Description

Returns data about all permission sets.

Action Parameters

app
string

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get all pipelines

Description

Returns data about all pipelines.

Action Parameters

Action Response

data
objectRequired
error
string
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
string
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
string
filter_id
integer
include_archived
boolean
limit
integer
phase_id
integer
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get all project boards

Description

Returns all projects boards that are not deleted.

Action Parameters

Action Response

data
objectRequired
error
string
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
string
limit
integer

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Get all roles

Description

Returns all the roles within the company.

Action Parameters

limit
integer
start
integer

Action Response

data
objectRequired
error
string
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
string
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
string
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
integer
cursor
string
done
integer
limit
integer
parent_task_id
integer
project_id
integer

Action Response

data
objectRequired
error
string
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
string
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
string
successful
booleanRequired

Tool Name: Get all users

Description

Returns data about all users within the company.

Action Parameters

Action Response

data
objectRequired
error
string
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
string
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
string
successful
booleanRequired

Tool Name: Get all webhooks

Description

Returns data about all the webhooks of a company.

Action Parameters

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get details of a subscription

Description

Returns details of an installment or a recurring subscription.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get one file

Description

Returns data about a specific file.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
successful
booleanRequired

Tool Name: Get one mail thread

Description

Returns a specific mail thread.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get one note

Description

Returns details about a specific note.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: Get one product

Description

Returns data about a specific product.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Get one role

Description

Returns the details of a specific role.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: List permission set assignments

Description

Returns the list of assignments for a permission set.

Action Parameters

id
stringRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
successful
booleanRequired

Tool Name: List role assignments

Description

Returns all users assigned to a role.

Action Parameters

id
integerRequired
limit
integer
start
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List role settings

Description

Returns the visibility settings of a specific role.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
string
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
array
channel_id
stringRequired
conversation_id
stringRequired
conversation_link
string
created_at
stringRequired
id
stringRequired
message
stringRequired
reply_by
string
sender_id
stringRequired
status
stringRequired

Action Response

data
objectRequired
error
string
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

grant_type
stringDefaults to refresh_token
refresh_token
string

Action Response

data
objectRequired
error
string
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
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Returns project activities

Description

Returns activities linked to a specific project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
successful
booleanRequired

Tool Name: Returns project tasks

Description

Returns tasks linked to a specific project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
boolean
fields
string
include_fields
string
limit
integer
organization_id
integer
person_id
integer
start
integer
status
string
term
stringRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
boolean
fields
string
limit
integer
start
integer
term
stringRequired

Action Response

data
objectRequired
error
string
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
string
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
string
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
integer
id
integerRequired
phase_id
integer

Action Response

data
objectRequired
error
string
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

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update an activity type

Description

Updates an activity type.

Action Parameters

color
string
icon_key
string
id
integerRequired
name
string
order_nr
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update an installment subscription

Description

Updates an installment subscription.

Action Parameters

id
integerRequired
payments
arrayRequired
update_deal_value
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update an organization

Description

Updates the properties of an organization.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
booleanDefaults to True
id
integerRequired
name
string
options
array

Action Response

data
objectRequired
error
string
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
string
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
booleanDefaults to True
id
integerRequired
name
string
options
array

Action Response

data
objectRequired
error
string
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
string
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
string
successful
booleanRequired

Tool Name: Update a note

Description

Updates a note.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
options
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a pipeline

Description

Updates the properties of a pipeline.

Action Parameters

id
integerRequired
name
string
order_nr
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a product

Description

Updates product data.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Update a project

Description

Updates a project.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a recurring subscription

Description

Updates a recurring subscription.

Action Parameters

cycle_amount
integer
description
string
effective_date
stringRequired
id
integerRequired
payments
array
update_deal_value
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a task

Description

Updates a task.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update a team

Description

Updates an existing team and returns the updated object.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update existing goal

Description

Updates an existing goal.

Action Parameters

id
stringRequired
interval
string
title
string

Action Response

data
objectRequired
error
string
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
string
successful
booleanRequired

Tool Name: Update filter

Description

Updates an existing filter.

Action Parameters

id
integerRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update mail thread details

Description

Updates the properties of a mail thread.

Action Parameters

deal_id
integer
id
integerRequired
lead_id
string

Action Response

data
objectRequired
error
string
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

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update role details

Description

Updates the parent role and/or the name of a specific role.

Action Parameters

id
integerRequired
name
string
parent_role_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update stage details

Description

Updates the properties of a stage.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update task in project plan

Description

Updates a task phase or group in a project.

Action Parameters

group_id
integer
id
integerRequired
phase_id
integer
taskId
integerRequired

Action Response

data
objectRequired
error
string
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
string
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
string
successful
booleanRequired