Summary
Wraps the Pipedrive REST API v1 to give Claude direct access to your CRM data. You get five tools: list and fetch deals, list and fetch contacts, and a general search across deals, people, organizations, products, and files. Each tool returns the basics like IDs, titles, and values, with the get methods pulling full details including custom fields and associations. It's part of Pipeworx, a hosted MCP gateway, so you connect via their endpoint rather than running it locally. Useful when you want Claude to answer questions about your pipeline, pull contact details, or search across your Pipedrive instance without switching contexts.
Keep your Mac awake while Claude Code and 40+ AI agents run. Sleeps when they're idle.
One time payment $9 →
Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →
Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →
On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →
Tools
Public tool metadata for what this MCP can expose to an agent.
80 tools
PIPEDRIVE_ADD_A_CALL_LOGAdds a new call log.14 params
Adds a new call log.
Parameters* required
notestringThe note for the call log in HTML format
org_idintegerThe ID of the organization this call is associated with
deal_idintegerThe ID of the deal this call is associated with. A call log can be associated with either a deal or a lead, but not both at once.
lead_idstringThe ID of the lead in the UUID format this call is associated with. A call log can be associated with either a deal or a lead, but not both at once.
outcomestringDescribes the outcome of the callone of
connected · no_answer · left_message · left_voicemail · wrong_number · busysubjectstringThe name of the activity this call is attached to
user_idintegerThe ID of the owner of the call log. Please note that a user without account settings access cannot create call logs for other users.
durationstringThe duration of the call in seconds
end_timestringThe date and time of the end of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
person_idintegerThe ID of the person this call is associated with
start_timestringThe date and time of the start of the call in UTC. Format: YYYY-MM-DD HH:MM:SS.
activity_idintegerIf specified, this activity will be converted into a call log, with the information provided. When this field is used, you don"t need to specify `deal_id`, `person_id` or `org_id`, as they will be ignored in favor of the values already available in the activity. The `activity_id` must refer to a `call` type activity.
to_phone_numberstringThe number called
from_phone_numberstringThe number that made the call
PIPEDRIVE_ADD_A_CHANNELNew 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.5 params
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.
Parameters* required
namestringThe name of the channel
avatar_urlstringThe URL for an icon that represents your channel
provider_typestringIt controls the icons (like the icon next to the conversation)one of
facebook · whatsapp · otherdefault: othertemplate_supportbooleanIf true, enables templates logic on UI. Requires getTemplates endpoint implemented. Find out more [here](https://pipedrive.readme.io/docs/implementing-messaging-app-extension). default: false
provider_channel_idstringThe channel ID
PIPEDRIVE_ADD_A_COMMENT_TO_A_NOTEAdds a new comment to a note.2 params
Adds a new comment to a note.
Parameters* required
idintegerThe ID of the note
contentstringThe content of the comment in HTML format. Subject to sanitization on the back-end.
PIPEDRIVE_ADD_A_DEALAdd 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.12 params
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.
Parameters* required
titlestringThe deal title
valuenumberMonetary value of the deal
org_idintegerID of the organization
statusstringStatus of the deal (open, won, lost). Defaults to open
user_idintegerID of the user who will be marked as owner of this deal
currencystringCurrency for the deal value (3-letter ISO code)
stage_idintegerStage ID for the deal
person_idintegerID of the person this deal is linked to
visible_tointegerVisibility of the deal (owner, entire company etc)
pipeline_idintegerPipeline ID for the deal
probabilitynumberSuccess probability percentage (0-100)
expected_close_datestringExpected close date in format YYYY-MM-DD
PIPEDRIVE_ADD_A_FOLLOWER_TO_A_DEALAdds a follower to a deal.2 params
Adds a follower to a deal.
Parameters* required
idintegerThe ID of the deal
user_idintegerThe ID of the user
PIPEDRIVE_ADD_A_FOLLOWER_TO_AN_ORGANIZATIONAdds a follower to an organization.2 params
Adds a follower to an organization.
Parameters* required
idintegerThe ID of the organization
user_idintegerThe ID of the user
PIPEDRIVE_ADD_A_FOLLOWER_TO_A_PERSONAdds a follower to a person.2 params
Adds a follower to a person.
Parameters* required
idintegerThe ID of the person
user_idintegerThe ID of the user
PIPEDRIVE_ADD_A_FOLLOWER_TO_A_PRODUCTAdds a follower to a product.2 params
Adds a follower to a product.
Parameters* required
idintegerThe ID of the product
user_idintegerThe ID of the user
PIPEDRIVE_ADD_A_LEADPipedrive 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.9 params
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.
Parameters* required
titlestringThe name of the lead
owner_idintegerThe ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.
was_seenbooleanA flag indicating whether the lead was seen by someone in the Pipedrive UI
label_idsarrayThe IDs of the lead labels which will be associated with the lead
person_idintegerThe ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless `organization_id` is specified.
value__amountintegerAmount
organization_idintegerThe ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless `person_id` is specified.
value__currencystringCurrency
expected_close_datestringThe date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
PIPEDRIVE_ADD_A_LEAD_LABELCreates a lead label.2 params
Creates a lead label.
Parameters* required
namestringThe name of the lead label
colorstringThe color of the label. Only a subset of colors can be used.one of
green · blue · red · yellow · purple · grayPIPEDRIVE_ADD_AN_ACTIVITYNew 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).18 params
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).
Parameters* required
doneintegerWhether the activity is done (0 = not done, 1 = done)
notestringNote/description of the activity
typestringThe type of the activity (matches ActivityTypes.key_string)
org_idintegerID of the linked organization
deal_idintegerID of the linked deal (integer or numeric string)
lead_idstringID of the linked lead (UUID string)
subjectstringThe subject/title of the activity
user_idintegerID of the user who owns the activity
due_datestringDue date of the activity (YYYY-MM-DD)
due_timestringDue time of the activity (HH:MM)
durationstringDuration of the activity (e.g., 00:30)
locationstringLocation/address of the activity
attendeesarrayAttendees of the activity (contacts or external emails)
busy_flagbooleanWhether the activity marks the assignee as busy
person_idintegerID of the linked person
project_idintegerID of the linked project
participantsarrayParticipants of the activity
public_descriptionstringPublic description synced to external calendar
PIPEDRIVE_ADD_A_NEW_DEAL_FIELDAdds 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>.4 params
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>.
Parameters* required
namestringThe name of the field
optionsarrayWhen `field_type` is either `set` or `enum`, possible options must be supplied [{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]
field_typestringThe type of the field. Supported values: varchar, varchar_auto, text, double, monetary, date, set, enum, user, org, people, phone, time, timerange, daterange, addressone of
varchar · varchar_auto · text · double · monetary · dateadd_visible_flagbooleanWhether the field is available in "add new" modal or not (both in web and mobile app)
PIPEDRIVE_ADD_A_NEW_FILTERNew 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.3 params
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.
Parameters* required
namestringThe name of the filter
typestringThe type of the filter. One of: deals, leads, org, people, products, activity, projects
conditionsobjectFilter conditions object. Must follow structure with a top-level 'and' group containing two groups (one 'and' and one 'or').
PIPEDRIVE_ADD_A_NEW_GOALAdds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.6 params
Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.
Parameters* required
typeobjectThe type of the goal and its parameters
titlestringThe title of the goal
assigneeobjectThe assignee of the goal
durationobjectGoal active duration
intervalstringThe interval of the goalone of
weekly · monthly · quarterly · yearlyexpected_outcomeobjectExpected outcome configuration
PIPEDRIVE_ADD_A_NEW_ORGANIZATION_FIELDAdds 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>.4 params
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>.
Parameters* required
namestringThe name of the field
optionsarrayWhen `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]`
field_typestringThe type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table> one of
varchar · varchar_auto · text · double · monetary · dateadd_visible_flagbooleanWhether the field is available in "add new" modal or not (both in web and mobile app)
PIPEDRIVE_ADD_A_NEW_PERSON_FIELDAdds 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>.5 params
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>.
Parameters* required
namestringThe name of the field
optionsarrayWhen field_type is either set or enum, possible options must be supplied as a JSON-encoded sequential array, for example: [{"label":"red"}, {"label":"blue"}]
api_tokenstringOptional API token to use as query parameter when OAuth scope does not permit POST; if provided, overrides Authorization header.
field_typestringThe type of the field. Allowed: address, date, daterange, double, enum, monetary, org, people, phone, set, text, time, timerange, user, varchar, varchar_auto, visible_to.one of
address · date · daterange · double · enum · monetaryadd_visible_flagbooleanWhether the field is available in the add new modal (web and mobile). Default true.
PIPEDRIVE_ADD_A_NEW_PIPELINEAdds a new pipeline (v2).2 params
Adds a new pipeline (v2).
Parameters* required
namestringThe name of the pipeline
is_deal_probability_enabledbooleanWhether deal probability is enabled for this pipeline
PIPEDRIVE_ADD_A_NEW_PRODUCT_FIELDAdds 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>.3 params
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>.
Parameters* required
namestringThe name of the field
optionsarrayWhen `field_type` is either `set` or `enum`, possible options must be supplied as a JSON-encoded sequential array, for example:</br>`[{"label":"red"}, {"label":"blue"}, {"label":"lilac"}]`
field_typestringThe type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a product ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field (autocompleted by Google Maps)</dd></table> one of
varchar · varchar_auto · text · double · monetary · datePIPEDRIVE_ADD_A_NEW_STAGEAdds a new stage, returns the ID upon success.5 params
Adds a new stage, returns the ID upon success.
Parameters* required
namestringThe name of the stage
pipeline_idintegerThe ID of the pipeline to add stage to
rotten_daysintegerThe number of days the deals not updated in this stage would become rotten. Applies only if the `rotten_flag` is set. (v2: days_to_rotten)
rotten_flagbooleanWhether deals in this stage can become rotten (v1: rotten_flag; v2: is_deal_rot_enabled)
deal_probabilityintegerThe success probability percentage of the deal. Used/shown when deal weighted values are used.
PIPEDRIVE_ADD_A_NEW_TEAMAdds a new team to the company and returns the created object.4 params
Adds a new team to the company and returns the created object.
Parameters* required
namestringThe team name
usersarrayThe list of user IDs
manager_idintegerThe team manager ID
descriptionstringThe team description
PIPEDRIVE_ADD_A_NEW_USERAdds a new user to the company, returns the ID upon success.3 params
Adds a new user to the company, returns the ID upon success.
Parameters* required
emailstringThe email of the user
accessarrayThe access given to the user. Each item in the array represents access to a specific app. Optionally may include either admin flag or permission set ID to specify which access to give within the app. If both are omitted, the default access for the corresponding app will be used. It requires structure as follows: `[{ app: "sales", permission_set_id: "62cc4d7f-4038-4352-abf3-a8c1c822b631" }, { app: "global", admin: true }, { app: "account_settings" }]`
active_flagbooleanWhether the user is active or not. `false` = Not activated, `true` = Activated default: true
PIPEDRIVE_ADD_AN_INSTALLMENT_SUBSCRIPTIONAdds 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.4 params
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.
Parameters* required
deal_idintegerThe ID of the deal this installment subscription is associated with
currencystringThe currency of the installment subscription. Accepts a 3-character currency code.
paymentsarrayArray of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
update_deal_valuebooleanIndicates that the deal value must be set to the installment subscription"s total value
PIPEDRIVE_ADD_AN_ORGANIZATIONSet up a new Pipedrive organization using custom fields with unique key hashes. Retrieve `organizationFields` for configuration. Check the linked tutorial for guidance.3 params
Set up a new Pipedrive organization using custom fields with unique key hashes. Retrieve `organizationFields` for configuration. Check the linked tutorial for guidance.
Parameters* required
namestringOrganization name
owner_idintegerOwner user ID
visible_tointegerVisibility (e.g., 1=owner only, 3=entire company)
PIPEDRIVE_ADD_A_NOTEAdd 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.7 params
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.
Parameters* required
org_idintegerThe ID of the organization this note will be attached to. Required unless one of (deal_id/person_id/lead_id/project_id) is specified.
contentstringThe content of the note in HTML format. Subject to sanitization on the back-end.
deal_idintegerThe ID of the deal the note will be attached to. Required unless one of (lead_id/person_id/org_id/project_id) is specified.
lead_idstringThe ID of the lead the note will be attached to (UUID format). Required unless one of (deal_id/person_id/org_id/project_id) is specified.
add_timestringThe optional creation date & time of the note in UTC. Format: YYYY-MM-DD HH:MM:SS
person_idintegerThe ID of the person this note will be attached to. Required unless one of (deal_id/lead_id/org_id/project_id) is specified.
project_idintegerThe ID of the project the note will be attached to. Required unless one of (deal_id/person_id/org_id/lead_id) is specified.
PIPEDRIVE_ADD_A_PARTICIPANT_TO_A_DEALAdds a participant to a deal.2 params
Adds a participant to a deal.
Parameters* required
idintegerThe ID of the deal
person_idintegerThe ID of the person
PIPEDRIVE_ADD_A_PERSONAdd 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.10 params
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.
Parameters* required
namestringThe name of the person
emailarrayList of email objects: { value: string, label?: string, primary?: bool }
phonearrayList of phone objects: { value: string, label?: string, primary?: bool }
org_idintegerID of the linked organization
add_timestringCreation time (RFC 3339)
owner_idintegerID of the user who will be marked as the owner of this person
label_idsarrayIDs of labels to assign to the person
visible_tointegerVisibility of the person (e.g., 1=owner only, 3=entire company)
update_timestringLast update time (RFC 3339)
marketing_statusstringMarketing status (no_consent, unsubscribed, subscribed, archived). Field is available only when Campaigns is enabled.
PIPEDRIVE_ADD_A_PRODUCTAdds 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>.12 params
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>.
Parameters* required
taxnumberTax percentage
codestringProduct code
namestringProduct name; cannot be empty
unitstringSales unit of the product
pricesarrayArray of prices per currency
categoryintegerProduct category
owner_idintegerOwner user ID; if omitted, authorized user ID is used
visible_tointegerProduct visibility setting
descriptionstringProduct description
is_linkablebooleanWhether the product can be added to a deal
billing_frequencystringBilling frequency (one-time, annually, semi-annually, quarterly, monthly, weekly)
billing_frequency_cyclesintegerNumber of billing repeats (rules depend on billing_frequency)
PIPEDRIVE_ADD_A_PRODUCT_TO_A_DEALAdds a product to a deal, creating a new item called a deal-product.13 params
Adds a product to a deal, creating a new item called a deal-product.
Parameters* required
idintegerThe ID of the deal
taxnumberTax percentage
commentsstringComments for the product
discountnumberDiscount value
durationintegerSubscription duration (v1)
quantitynumberQuantity of the product
item_pricenumberPrice of the product
product_idintegerThe ID of the product to attach
tax_methodstringTax method (exclusive, inclusive, none)
enabled_flagbooleanWhether product is enabled
discount_typestringType of discount (percentage or amount)
duration_unitstringDuration unit (v1)
product_variation_idintegerProduct variation ID
PIPEDRIVE_ADD_A_PROJECTAdds 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.13 params
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.
Parameters* required
titlestringThe title of the project
labelsarrayIDs of labels for this project
org_idintegerID of associated organization
statusstringProject status
board_idintegerThe ID of a project board
deal_idsarrayIDs of deals associated with this project
end_datestringProject end date (YYYY-MM-DD)
owner_idintegerProject owner's ID
phase_idintegerThe ID of a phase on the project board
person_idintegerID of associated person
start_datestringProject start date (YYYY-MM-DD)
descriptionstringProject description
template_idintegerID of the template the project will be based on
PIPEDRIVE_ADD_A_RECURRING_SUBSCRIPTIONAdds a new recurring subscription.10 params
Adds a new recurring subscription.
Parameters* required
deal_idintegerThe ID of the deal this recurring subscription is associated with
currencystringThe currency of the recurring subscription. Accepts a 3-character currency code.
infinitebooleanThis indicates that the recurring subscription will last until it"s manually canceled or deleted. Note that only one field must be set: `cycles_count` or `infinite`.
paymentsarrayArray of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
start_datestringThe start date of the recurring subscription. Format: YYYY-MM-DD
descriptionstringThe description of the recurring subscription
cadence_typestringThe interval between paymentsone of
weekly · monthly · quarterly · yearlycycle_amountintegerThe amount of each payment
cycles_countintegerShows how many payments the subscription has. Note that one field must be set: `cycles_count` or `infinite`. If `cycles_count` is set, then `cycle_amount` and `start_date` are also required.
update_deal_valuebooleanIndicates that the deal value must be set to recurring subscription"s MRR value
PIPEDRIVE_ADD_A_ROLEAdds 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...2 params
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...
Parameters* required
namestringThe name of the role
parent_role_idintegerThe ID of the parent role
PIPEDRIVE_ADD_A_TASKAdds a new task.7 params
Adds a new task.
Parameters* required
doneinteger0 = Not done, 1 = Done
titlestringThe title of the task
due_datestringThe task’s due date (YYYY-MM-DD)
project_idintegerThe ID of a project
assignee_idintegerThe assignee user ID
descriptionstringThe description of the task
parent_task_idintegerThe ID of a parent task; cannot be a subtask’s ID
PIPEDRIVE_ADD_FILEUpload and link files to deals, people, organizations, activities, products, or leads in Pipedrive. See the "adding a file" tutorial for details.7 params
Upload and link files to deals, people, organizations, activities, products, or leads in Pipedrive. See the "adding a file" tutorial for details.
Parameters* required
fileobjectFile to upload (base64 content supported)
org_idintegerOrg Id
deal_idintegerDeal Id
lead_idstringLead Id (UUID)
person_idintegerPerson Id
product_idintegerProduct Id
activity_idintegerActivity Id
PIPEDRIVE_ADD_NEW_ACTIVITY_TYPEAdds a new activity type.3 params
Adds a new activity type.
Parameters* required
namestringThe name of the activity type
colorstringA designated color for the activity type in 6-character HEX format (e.g. `FFFFFF` for white, `000000` for black)
icon_keystringIcon graphic to use for representing this activity typeone of
task · email · meeting · deadline · call · lunchPIPEDRIVE_ADD_OR_UPDATE_ROLE_SETTINGAdds 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...3 params
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...
Parameters* required
idintegerThe ID of the role
valueintegerPossible values for the `default_visibility` setting depending on the subscription plan:<br> <table class="role-setting"> <caption><b>Essential / Advanced plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner & Followers</td></tr> <tr><td>`3`</td><td>Entire company</td></tr> </table> <br> <table class="role-setting"> <caption><b>Professional / Enterprise plan</b></caption> <tr><th><b>Value</b></th><th><b>Description</b></th></tr> <tr><td>`1`</td><td>Owner only</td></tr> <tr><td>`3`</td><td>Owner's visibility group</td></tr> <tr><td>`5`</td><td>Owner's visibility group and sub-groups</td></tr> <tr><td>`7`</td><td>Entire company</td></tr> </table> <br> Read more about visibility groups <a href="https://support.pipedrive.com/en/article/visibility-groups">here</a>.
setting_keystringSetting Keyone of
deal_default_visibility · lead_default_visibility · org_default_visibility · person_default_visibility · product_default_visibilityPIPEDRIVE_ADD_PERSON_PICTUREThis 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.6 params
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.
Parameters* required
idintegerThe ID of the person
fileobjectImage file to set as the person's picture (GIF/JPG/PNG)
crop_xintegerCrop X (pixels)
crop_yintegerCrop Y (pixels)
crop_widthintegerCrop width (pixels)
crop_heightintegerCrop height (pixels)
PIPEDRIVE_ADD_ROLE_ASSIGNMENTAssigns 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 ensur...2 params
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 ensur...
Parameters* required
idintegerThe ID of the role
user_idintegerThe ID of the user
PIPEDRIVE_ADD_USERS_TO_A_TEAMAdds users to an existing team.2 params
Adds users to an existing team.
Parameters* required
idintegerThe ID of the team
usersarrayThe list of user IDs
PIPEDRIVE_ARCHIVE_A_PROJECTArchives a project.1 params
Archives a project.
Parameters* required
idintegerThe ID of the project
PIPEDRIVE_ATTACH_AN_AUDIO_FILE_TO_THE_CALL_LOGAdds an audio recording to the call log. That audio can be played by those who have access to the call log object.2 params
Adds an audio recording to the call log. That audio can be played by those who have access to the call log object.
Parameters* required
idstringThe ID received when you create the call log
fileobjectFile
PIPEDRIVE_CANCEL_A_RECURRING_SUBSCRIPTIONCancels 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`) t...2 params
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`) t...
Parameters* required
idintegerThe ID of the subscription. Fallback: treated as the deal ID when Subscriptions API is unavailable.
end_datestringThe subscription termination date. All payments after the specified date will be deleted. The end_date of the subscription will be set to the due date of the payment to follow the specified date. Default value is the current date.
PIPEDRIVE_CREATE_A_NEW_WEBHOOKCreates 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.8 params
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.
Parameters* required
namestringThe webhook’s name
user_idintegerThe ID of the user that this webhook will be authorized with. You have the option to use a different user"s `user_id`. If it is not set, the current user"s `user_id` will be used. As each webhook event is checked against a user"s permissions, the webhook will only be sent if the user has access to the specified object(s). If you want to receive notifications for all events, please use a top-level admin user’s `user_id`.
versionstringThe webhook"s versionone of
1.0 · 2.0default: 2.0event_actionstringThe type of action to receive notifications about. Wildcard will match all supported actions. one of
added · updated · merged · deleted · create · changeevent_objectstringThe type of object to receive notifications about. Wildcard will match all supported objects. one of
activity · activityType · deal · note · organization · personhttp_auth_userstringThe HTTP basic auth username of the subscription URL endpoint (if required)
subscription_urlstringA full, valid, publicly accessible URL which determines where to send the notifications. Please note that you cannot use Pipedrive API endpoints as the `subscription_url` and the chosen URL must not redirect to another link.
http_auth_passwordstringThe HTTP basic auth password of the subscription URL endpoint (if required)
PIPEDRIVE_CREATE_AN_ORGANIZATION_RELATIONSHIPCreates and returns an organization relationship.4 params
Creates and returns an organization relationship.
Parameters* required
typestringThe type of organization relationshipone of
parent · relatedorg_idintegerThe ID of the base organization for the returned calculated values
rel_owner_org_idintegerThe owner of the relationship. If type is `parent`, then the owner is the parent and the linked organization is the daughter.
rel_linked_org_idintegerThe linked organization in the relationship. If type is `parent`, then the linked organization is the daughter.
PIPEDRIVE_CREATE_A_REMOTE_FILE_AND_LINK_IT_TO_AN_ITEMCreates an empty file on Google Drive linked to an item. For details, refer to the Pipedrive remote file adding tutorial.5 params
Creates an empty file on Google Drive linked to an item. For details, refer to the Pipedrive remote file adding tutorial.
Parameters* required
titlestringThe title of the file
item_idintegerThe ID of the item to associate the file with
file_typestringThe file typeone of
gdoc · gslides · gsheet · gform · gdrawitem_typestringThe item typeone of
deal · organization · personremote_locationstringThe location type to send the file to. Only `googledrive` is supported at the moment. one of
googledrivePIPEDRIVE_DELETE_A_CALL_LOGDeletes 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.1 params
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.
Parameters* required
idstringThe ID received when you create the call log
PIPEDRIVE_DELETE_A_CHANNELThe endpoint removes a messenger channel along with conversations and messages. Requires Messengers integration OAuth and Messaging app extension manifest.1 params
The endpoint removes a messenger channel along with conversations and messages. Requires Messengers integration OAuth and Messaging app extension manifest.
Parameters* required
idstringThe ID of the channel provided by the integration
PIPEDRIVE_DELETE_A_COMMENT_RELATED_TO_A_NOTEDeletes a comment.2 params
Deletes a comment.
Parameters* required
idintegerThe ID of the note
commentIdstringThe ID of the comment
PIPEDRIVE_DELETE_A_CONVERSATIONDeletes 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).2 params
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).
Parameters* required
channel__idstringThe ID of the channel provided by the integration
conversation__idstringThe ID of the conversation provided by the integration
PIPEDRIVE_DELETE_A_DEALMarks a deal as deleted. After 30 days, the deal will be permanently deleted.1 params
Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
Parameters* required
idintegerThe ID of the deal
PIPEDRIVE_DELETE_A_DEAL_FIELDMarks 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>.1 params
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>.
Parameters* required
idintegerThe ID of the field
PIPEDRIVE_DELETE_A_FILEMarks a file as deleted. After 30 days, the file will be permanently deleted.1 params
Marks a file as deleted. After 30 days, the file will be permanently deleted.
Parameters* required
idintegerThe ID of the file
PIPEDRIVE_DELETE_A_FILTERMarks a filter as deleted.1 params
Marks a filter as deleted.
Parameters* required
idintegerThe ID of the filter
PIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_DEALDeletes a follower from a deal.2 params
Deletes a follower from a deal.
Parameters* required
idintegerThe ID of the deal
follower_idintegerThe ID of the follower
PIPEDRIVE_DELETE_A_FOLLOWER_FROM_AN_ORGANIZATIONDeletes 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.2 params
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.
Parameters* required
idintegerThe ID of the organization
follower_idintegerThe ID of the follower
PIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_PERSONDeletes a follower from a person.2 params
Deletes a follower from a person.
Parameters* required
idintegerThe ID of the person
follower_idintegerThe ID of the follower
PIPEDRIVE_DELETE_A_FOLLOWER_FROM_A_PRODUCTDeletes a follower from a product.2 params
Deletes a follower from a product.
Parameters* required
idintegerThe ID of the product
follower_idintegerThe ID of the relationship between the follower and the product
PIPEDRIVE_DELETE_A_LEADDeletes a specific lead.1 params
Deletes a specific lead.
Parameters* required
idstringThe ID of the lead
PIPEDRIVE_DELETE_A_LEAD_LABELDeletes a specific lead label.1 params
Deletes a specific lead label.
Parameters* required
idstringThe ID of the lead label
PIPEDRIVE_DELETE_AN_ACTIVITYMarks an activity as deleted. After 30 days, the activity will be permanently deleted.1 params
Marks an activity as deleted. After 30 days, the activity will be permanently deleted.
Parameters* required
idintegerThe ID of the activity
PIPEDRIVE_DELETE_AN_ACTIVITY_TYPEMarks an activity type as deleted.1 params
Marks an activity type as deleted.
Parameters* required
idintegerThe ID of the activity type
PIPEDRIVE_DELETE_AN_ATTACHED_PRODUCT_FROM_A_DEALDeletes a product attachment from a deal, using the `product_attachment_id`.2 params
Deletes a product attachment from a deal, using the `product_attachment_id`.
Parameters* required
idintegerThe ID of the deal
product_attachment_idintegerThe product attachment ID
PIPEDRIVE_DELETE_AN_ORGANIZATIONMarks an organization as deleted. After 30 days, the organization will be permanently deleted.1 params
Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
Parameters* required
idintegerThe ID of the organization
PIPEDRIVE_DELETE_AN_ORGANIZATION_FIELDMarks 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>.1 params
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>.
Parameters* required
idintegerThe ID of the field
PIPEDRIVE_DELETE_AN_ORGANIZATION_RELATIONSHIPDeletes an organization relationship and returns the deleted ID.1 params
Deletes an organization relationship and returns the deleted ID.
Parameters* required
idintegerThe ID of the organization relationship
PIPEDRIVE_DELETE_A_NOTEDeletes a specific note.1 params
Deletes a specific note.
Parameters* required
idintegerThe ID of the note
PIPEDRIVE_DELETE_A_PARTICIPANT_FROM_A_DEALDeletes a participant from a deal.2 params
Deletes a participant from a deal.
Parameters* required
idintegerThe ID of the deal
deal_participant_idintegerThe ID of the participant of the deal
PIPEDRIVE_DELETE_A_PERSONMarks a person as deleted. After 30 days, the person will be permanently deleted.1 params
Marks a person as deleted. After 30 days, the person will be permanently deleted.
Parameters* required
idintegerThe ID of the person
PIPEDRIVE_DELETE_A_PERSON_FIELDMarks 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>.1 params
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>.
Parameters* required
idintegerThe ID of the field
PIPEDRIVE_DELETE_A_PIPELINEMarks a pipeline as deleted.1 params
Marks a pipeline as deleted.
Parameters* required
idintegerThe ID of the pipeline
PIPEDRIVE_DELETE_A_PRODUCTMarks a product as deleted. After 30 days, the product will be permanently deleted.1 params
Marks a product as deleted. After 30 days, the product will be permanently deleted.
Parameters* required
idintegerThe ID of the product
PIPEDRIVE_DELETE_A_PRODUCT_FIELDMarks 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>.1 params
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>.
Parameters* required
idintegerThe ID of the product field
PIPEDRIVE_DELETE_A_PROJECTMarks a project as deleted.1 params
Marks a project as deleted.
Parameters* required
idintegerThe ID of the project
PIPEDRIVE_DELETE_A_ROLEMarks a role as deleted.1 params
Marks a role as deleted.
Parameters* required
idintegerThe ID of the role
PIPEDRIVE_DELETE_A_ROLE_ASSIGNMENTRemoves the assigned user from a role and adds to the default role.2 params
Removes the assigned user from a role and adds to the default role.
Parameters* required
idintegerThe ID of the role
user_idintegerThe ID of the user
PIPEDRIVE_DELETE_A_STAGEMarks a stage as deleted. Uses the company-domain v2 endpoint.1 params
Marks a stage as deleted. Uses the company-domain v2 endpoint.
Parameters* required
idintegerThe ID of the stage
PIPEDRIVE_DELETE_A_SUBSCRIPTIONMarks an installment or a recurring subscription as deleted.1 params
Marks an installment or a recurring subscription as deleted.
Parameters* required
idintegerThe ID of the subscription
PIPEDRIVE_DELETE_A_TASKMarks a task as deleted. If the task has subtasks then those will also be deleted.1 params
Marks a task as deleted. If the task has subtasks then those will also be deleted.
Parameters* required
idintegerThe ID of the task
PIPEDRIVE_DELETE_EXISTING_GOALMarks 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.1 params
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.
Parameters* required
idstringThe ID of the goal
PIPEDRIVE_DELETE_EXISTING_WEBHOOKDeletes the specified Webhook.1 params
Deletes the specified Webhook.
Parameters* required
idintegerThe ID of the Webhook to delete
PIPEDRIVE_DELETE_MAIL_THREADMarks a mail thread as deleted.1 params
Marks a mail thread as deleted.
Parameters* required
idintegerThe ID of the mail thread
mcp-pipedrive
Pipedrive MCP Pack — wraps the Pipedrive REST API v1
Part of Pipeworx — an MCP gateway connecting AI agents to 673+ live data sources.
Tools
| Tool | Description |
|---|---|
pipedrive_list_deals | View all deals in your pipeline. Returns deal IDs, titles, values, stages, and owners. Use pipedrive_get_deal for full details on a specific deal. |
pipedrive_get_deal | Get complete details for a specific deal (by ID). Returns title, value, stage, probability, owner, associated contacts, and timeline. |
pipedrive_list_persons | View all contacts in your CRM. Returns names, email addresses, phone numbers, and associated organizations and deals. |
pipedrive_get_person | Get full contact details by ID. Returns name, emails, phones, organization, associated deals, and custom fields. |
pipedrive_search | Search deals, contacts, organizations, products, or files by keyword. Returns matching records with IDs and basic info. |
Quick Start
Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
{
"mcpServers": {
"pipedrive": {
"url": "https://gateway.pipeworx.io/pipedrive/mcp"
}
}
}
Or connect to the full Pipeworx gateway for access to all 673+ data sources:
{
"mcpServers": {
"pipeworx": {
"url": "https://gateway.pipeworx.io/mcp"
}
}
}
Using with ask_pipeworx
Instead of calling tools directly, you can ask questions in plain English:
ask_pipeworx({ question: "your question about Pipedrive data" })
The gateway picks the right tool and fills the arguments automatically.
More
License
MIT
Featured
Keep your Mac awake while Claude Code and 40+ AI agents run. Sleeps when they're idle.
One time payment $9 →Integrate web data into your AI product. One API to scrape website & brand data.
Get API Key Now →Agent, run crypto. Access onchain data & trade routes via 1inch.
Install now →On Capafy, your Skill runs online 24/7 as an agent product, and you get paid every time someone uses it.
Start earning →