Skip to content
Scalekit Docs
Talk to an EngineerDashboard

Pipedrive connector

OAuth 2.0CRM & Sales

Connect to Pipedrive CRM. Manage deals, contacts, organizations, activities, leads, and notes to streamline your sales pipeline.

Pipedrive connector

  1. Install the SDK

    Section titled “Install the SDK”
    Terminal window
    npm install @scalekit-sdk/node

    Full SDK reference: Node.js | Python

  2. Set your credentials

    Section titled “Set your credentials”

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>

  3. Set up the connector

    Section titled “Set up the connector”

    Register your Pipedrive credentials with Scalekit so it handles the token lifecycle. You do this once per environment.

    Dashboard setup steps

    Register your Scalekit environment with the Pipedrive connector so Scalekit handles the OAuth flow and token lifecycle on your behalf. The connection name you create is used to identify and invoke the connection in code.

    1. Create a connection in Scalekit

      • In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find Pipedrive and click Create.

      • Click Use your own credentials and copy the Redirect URI. It looks like: https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback

      Keep this tab open — you’ll return to it in step 3.

    2. Create a Pipedrive OAuth app

      • Go to the Pipedrive Developer Hub and sign in with your Pipedrive account.

      • Create a new app and fill in the form:

        • App name — a name to identify your app (e.g., My Sales Agent)
        • Callback URL — paste the Redirect URI you copied from Scalekit

      • Under OAuth & Access Scopes, select the permissions your agent needs:

        ScopeAccess granted
        deals:fullRead and write deals
        contacts:fullRead and write persons and organizations
        leads:fullRead and write leads
        activities:fullRead and write activities
        products:fullRead and write products
        users:readRead user information
        webhooks:fullManage webhooks

      • Click Save.

    3. Copy your client credentials

      After saving your app, Pipedrive shows the Client ID and Client Secret.

      Copy both values now — you will need them in the next step.

    4. Add credentials in Scalekit

      • Return to Scalekit dashboard → AgentKit > Connections and open the connection you created in step 1.

      • Enter the following:

        • Client ID — from Pipedrive
        • Client Secret — from Pipedrive
        • Permissions — the same scopes you selected in Pipedrive

      • Click Save.

  4. Authorize and make your first call

    Section titled “Authorize and make your first call”
    quickstart.ts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    

    const scalekit = new ScalekitClient(
      process.env.SCALEKIT_ENV_URL,
      process.env.SCALEKIT_CLIENT_ID,
      process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    

    const connector = 'pipedrive'
    const identifier = 'user_123'
    

    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Pipedrive:', link)
    process.stdout.write('Press Enter after authorizing...')
    await new Promise(r => process.stdin.once('data', r))
    

    // Make your first call
    const result = await actions.executeTool({
      connector,
      identifier,
      toolName: 'pipedrive_activities_list',
      toolInput: {},
    })
    console.log(result)

What you can do

Section titled “What you can do”

Connect this agent connector to let your agent:

  • Update user, filter, deal product — Update a Pipedrive user’s activation status
  • Create user, filter, person — Invite a new user to the Pipedrive account by email, optionally setting their app access level and active status
  • List stage deals, product followers, product fields — List the deals currently sitting in a specific pipeline stage, optionally filtered by owner or a saved filter
  • Delete product follower, person follower, organization follower — Remove a follower from a product in Pipedrive
  • Add product follower, person follower, organization follower — Add a user as a follower of a product so they receive updates about it in Pipedrive
  • Statistics pipeline movement, pipeline conversion — Get counts of how deals moved into and out of each stage of a pipeline over a given date range

Tool list

Section titled “Tool list”

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

pipedrive_activities_list#Retrieve a list of activities from Pipedrive. Filter by owner, deal, person, organization, completion status, and date range.8 params

Retrieve a list of activities from Pipedrive. Filter by owner, deal, person, organization, completion status, and date range.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
deal_idintegeroptionalFilter activities by deal ID.
donebooleanoptionalFilter by completion status: true for done, false for undone.
limitintegeroptionalNumber of activities to return per page (max 500).
org_idintegeroptionalFilter activities by organization ID.
owner_idintegeroptionalFilter activities by owner user ID.
person_idintegeroptionalFilter activities by person ID.
updated_sincestringoptionalFilter activities updated after this RFC3339 datetime.
pipedrive_activity_create#Create a new activity in Pipedrive such as a call, meeting, email, or task. Associate it with a deal, person, or organization.9 params

Create a new activity in Pipedrive such as a call, meeting, email, or task. Associate it with a deal, person, or organization.

NameTypeRequiredDescription
subjectstringrequiredSubject/title of the activity.
deal_idintegeroptionalID of the deal to associate this activity with.
due_datestringoptionalDue date of the activity in YYYY-MM-DD format.
due_timestringoptionalDue time of the activity in HH:MM format.
notestringoptionalNote or description for the activity.
org_idintegeroptionalID of the organization to associate this activity with.
owner_idintegeroptionalID of the user responsible for this activity.
person_idintegeroptionalID of the person to associate this activity with.
typestringoptionalType of activity (e.g., call, meeting, email, task, deadline, lunch).
pipedrive_activity_delete#Delete an activity from Pipedrive by its ID. After 30 days it will be permanently removed.1 param

Delete an activity from Pipedrive by its ID. After 30 days it will be permanently removed.

NameTypeRequiredDescription
idintegerrequiredThe ID of the activity to delete.
pipedrive_activity_get#Retrieve details of a single activity in Pipedrive by its ID, including subject, type, due date/time, and associated deal, person, or organization.1 param

Retrieve details of a single activity in Pipedrive by its ID, including subject, type, due date/time, and associated deal, person, or organization.

NameTypeRequiredDescription
idintegerrequiredThe ID of the activity to retrieve.
pipedrive_activity_types_list#List all activity types in Pipedrive (the valid 'type' values and icons for activities). Use this before creating activities that need a specific type.0 params

List all activity types in Pipedrive (the valid 'type' values and icons for activities). Use this before creating activities that need a specific type.

pipedrive_activity_update#Update an existing activity in Pipedrive. Modify subject, type, due date/time, note, completion status, or associations.8 params

Update an existing activity in Pipedrive. Modify subject, type, due date/time, note, completion status, or associations.

NameTypeRequiredDescription
idintegerrequiredThe ID of the activity to update.
deal_idintegeroptionalID of the deal to associate this activity with.
donebooleanoptionalMark the activity as done (true) or undone (false).
due_datestringoptionalUpdated due date in YYYY-MM-DD format.
due_timestringoptionalUpdated due time in HH:MM format.
notestringoptionalUpdated note or description for the activity.
subjectstringoptionalUpdated subject/title of the activity.
typestringoptionalUpdated type of activity (e.g., call, meeting, email, task).
pipedrive_deal_create#Create a new deal in Pipedrive with a title, value, currency, pipeline, stage, associated person and organization.9 params

Create a new deal in Pipedrive with a title, value, currency, pipeline, stage, associated person and organization.

NameTypeRequiredDescription
titlestringrequiredTitle of the deal.
currencystringoptionalCurrency code for the deal value (e.g., USD, EUR).
expected_close_datestringoptionalExpected close date in YYYY-MM-DD format.
org_idintegeroptionalID of the organization to associate with this deal.
owner_idintegeroptionalID of the user who owns this deal.
person_idintegeroptionalID of the person to associate with this deal.
pipeline_idintegeroptionalID of the pipeline to place this deal in.
stage_idintegeroptionalID of the pipeline stage for this deal.
valuenumberoptionalMonetary value of the deal.
pipedrive_deal_delete#Delete a deal from Pipedrive by its ID. This action marks the deal as deleted.1 param

Delete a deal from Pipedrive by its ID. This action marks the deal as deleted.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal to delete.
pipedrive_deal_duplicate#Create a copy of an existing deal in Pipedrive, duplicating its fields into a new deal record.1 param

Create a copy of an existing deal in Pipedrive, duplicating its fields into a new deal record.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal to duplicate.
pipedrive_deal_fields_list#Get metadata for all deal fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing deal data.3 params

Get metadata for all deal fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing deal data.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
include_fieldsstringoptionalComma-separated list of extra properties to include, e.g. ui_visibility, important_fields, required_fields.
limitintegeroptionalNumber of fields to return per page (max 500, default 100).
pipedrive_deal_follower_add#Add a user as a follower of a deal so they receive updates about it in Pipedrive.2 params

Add a user as a follower of a deal so they receive updates about it in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal to follow.
user_idintegerrequiredThe ID of the user to add as a follower.
pipedrive_deal_follower_delete#Remove a follower from a deal in Pipedrive.2 params

Remove a follower from a deal in Pipedrive.

NameTypeRequiredDescription
follower_idintegerrequiredThe user ID of the follower to remove.
idintegerrequiredThe ID of the deal.
pipedrive_deal_followers_list#List the users who are following a specific deal in Pipedrive.1 param

List the users who are following a specific deal in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal.
pipedrive_deal_get#Retrieve details of a specific deal in Pipedrive by its ID, including title, value, status, pipeline stage, associated person and organization.1 param

Retrieve details of a specific deal in Pipedrive by its ID, including title, value, status, pipeline stage, associated person and organization.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal to retrieve.
pipedrive_deal_merge#Merge two deals in Pipedrive. The deal given by merge_with_id is merged into the deal given by id, and the source deal is removed.2 params

Merge two deals in Pipedrive. The deal given by merge_with_id is merged into the deal given by id, and the source deal is removed.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal to merge into.
merge_with_idintegerrequiredThe ID of the deal that will be merged into the deal given by id and then removed.
pipedrive_deal_participant_add#Add a person as a participant on a deal in Pipedrive, useful for deals involving multiple stakeholders.2 params

Add a person as a participant on a deal in Pipedrive, useful for deals involving multiple stakeholders.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal.
person_idintegerrequiredThe ID of the person to add as a participant.
pipedrive_deal_participant_delete#Remove a participant from a deal in Pipedrive.2 params

Remove a participant from a deal in Pipedrive.

NameTypeRequiredDescription
deal_participant_idintegerrequiredThe ID of the deal-participant relationship to remove (not the person ID).
idintegerrequiredThe ID of the deal.
pipedrive_deal_participants_list#List the persons who are participants on a specific deal in Pipedrive.1 param

List the persons who are participants on a specific deal in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal.
pipedrive_deal_product_add#Attach a product to a deal in Pipedrive as a line item, with price, quantity, tax, and discount.14 params

Attach a product to a deal in Pipedrive as a line item, with price, quantity, tax, and discount.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal to attach the product to.
item_pricenumberrequiredThe price at which to attach the product for this deal.
product_idintegerrequiredThe ID of the product to attach.
quantitynumberrequiredThe quantity of the product for this deal.
billing_frequencystringoptionalHow often this line item is billed. Defaults to one-time.
billing_frequency_cyclesintegeroptionalNumber of times the billing frequency repeats. Leave empty for indefinite (only valid when billing_frequency is not one-time).
billing_start_datestringoptionalThe date to start billing this line item, in YYYY-MM-DD format. Only valid when billing_frequency is not one-time.
commentsstringoptionalA text comment associated with this line item.
discountnumberoptionalDiscount value for this line item, in the unit given by discount_type. Defaults to 0.
discount_typestringoptionalWhether the discount value is a percentage or a fixed amount. Defaults to percentage.
is_enabledbooleanoptionalWhether this line item is enabled for the deal. Defaults to true.
product_variation_idintegeroptionalThe ID of the specific product variation to use, if any.
taxnumberoptionalTax percentage for this line item. Defaults to 0.
tax_methodstringoptionalHow tax is calculated for this line item.
pipedrive_deal_product_delete#Remove an attached product from a deal in Pipedrive.2 params

Remove an attached product from a deal in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal.
product_attachment_idintegerrequiredThe ID of the product attachment (deal-product) to remove.
pipedrive_deal_product_update#Update a product already attached to a deal in Pipedrive, such as its quantity, price, tax, or discount.13 params

Update a product already attached to a deal in Pipedrive, such as its quantity, price, tax, or discount.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal.
product_attachment_idintegerrequiredThe ID of the product attachment (deal-product) to update.
billing_frequencystringoptionalHow often this line item is billed.
billing_frequency_cyclesintegeroptionalNumber of times the billing frequency repeats. Only valid when billing_frequency is not one-time.
billing_start_datestringoptionalThe date to start billing this line item, in YYYY-MM-DD format.
commentsstringoptionalA text comment associated with this line item.
discountnumberoptionalDiscount value for this line item, in the unit given by discount_type.
discount_typestringoptionalWhether the discount value is a percentage or a fixed amount.
is_enabledbooleanoptionalWhether this line item is enabled for the deal.
item_pricenumberoptionalThe price at which the product is attached for this deal.
quantitynumberoptionalThe quantity of the product for this deal.
taxnumberoptionalTax percentage for this line item.
tax_methodstringoptionalHow tax is calculated for this line item.
pipedrive_deal_products_list#List the products (line items) attached to a deal in Pipedrive, including quantities, pricing, and discounts.5 params

List the products (line items) attached to a deal in Pipedrive, including quantities, pricing, and discounts.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal.
cursorstringoptionalCursor for pagination from a previous response.
limitintegeroptionalNumber of products to return per page (max 500).
sort_bystringoptionalField to sort results by: add_time or update_time.
sort_directionstringoptionalSort direction: asc or desc.
pipedrive_deal_update#Update an existing deal in Pipedrive. Modify title, value, status, pipeline stage, associated person, organization, or close date.11 params

Update an existing deal in Pipedrive. Modify title, value, status, pipeline stage, associated person, organization, or close date.

NameTypeRequiredDescription
idintegerrequiredThe ID of the deal to update.
currencystringoptionalCurrency code for the deal value (e.g., USD, EUR).
expected_close_datestringoptionalExpected close date in YYYY-MM-DD format.
org_idintegeroptionalID of the organization to associate with this deal.
owner_idintegeroptionalID of the user who owns this deal.
person_idintegeroptionalID of the person to associate with this deal.
pipeline_idintegeroptionalID of the pipeline for this deal.
stage_idintegeroptionalID of the pipeline stage for this deal.
statusstringoptionalStatus of the deal: open, won, or lost.
titlestringoptionalNew title for the deal.
valuenumberoptionalMonetary value of the deal.
pipedrive_deals_list#Retrieve a list of deals from Pipedrive. Filter by owner, person, organization, pipeline, stage, and status with cursor-based pagination.9 params

Retrieve a list of deals from Pipedrive. Filter by owner, person, organization, pipeline, stage, and status with cursor-based pagination.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
filter_idintegeroptionalID of a saved filter to apply.
limitintegeroptionalNumber of deals to return per page (max 500).
org_idintegeroptionalFilter deals by organization ID.
owner_idintegeroptionalFilter deals by owner user ID.
person_idintegeroptionalFilter deals by person ID.
pipeline_idintegeroptionalFilter deals by pipeline ID.
stage_idintegeroptionalFilter deals by stage ID.
statusstringoptionalFilter deals by status: open, won, lost, or all_not_deleted.
pipedrive_file_delete#Delete a file from Pipedrive by its ID.1 param

Delete a file from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the file to delete.
pipedrive_file_download#Download the raw contents of a file previously uploaded to Pipedrive, by its file ID.1 param

Download the raw contents of a file previously uploaded to Pipedrive, by its file ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the file to download.
pipedrive_file_get#Retrieve metadata of a specific file in Pipedrive by its ID.1 param

Retrieve metadata of a specific file in Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the file to retrieve.
pipedrive_files_list#Retrieve a list of files attached to Pipedrive records with pagination and sorting.3 params

Retrieve a list of files attached to Pipedrive records with pagination and sorting.

NameTypeRequiredDescription
limitintegeroptionalNumber of files per page.
sortstringoptionalField and direction to sort by (e.g., id DESC, add_time ASC).
startintegeroptionalPagination start offset.
pipedrive_filter_create#Create a new saved filter in Pipedrive for deals, leads, organizations, people, products, activities, or projects, defined by a JSON conditions tree.3 params

Create a new saved filter in Pipedrive for deals, leads, organizations, people, products, activities, or projects, defined by a JSON conditions tree.

NameTypeRequiredDescription
conditionsobjectrequiredThe filter conditions as a JSON object. Maximum 16 conditions per filter; date values must be YYYY-MM-DD. Minimum structure: {"glue":"and","conditions":[{"glue":"and","conditions":[CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}, where each CONDITION_OBJECT is {"object":"deal|person|organization|product|activity","field_id":"","operator":"=|!=|<|<=|>|>=|IS NULL|IS NOT NULL|LIKE '%$%'","value":"","extra_value":""}.
namestringrequiredThe name of the filter.
typestringrequiredThe type of entity this filter applies to.
pipedrive_filter_delete#Permanently delete a saved filter from Pipedrive by its ID.1 param

Permanently delete a saved filter from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the filter to delete.
pipedrive_filter_get#Retrieve details of a single saved filter, including its name, type, and conditions.1 param

Retrieve details of a single saved filter, including its name, type, and conditions.

NameTypeRequiredDescription
idintegerrequiredThe ID of the filter to retrieve.
pipedrive_filter_update#Update an existing saved filter's name and/or conditions.3 params

Update an existing saved filter's name and/or conditions.

NameTypeRequiredDescription
conditionsobjectrequiredThe filter conditions as a JSON object. Maximum 16 conditions per filter; date values must be YYYY-MM-DD. Minimum structure: {"glue":"and","conditions":[{"glue":"and","conditions":[CONDITION_OBJECTS]},{"glue":"or","conditions":[CONDITION_OBJECTS]}]}, where each CONDITION_OBJECT is {"object":"deal|person|organization|product|activity","field_id":"","operator":"=|!=|<|<=|>|>=|IS NULL|IS NOT NULL|LIKE '%$%'","value":"","extra_value":""}.
idintegerrequiredThe ID of the filter to update.
namestringoptionalThe new name of the filter.
pipedrive_filters_list#Retrieve all saved filters in the Pipedrive account, optionally scoped to a specific entity type.1 param

Retrieve all saved filters in the Pipedrive account, optionally scoped to a specific entity type.

NameTypeRequiredDescription
typestringoptionalRestrict results to filters of this type.
pipedrive_goal_create#Create a new goal in Pipedrive to track team or individual performance metrics.9 params

Create a new goal in Pipedrive to track team or individual performance metrics.

NameTypeRequiredDescription
assignee_idintegerrequiredID of the user or team assigned to this goal.
assignee_typestringrequiredType of assignee: person or team.
duration_endstringrequiredGoal end date in YYYY-MM-DD format.
duration_startstringrequiredGoal start date in YYYY-MM-DD format.
intervalstringrequiredGoal tracking interval: weekly, monthly, quarterly, or yearly.
targetnumberrequiredTarget value for the goal.
titlestringrequiredTitle of the goal.
tracking_metricstringrequiredWhat to track: count or sum.
type_namestringrequiredGoal type: deals_won, deals_progressed, activities_completed, activities_added, or revenue_forecast.
pipedrive_goal_delete#Delete a goal from Pipedrive by its ID.1 param

Delete a goal from Pipedrive by its ID.

NameTypeRequiredDescription
idstringrequiredThe ID of the goal to delete.
pipedrive_goal_update#Update an existing goal in Pipedrive. Modify title, assignee, target, interval, or duration.8 params

Update an existing goal in Pipedrive. Modify title, assignee, target, interval, or duration.

NameTypeRequiredDescription
idstringrequiredThe ID of the goal to update.
assignee_idintegeroptionalUpdated assignee user or team ID.
assignee_typestringoptionalUpdated assignee type: person or team.
duration_endstringoptionalUpdated goal end date in YYYY-MM-DD format.
duration_startstringoptionalUpdated goal start date in YYYY-MM-DD format.
intervalstringoptionalUpdated tracking interval: weekly, monthly, quarterly, or yearly.
targetnumberoptionalUpdated target value.
titlestringoptionalUpdated title of the goal.
pipedrive_goals_find#Search and filter goals in Pipedrive by type, title, assignee, and time period.7 params

Search and filter goals in Pipedrive by type, title, assignee, and time period.

NameTypeRequiredDescription
assignee_idintegeroptionalFilter goals by assignee user or team ID.
assignee_typestringoptionalType of assignee: person or team.
is_activebooleanoptionalFilter by active status: true for active, false for inactive.
period_endstringoptionalGoal period end date in YYYY-MM-DD format.
period_startstringoptionalGoal period start date in YYYY-MM-DD format.
titlestringoptionalFilter goals by title.
type_namestringoptionalFilter by goal type: deals_won, deals_progressed, activities_completed, activities_added, revenue_forecast.
pipedrive_lead_create#Create a new lead in Pipedrive with a title and optional associations to a person or organization.4 params

Create a new lead in Pipedrive with a title and optional associations to a person or organization.

NameTypeRequiredDescription
titlestringrequiredTitle of the lead.
organization_idintegeroptionalID of the organization to associate this lead with.
owner_idintegeroptionalID of the user who owns this lead.
person_idintegeroptionalID of the person to associate this lead with.
pipedrive_lead_delete#Delete a lead from Pipedrive by its ID.1 param

Delete a lead from Pipedrive by its ID.

NameTypeRequiredDescription
idstringrequiredThe UUID of the lead to delete.
pipedrive_lead_get#Retrieve details of a specific lead in Pipedrive by its ID.1 param

Retrieve details of a specific lead in Pipedrive by its ID.

NameTypeRequiredDescription
idstringrequiredThe UUID of the lead to retrieve.
pipedrive_lead_update#Update an existing lead in Pipedrive. Modify title, owner, person, organization, or status.6 params

Update an existing lead in Pipedrive. Modify title, owner, person, organization, or status.

NameTypeRequiredDescription
idstringrequiredThe UUID of the lead to update.
is_archivedbooleanoptionalWhether to archive this lead.
organization_idintegeroptionalID of the organization to associate this lead with.
owner_idintegeroptionalID of the user who owns this lead.
person_idintegeroptionalID of the person to associate this lead with.
titlestringoptionalUpdated title of the lead.
pipedrive_leads_list#Retrieve a list of leads from Pipedrive with pagination. Filter by owner, person, or organization.6 params

Retrieve a list of leads from Pipedrive with pagination. Filter by owner, person, or organization.

NameTypeRequiredDescription
filter_idintegeroptionalID of a saved filter to apply.
limitintegeroptionalNumber of leads per page.
organization_idintegeroptionalFilter leads by organization ID.
owner_idintegeroptionalFilter leads by owner user ID.
person_idintegeroptionalFilter leads by person ID.
startintegeroptionalPagination start offset.
pipedrive_note_create#Create a new note in Pipedrive and associate it with a deal, person, organization, or lead.5 params

Create a new note in Pipedrive and associate it with a deal, person, organization, or lead.

NameTypeRequiredDescription
contentstringrequiredHTML content of the note.
deal_idintegeroptionalID of the deal to attach this note to.
lead_idstringoptionalUUID of the lead to attach this note to.
org_idintegeroptionalID of the organization to attach this note to.
person_idintegeroptionalID of the person to attach this note to.
pipedrive_note_delete#Delete a note from Pipedrive by its ID.1 param

Delete a note from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the note to delete.
pipedrive_note_get#Retrieve details of a single note in Pipedrive by its ID, including content and the deal, person, organization, or lead it is attached to.1 param

Retrieve details of a single note in Pipedrive by its ID, including content and the deal, person, organization, or lead it is attached to.

NameTypeRequiredDescription
idintegerrequiredThe ID of the note to retrieve.
pipedrive_note_update#Update the content of an existing note in Pipedrive.2 params

Update the content of an existing note in Pipedrive.

NameTypeRequiredDescription
contentstringrequiredUpdated HTML content of the note.
idintegerrequiredThe ID of the note to update.
pipedrive_notes_list#Retrieve a list of notes from Pipedrive. Filter by deal, person, organization, lead, or date range.7 params

Retrieve a list of notes from Pipedrive. Filter by deal, person, organization, lead, or date range.

NameTypeRequiredDescription
deal_idintegeroptionalFilter notes by deal ID.
lead_idstringoptionalFilter notes by lead UUID.
limitintegeroptionalNumber of notes per page.
org_idintegeroptionalFilter notes by organization ID.
person_idintegeroptionalFilter notes by person ID.
startintegeroptionalPagination start offset.
user_idintegeroptionalFilter notes by the user who created them.
pipedrive_organization_create#Create a new organization (company) in Pipedrive with a name, address, and optional owner.3 params

Create a new organization (company) in Pipedrive with a name, address, and optional owner.

NameTypeRequiredDescription
namestringrequiredName of the organization.
addressstringoptionalPhysical address of the organization.
owner_idintegeroptionalID of the user who owns this organization.
pipedrive_organization_delete#Delete an organization from Pipedrive by its ID.1 param

Delete an organization from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the organization to delete.
pipedrive_organization_fields_list#Get metadata for all organization fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing organization data.3 params

Get metadata for all organization fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing organization data.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
include_fieldsstringoptionalComma-separated list of extra properties to include, e.g. ui_visibility, important_fields, required_fields.
limitintegeroptionalNumber of fields to return per page (max 500, default 100).
pipedrive_organization_follower_add#Add a user as a follower of an organization so they receive updates about it in Pipedrive.2 params

Add a user as a follower of an organization so they receive updates about it in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the organization to follow.
user_idintegerrequiredThe ID of the user to add as a follower.
pipedrive_organization_follower_delete#Remove a follower from an organization in Pipedrive.2 params

Remove a follower from an organization in Pipedrive.

NameTypeRequiredDescription
follower_idintegerrequiredThe user ID of the follower to remove.
idintegerrequiredThe ID of the organization.
pipedrive_organization_followers_list#List the users who are following a specific organization in Pipedrive.1 param

List the users who are following a specific organization in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the organization.
pipedrive_organization_get#Retrieve details of a specific organization in Pipedrive by its ID, including name, address, and associated deals and contacts.1 param

Retrieve details of a specific organization in Pipedrive by its ID, including name, address, and associated deals and contacts.

NameTypeRequiredDescription
idintegerrequiredThe ID of the organization to retrieve.
pipedrive_organization_merge#Merge two organizations in Pipedrive. The organization given by merge_with_id is merged into the organization given by id, and the source organization is removed.2 params

Merge two organizations in Pipedrive. The organization given by merge_with_id is merged into the organization given by id, and the source organization is removed.

NameTypeRequiredDescription
idintegerrequiredThe ID of the organization to merge into.
merge_with_idintegerrequiredThe ID of the organization that will be merged into the organization given by id and then removed.
pipedrive_organization_update#Update an existing organization in Pipedrive. Modify name, address, or owner.4 params

Update an existing organization in Pipedrive. Modify name, address, or owner.

NameTypeRequiredDescription
idintegerrequiredThe ID of the organization to update.
addressstringoptionalUpdated physical address of the organization.
namestringoptionalUpdated name of the organization.
owner_idintegeroptionalID of the user who owns this organization.
pipedrive_organizations_list#Retrieve a list of organizations (companies) from Pipedrive with cursor-based pagination and optional filtering.4 params

Retrieve a list of organizations (companies) from Pipedrive with cursor-based pagination and optional filtering.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
filter_idintegeroptionalID of a saved filter to apply.
limitintegeroptionalNumber of organizations to return per page (max 500).
owner_idintegeroptionalFilter organizations by owner user ID.
pipedrive_person_create#Create a new person (contact) in Pipedrive with name, email, phone, and optional organization association.5 params

Create a new person (contact) in Pipedrive with name, email, phone, and optional organization association.

NameTypeRequiredDescription
namestringrequiredFull name of the person.
emailstringoptionalEmail address of the person.
org_idintegeroptionalID of the organization to associate this person with.
owner_idintegeroptionalID of the user who owns this person record.
phonestringoptionalPhone number of the person.
pipedrive_person_delete#Delete a person (contact) from Pipedrive by their ID.1 param

Delete a person (contact) from Pipedrive by their ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the person to delete.
pipedrive_person_fields_list#Get metadata for all person fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing person data.3 params

Get metadata for all person fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing person data.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
include_fieldsstringoptionalComma-separated list of extra properties to include, e.g. ui_visibility, important_fields, required_fields.
limitintegeroptionalNumber of fields to return per page (max 500, default 100).
pipedrive_person_follower_add#Add a user as a follower of a person so they receive updates about them in Pipedrive.2 params

Add a user as a follower of a person so they receive updates about them in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the person to follow.
user_idintegerrequiredThe ID of the user to add as a follower.
pipedrive_person_follower_delete#Remove a follower from a person in Pipedrive.2 params

Remove a follower from a person in Pipedrive.

NameTypeRequiredDescription
follower_idintegerrequiredThe user ID of the follower to remove.
idintegerrequiredThe ID of the person.
pipedrive_person_followers_list#List the users who are following a specific person in Pipedrive.1 param

List the users who are following a specific person in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the person.
pipedrive_person_get#Retrieve details of a specific person (contact) in Pipedrive by their ID, including name, emails, phones, and associated organization.1 param

Retrieve details of a specific person (contact) in Pipedrive by their ID, including name, emails, phones, and associated organization.

NameTypeRequiredDescription
idintegerrequiredThe ID of the person to retrieve.
pipedrive_person_merge#Merge two persons in Pipedrive. The person given by merge_with_id is merged into the person given by id, and the source person is removed.2 params

Merge two persons in Pipedrive. The person given by merge_with_id is merged into the person given by id, and the source person is removed.

NameTypeRequiredDescription
idintegerrequiredThe ID of the person to merge into.
merge_with_idintegerrequiredThe ID of the person that will be merged into the person given by id and then removed.
pipedrive_person_update#Update an existing person (contact) in Pipedrive. Modify name, email, phone, organization, or owner.6 params

Update an existing person (contact) in Pipedrive. Modify name, email, phone, organization, or owner.

NameTypeRequiredDescription
idintegerrequiredThe ID of the person to update.
emailstringoptionalUpdated email address of the person.
namestringoptionalUpdated full name of the person.
org_idintegeroptionalID of the organization to associate this person with.
owner_idintegeroptionalID of the user who owns this person record.
phonestringoptionalUpdated phone number of the person.
pipedrive_persons_list#Retrieve a list of persons (contacts) from Pipedrive. Filter by owner, organization, or deal with cursor-based pagination.6 params

Retrieve a list of persons (contacts) from Pipedrive. Filter by owner, organization, or deal with cursor-based pagination.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
deal_idintegeroptionalFilter persons by associated deal ID.
filter_idintegeroptionalID of a saved filter to apply.
limitintegeroptionalNumber of persons to return per page (max 500).
org_idintegeroptionalFilter persons by organization ID.
owner_idintegeroptionalFilter persons by owner user ID.
pipedrive_pipeline_conversion_statistics#Get the deal conversion rates between stages of a pipeline over a given date range.4 params

Get the deal conversion rates between stages of a pipeline over a given date range.

NameTypeRequiredDescription
end_datestringrequiredThe end of the period to compute conversion statistics for (YYYY-MM-DD).
idintegerrequiredThe ID of the pipeline.
start_datestringrequiredThe start of the period to compute conversion statistics for (YYYY-MM-DD).
user_idintegeroptionalThe ID of the user whose pipeline statistics to fetch. Defaults to the authorized user if omitted.
pipedrive_pipeline_create#Create a new sales pipeline in Pipedrive with a name and optional deal probability setting.2 params

Create a new sales pipeline in Pipedrive with a name and optional deal probability setting.

NameTypeRequiredDescription
namestringrequiredName of the pipeline.
is_deal_probability_enabledbooleanoptionalWhether deal probability is enabled for this pipeline.
pipedrive_pipeline_deals_list#List the deals currently sitting in a specific pipeline, optionally filtered by owner, stage, or a saved filter.7 params

List the deals currently sitting in a specific pipeline, optionally filtered by owner, stage, or a saved filter.

NameTypeRequiredDescription
idintegerrequiredThe ID of the pipeline.
everyonenumberoptionalIf set to 1, filter_id and user_id are ignored and deals owned by everyone are returned.
filter_idintegeroptionalIf supplied, only deals matching the given filter will be returned.
limitintegeroptionalNumber of items to show per page.
stage_idintegeroptionalIf supplied, only deals within the given stage will be returned.
startintegeroptionalPagination start offset.
user_idintegeroptionalIf supplied, filter_id is ignored and only deals owned by this user are returned.
pipedrive_pipeline_delete#Delete a sales pipeline from Pipedrive by its ID.1 param

Delete a sales pipeline from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the pipeline to delete.
pipedrive_pipeline_get#Retrieve details of a specific sales pipeline in Pipedrive by its ID.1 param

Retrieve details of a specific sales pipeline in Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the pipeline to retrieve.
pipedrive_pipeline_movement_statistics#Get counts of how deals moved into and out of each stage of a pipeline over a given date range.4 params

Get counts of how deals moved into and out of each stage of a pipeline over a given date range.

NameTypeRequiredDescription
end_datestringrequiredThe end of the period to compute movement statistics for (YYYY-MM-DD).
idintegerrequiredThe ID of the pipeline.
start_datestringrequiredThe start of the period to compute movement statistics for (YYYY-MM-DD).
user_idintegeroptionalThe ID of the user whose pipeline statistics to fetch. Defaults to the authorized user if omitted.
pipedrive_pipeline_update#Update an existing sales pipeline in Pipedrive. Modify name or deal probability settings.3 params

Update an existing sales pipeline in Pipedrive. Modify name or deal probability settings.

NameTypeRequiredDescription
idintegerrequiredThe ID of the pipeline to update.
is_deal_probability_enabledbooleanoptionalWhether deal probability is enabled for this pipeline.
namestringoptionalUpdated name of the pipeline.
pipedrive_pipelines_list#Retrieve all sales pipelines from Pipedrive with their stages and configuration.4 params

Retrieve all sales pipelines from Pipedrive with their stages and configuration.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
limitintegeroptionalNumber of pipelines per page (max 500).
sort_bystringoptionalField to sort results by: id, update_time, or add_time.
sort_directionstringoptionalSort direction: asc or desc.
pipedrive_product_create#Create a new product in Pipedrive with name, price, description, and other attributes.6 params

Create a new product in Pipedrive with name, price, description, and other attributes.

NameTypeRequiredDescription
namestringrequiredName of the product.
codestringoptionalProduct code or SKU.
descriptionstringoptionalDescription of the product.
owner_idintegeroptionalID of the user who owns this product.
taxnumberoptionalTax rate for this product (percentage).
unitstringoptionalUnit of measurement for this product.
pipedrive_product_delete#Delete a product from Pipedrive by its ID.1 param

Delete a product from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the product to delete.
pipedrive_product_fields_list#Get metadata for all product fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing product data.3 params

Get metadata for all product fields in Pipedrive, including custom fields. Use this to discover valid field keys and option values before writing product data.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
include_fieldsstringoptionalComma-separated list of extra properties to include, e.g. ui_visibility, important_fields, required_fields.
limitintegeroptionalNumber of fields to return per page (max 500, default 100).
pipedrive_product_follower_add#Add a user as a follower of a product so they receive updates about it in Pipedrive.2 params

Add a user as a follower of a product so they receive updates about it in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the product to follow.
user_idintegerrequiredThe ID of the user to add as a follower.
pipedrive_product_follower_delete#Remove a follower from a product in Pipedrive.2 params

Remove a follower from a product in Pipedrive.

NameTypeRequiredDescription
follower_idintegerrequiredThe user ID of the follower to remove.
idintegerrequiredThe ID of the product.
pipedrive_product_followers_list#List the users who are following a specific product in Pipedrive.1 param

List the users who are following a specific product in Pipedrive.

NameTypeRequiredDescription
idintegerrequiredThe ID of the product.
pipedrive_product_get#Retrieve details of a specific product in Pipedrive by its ID.1 param

Retrieve details of a specific product in Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the product to retrieve.
pipedrive_product_update#Update an existing product in Pipedrive. Modify name, code, description, unit, tax, or owner.7 params

Update an existing product in Pipedrive. Modify name, code, description, unit, tax, or owner.

NameTypeRequiredDescription
idintegerrequiredThe ID of the product to update.
codestringoptionalUpdated product code or SKU.
descriptionstringoptionalUpdated description of the product.
namestringoptionalUpdated name of the product.
owner_idintegeroptionalUpdated owner user ID.
taxnumberoptionalUpdated tax rate (percentage).
unitstringoptionalUpdated unit of measurement.
pipedrive_products_list#Retrieve a list of products from Pipedrive with cursor-based pagination and optional filtering.6 params

Retrieve a list of products from Pipedrive with cursor-based pagination and optional filtering.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
filter_idintegeroptionalID of a saved filter to apply.
limitintegeroptionalNumber of products per page (max 500).
owner_idintegeroptionalFilter products by owner user ID.
sort_bystringoptionalField to sort by (e.g., id, update_time, add_time, name).
sort_directionstringoptionalSort direction: asc or desc.
pipedrive_stage_create#Create a new stage in a Pipedrive pipeline with a name and optional deal probability settings.5 params

Create a new stage in a Pipedrive pipeline with a name and optional deal probability settings.

NameTypeRequiredDescription
namestringrequiredName of the stage.
pipeline_idintegerrequiredID of the pipeline this stage belongs to.
days_to_rottenintegeroptionalNumber of days a deal stays in this stage before it's marked as rotten.
deal_probabilityintegeroptionalDeal success probability for this stage (0-100).
is_deal_rot_enabledbooleanoptionalWhether rotten flag is enabled for deals in this stage.
pipedrive_stage_deals_list#List the deals currently sitting in a specific pipeline stage, optionally filtered by owner or a saved filter.6 params

List the deals currently sitting in a specific pipeline stage, optionally filtered by owner or a saved filter.

NameTypeRequiredDescription
idintegerrequiredThe ID of the stage.
everyonenumberoptionalIf set to 1, filter_id and user_id are ignored and deals owned by everyone are returned.
filter_idintegeroptionalIf supplied, only deals matching the given filter will be returned.
limitintegeroptionalNumber of items to show per page.
startintegeroptionalPagination start offset.
user_idintegeroptionalIf supplied, filter_id is ignored and only deals owned by this user are returned.
pipedrive_stage_delete#Delete a pipeline stage from Pipedrive by its ID.1 param

Delete a pipeline stage from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the stage to delete.
pipedrive_stage_get#Retrieve details of a specific pipeline stage in Pipedrive by its ID.1 param

Retrieve details of a specific pipeline stage in Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the stage to retrieve.
pipedrive_stage_update#Update an existing pipeline stage in Pipedrive. Modify name, pipeline, deal probability, or rotten settings.6 params

Update an existing pipeline stage in Pipedrive. Modify name, pipeline, deal probability, or rotten settings.

NameTypeRequiredDescription
idintegerrequiredThe ID of the stage to update.
days_to_rottenintegeroptionalNumber of days before a deal is marked as rotten.
deal_probabilityintegeroptionalDeal success probability for this stage (0-100).
is_deal_rot_enabledbooleanoptionalWhether rotten flag is enabled for deals in this stage.
namestringoptionalUpdated name of the stage.
pipeline_idintegeroptionalID of the pipeline this stage belongs to.
pipedrive_stages_list#Retrieve all stages in Pipedrive. Filter by pipeline ID with cursor-based pagination.5 params

Retrieve all stages in Pipedrive. Filter by pipeline ID with cursor-based pagination.

NameTypeRequiredDescription
cursorstringoptionalCursor for pagination from a previous response.
limitintegeroptionalNumber of stages per page (max 500).
pipeline_idintegeroptionalFilter stages by pipeline ID.
sort_bystringoptionalField to sort by (e.g., id, update_time, add_time).
sort_directionstringoptionalSort direction: asc or desc.
pipedrive_user_create#Invite a new user to the Pipedrive account by email, optionally setting their app access level and active status.4 params

Invite a new user to the Pipedrive account by email, optionally setting their app access level and active status.

NameTypeRequiredDescription
emailstringrequiredThe email address of the user to invite.
access_adminbooleanoptionalWhether the user should have admin access within the given app.
access_appstringoptionalThe app to grant access to. One of: global, sales, campaigns, projects, account_settings, partnership.
active_flagbooleanoptionalWhether the user is activated. false = Not activated, true = Activated.
pipedrive_user_get#Retrieve details of a specific user in Pipedrive by their ID.1 param

Retrieve details of a specific user in Pipedrive by their ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the user to retrieve.
pipedrive_user_me#Retrieve the profile of the currently authenticated user in Pipedrive.0 params

Retrieve the profile of the currently authenticated user in Pipedrive.

pipedrive_user_update#Update a Pipedrive user's activation status. This is the only field the Pipedrive Users API allows changing after invite.2 params

Update a Pipedrive user's activation status. This is the only field the Pipedrive Users API allows changing after invite.

NameTypeRequiredDescription
active_flagbooleanrequiredWhether the user is activated. false = Not activated, true = Activated.
idintegerrequiredThe ID of the user to update.
pipedrive_users_find#Search for Pipedrive users by name or email address.2 params

Search for Pipedrive users by name or email address.

NameTypeRequiredDescription
termstringrequiredSearch term to match against user name or email.
search_by_emailbooleanoptionalWhen true, the search term is matched against email addresses instead of names.
pipedrive_users_list#Retrieve all users in the Pipedrive company account.0 params

Retrieve all users in the Pipedrive company account.

pipedrive_webhook_create#Create a new webhook in Pipedrive to receive real-time notifications when objects are created, updated, or deleted.7 params

Create a new webhook in Pipedrive to receive real-time notifications when objects are created, updated, or deleted.

NameTypeRequiredDescription
event_actionstringrequiredAction to trigger the webhook: added, updated, deleted, or * for all.
event_objectstringrequiredObject type to watch: deal, person, organization, activity, lead, note, pipeline, product, stage, user, or * for all.
subscription_urlstringrequiredThe URL to send webhook notifications to.
http_auth_passwordstringoptionalPassword for HTTP Basic Auth on the subscription URL.
http_auth_userstringoptionalUsername for HTTP Basic Auth on the subscription URL.
namestringoptionalDisplay name for this webhook.
versionstringoptionalWebhook payload version: 1 or 2.
pipedrive_webhook_delete#Delete a webhook from Pipedrive by its ID.1 param

Delete a webhook from Pipedrive by its ID.

NameTypeRequiredDescription
idintegerrequiredThe ID of the webhook to delete.
pipedrive_webhooks_list#Retrieve all webhooks configured in the Pipedrive account.0 params

Retrieve all webhooks configured in the Pipedrive account.