Get Started
- Introduction
- Quickstart
Documentation
- Data Sources
- Business Objects
- Business Graph™
- Knowledge
- Query Agent
- Reports
- Subscriptions
- Destinations
- Tools
- Introduction
- Ably
- Acculynx
- Active campaign
- Affinity
- Agencyzoom
- Ahrefs
- Airtable
- Alchemy
- Amplitude
- Apaleo
- Apollo
- Asana
- Attio
- Bamboohr
- Bannerbear
- Baserow
- Bill
- Bitbucket
- Blackboard
- Bolna
- Borneo
- Box
- Brevo
- Browseai
- Browserbase tool
- Bugbug
- Cal
- Calendly
- Canva
- Canvas
- Chatwork
- Clickup
- Coda
- Codeinterpreter
- Coinbase
- Composio
- Composio search
- Confluence
- Contentful
- Crustdata
- D2lbrightspace
- Dialpad
- Discord
- Discordbot
- Docusign
- Dropbox
- Dynamics365
- Echtpost
- Elevenlabs
- Entelligence
- Exa
- Excel
- Figma
- Firecrawl
- Fireflies
- Flutterwave
- Formsite
- Foursquare
- Freshdesk
- Github
- Gmail
- Gong
- Google maps
- Googleads
- Googlebigquery
- Googlecalendar
- Googledocs
- Googledrive
- Googlemeet
- Googlephotos
- Googlesheets
- Googlesuper
- Googletasks
- Gorgias
- Hackernews
- Heygen
- Hubspot
- Humanloop
- Intercom
- Jira
- Junglescout
- Klaviyo
- Kommo
- Linear
- Linkedin
- Linkhut
- Linkup
- Listennotes
- Lmnt
- Mailchimp
- Mem0
- Metaads
- Microsoft clarity
- Microsoft teams
- Mixpanel
- Monday
- More trees
- Neon
- Ngrok
- Notion
- One drive
- Onepage
- Open sea
- Outlook
- Pagerduty
- Pandadoc
- Peopledatalabs
- Perplexityai
- Pipedrive
- Placekey
- Posthog
- Quickbooks
- Ramp
- Recallai
- Reddit
- Resend
- Retellai
- Rocketlane
- Rootly
- Salesforce
- Semanticscholar
- Semrush
- Sendgrid
- Sentry
- Serpapi
- Servicenow
- Share point
- Shopify
- Shortcut
- Simplesat
- Slack
- Slack user
- Slackbot
- Snowflake
- Stripe
- Supabase
- Tavily
- Text to pdf
- Textrazor
- Tinyurl
- Todoist
- Trello
- Twitter
- Twitter media
- Typefully
- Weathermap
- Webflow
- Whatsapp
- Workiom
- Wrike
- Yousearch
- Youtube
- Zendesk
- Zenrows
- Zoho
- Zoom
- Zoominfo
- Admin
Changelog
Pipedrive
Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing
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.
Adds a new installment subscription.
Adds a follower to an organization.
Adds a new comment to a note.
Adds a follower to a deal.
Set up a new pipedrive organization using custom fields with unique key hashes. retrieve organizationfields for configuration. check the linked tutorial for guidance.
Adds a follower to a person.
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.
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.
Adds a new call log.
Adds a follower to a product.
Creates a lead label.
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>.
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.
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.
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>.
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>.
Adds a new goal. along with adding a new goal, a report is created to track the progress of your goal.
Adds a new pipeline.
Adds a new team to the company and returns the created object.
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>.
Adds a new user to the company, returns the id upon success.
Adds a new note.
Adds a participant to a deal.
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.
Adds a new stage, returns the id upon success.
Adds a product to a deal, creating a new item called a deal-product.
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.
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>.
Adds a new role.
Marks a deal as deleted. after 30 days, the deal will be permanently deleted.
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.
Adds an audio recording to the call log. that audio can be played by those who have access to the call log object.
Adds users to an existing team.
Cancels a recurring subscription.
Adds or updates the visibility setting for a role.
Adds a new task.
Adds a new recurring subscription.
Creates an empty file on google drive linked to an item. for details, refer to the pipedrive remote file adding tutorial.
Archives a project.
Marks a person as deleted. after 30 days, the person will be permanently deleted.
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>.
Marks a file as deleted. after 30 days, the file will be permanently deleted.
Creates and returns an organization relationship.
Adds a new activity type.
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.
Marks a pipeline as deleted.
Marks an activity as deleted. after 30 days, the activity will be permanently deleted.
Deletes users from an existing team.
Lists the users permitted to access a lead.
Marks a task as deleted. if the task has subtasks then those will also be deleted.
Deletes a person’s picture.
Marks multiple filters as deleted.
Upload and link files to deals, people, organizations, activities, products, or leads in pipedrive. see the “adding a file” tutorial for details.
Initializes a file download.
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>.
Marks a product as deleted. after 30 days, the product will be permanently deleted.
Duplicates a deal.
Marks multiple organizations as deleted. after 30 days, the organizations will be permanently deleted.
Marks a goal as deleted.
Marks multiple fields as deleted.
Deletes the specified webhook.
Returns all activity fields.
Returns all activity types.
This beta cursor-paginated endpoint returns all activities, accessible only to global admins, not regular users who get a 403 error. refer to pipedrive’s documentation for pagination and global permissions.
Marks a filter as deleted.
Returns all call logs assigned to a particular user.
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>.
Returns details of all lead labels. this endpoint does not support pagination and all labels are always returned.
Marks a mail thread as deleted.
The text provides links to documentation for adding or updating filters, and information on all supported filter helpers in an api. it encourages consulting a tutorial for more details on adding a filter.
Returns data about all files.
Returns all comments associated with a note.
Returns the add-ons for a single company.
Marks an activity type as deleted.
Returns data about all filters.
Returns all deals. for more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/getting-all-deals” target=” blank” rel=“noopener noreferrer”>getting all deals</a>.
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.
Marks multiple activities as deleted. after 30 days, the activities will be permanently deleted.
The api returns sorted leads by creation time, supporting pagination via limit and start. custom field values are included if set, mimicking the deals endpoint structure; unset fields are omitted. leads share custom fields with deals.
Deletes a product attachment from a deal, using the product attachment id.
Query goal data by appending \{searchfield\}=\{searchvalue\} to the url with dot-notation fields and values. include is active to filter by goal status and specify both period.start and period.end for time-based searches.
Returns all the mail messages inside a specified mail thread.
Marks multiple persons as deleted. after 30 days, the persons will be permanently deleted.
Returns all lead sources. please note that the list of lead sources is fixed, it cannot be modified. all leads created through the pipedrive api will have a lead source api assigned.
Deletes a follower from a deal.
Returns all payments of an installment or recurring subscription.
Returns all organizations.
This beta api endpoint lists all organizations with cursor pagination. only global admins have access; others get a 403 error. see docs for pagination and global permissions.
Returns data about all organization fields.
This endpoint returns all deals with cursor pagination (in beta). only global admins can access it; others get a 403 error. more info on pagination and permissions is available online.
Marks a project as deleted.
Marks multiple fields as deleted.
Marks multiple activity types as deleted.
Returns all persons.
Deletes a follower from a person.
Returns data about all deal fields.
This beta endpoint returns all persons, using cursor pagination. only global admins have access; others get a 403 error. info on pagination and permissions is in the linked docs.
Marks a role as deleted.
Returns data about all product fields.
Marks multiple fields as deleted.
Returns data about all permission sets.
Returns data about all person fields.
if a company uses the campaigns product, then this endpoint will also return the data.marketing status field.
Returns data about all pipelines.
Returns data about all products.
Removes the assigned user from a role and adds to the default role.
Marks multiple deals as deleted. after 30 days, the deals will be permanently deleted.
Marks multiple stages as deleted.
Marks a stage as deleted.
Deletes a specific lead.
Assigns a user to a role.
Deletes a specific lead label.
Returns all notes.
Finds users by their name.
Marks an installment or a recurring subscription as deleted.
Marks multiple deal fields as deleted.
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>.
The endpoint removes a messenger channel along with conversations and messages. requires messengers integration oauth and messaging app extension manifest.
Deletes an organization relationship and returns the deleted id.
Returns all activities assigned to a particular user.
Deletes a comment.
Returns details of an installment or a recurring subscription by the deal id.
Deletes a specific note.
Deletes a participant from a deal.
Returns data about all note fields.
Marks an organization as deleted. after 30 days, the organization will be permanently deleted.
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.
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.
Deletes a follower from a product.
Returns data about all users within the company.
Returns all supported currencies in given account which should be used when saving monetary values with other objects. the code parameter of the returning objects is the currency code according to iso 4217 for all non-custom currencies.
Returns all tasks. this is a cursor-paginated endpoint. for more information, please refer to our documentation on <a href=“https://pipedrive.readme.io/docs/core-api-concepts-pagination” target=” blank” rel=“noopener noreferrer”>pagination</a>.
Returns all projects. this is a cursor-paginated endpoint. for more information, please refer to our documentation on <a href=“https://pipedrive.readme.io/docs/core-api-concepts-pagination” target=” blank” rel=“noopener noreferrer”>pagination</a>.
Gets all of the relationships for a supplied organization id.
The endpoint retrieves all non-deleted project templates with cursor-based pagination. refer to the provided documentation link for more details on pagination.
Returns the details of a specific project phase.
Returns data about a specific file.
Fetches specific deal details, including exclusive fields like deal age and pipeline stage duration. custom fields show up as hashes, which can be matched using the ‘key’ from dealfields. see the deal details tutorial for more.
Returns data about a specific team.
Returns data about all stages.
Returns data about an authorized user within the company with bound company data: company id, company name, and domain. note that the locale property means ‘date/number format’ in the pipedrive account settings, not the chosen language.
Returns opened and won deals in time-based groups according to a specified dealfield, with examples of deals grouped by month over a 3-month period starting january 2012.
Returns all projects boards that are not deleted.
The text describes an api endpoint that returns detailed person information, including extra fields and custom fields as hashes. it also provides data.marketing status if the campaigns product is used.
Returns the details of a specific project. also note that custom fields appear as long hashes in the resulting data. these hashes can be mapped against the key value of project fields.
Returns data about all teams which have the specified user as a member.
Returns all the roles within the company.
Returns a list of all user ids within a team.
Returns data about a specific organization field.
Returns data about a specific filter. note that this also returns the condition lines of the filter.
Returns data about all connections for the authorized user.
Returns data about a specific product field.
Returns the details of a specific role.
Returns data about a specific product.
Returns data about a specific deal field.
Api returns specific lead details with custom field values in the deals format. unset custom fields are omitted. leads share custom fields with deals, not having a unique set.
Returns data about a specific stage.
Gets the progress of a goal for the specified period.
Returns data about a specific user within the company.
Returns data about all the webhooks of a company.
Finds and returns an organization relationship from its id.
Returns details about a specific note.
Returns data about a specific pipeline. also returns the summary of the deals in this pipeline across its stages.
Returns details of an installment or a recurring subscription.
Links an existing remote file (googledrive) to the item you supply. for more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/adding-a-remote-file” target=” blank” rel=“noopener noreferrer”>adding a remote file</a>.
The endpoint lists every person linked to a deal, including primary contacts and participants, and provides a data.marketing status field for users of the campaigns product.
Lists activities associated with a deal.
Returns data about a specific mail message.
Returns all active project phases under a specific board.
Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
Returns data about all recent changes occurred after the given timestamp.
Lists activities associated with a person.
Lists the followers of an organization.
Lists deals associated with an organization.
Lists files associated with a deal.
Lists the followers of a person.
Lists files associated with a person.
Returns data about teams within the company.
Lists deals in a specific pipeline across all its stages.
Returns a specific mail thread.
Lists files associated with a product.
Lists activities associated with an organization.
Lists the followers of a deal.
Returns the details of a specific task.
Returns data about a specific permission set.
Returns statistics for deals movements for the given time period.
A video calling provider must call this endpoint after a user has installed the video calling app so that the new user’s information is sent.
Returns data about a specific person field.
Returns mail threads in a specified folder ordered by the most recent message within.
Lists deals associated with a person.
Lists deals in a specific stage.
Returns the details of a specific activity.
Returns details of a specific call log.
Returns the details of a specific project template.
Returns the details of a comment.
Provides detailed information about an organization, including additional fields not shown when listing all organizations, and maps custom fields as long hashes to the ‘key’ value in organizationfields.
Returns a summary of all the deals.
Returns the details of a specific project board.
Lists mail messages associated with a deal.
Lists mail messages associated with a person.
Lists the users permitted to access a deal.
Lists mail messages associated with an organization.
Lists the followers of a specific user.
Returns data about deals that have a product attached to it.
Lists the followers of a product.
Lists files associated with an organization.
Lists the participants associated with a deal.
if a company uses the campaigns product, then this endpoint will also return the data.marketing status field.
Lists role assignments for a user.
Lists the settings of an authorized user. example response contains a shortened list of settings.
List users permitted to access a person.
Lists users permitted to access a product.
Lists persons associated with an organization.
if a company uses the campaigns product, then this endpoint will also return the data.marketing status field.
Returns all users assigned to a role.
Returns the list of assignments for a permission set.
Returns a list of visible or hidden pipeline ids by role. see the “visibility groups article” for details on pipeline visibility.
Lists updates about a person.
if a company uses the campaigns product, then this endpoint’s response will also include updates for the marketing status field.
Lists updates about a deal.
Merges an organization with another organization. for more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/merging-two-organizations” target=” blank” rel=“noopener noreferrer”>merging two organizations</a>.
Merges a deal with another deal. for more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/merging-two-deals” target=” blank” rel=“noopener noreferrer”>merging two deals</a>.
Lists the settings of user’s assigned role.
Returns the visibility settings of a specific role.
This endpoint provides cursor-paginated updates on deal participants. for pagination details, see the pipedrive documentation.
Lists updates about an organization.
Lists aggregated permissions over all assigned permission sets for a user.
Lists products associated with a person.
List users permitted to access an organization.
Merges a person with another person. for more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/merging-two-persons” target=” blank” rel=“noopener noreferrer”>merging two persons</a>.
Performs a search from your choice of item types and fields.
Lists products attached to a deal.
Performs a search from the values of a specific field. results can either be the distinct values of the field (useful for searching autocomplete field values), or the ids of actual items (deals, leads, persons, organizations or products).
Returns all active groups under a specific project.
Adds a message to a conversation. to use the endpoint, you need to have messengers integration oauth scope enabled and the messaging manifest ready for the messaging app extension.
Access tokens expire after the time specified in expires in. to continue accessing the api, use the refresh token to obtain a new access token.
Updates an installment subscription.
Updates the properties of a stage.
Returns activities linked to a specific project.
Returns information about items in a project plan. items consists of tasks and activities and are linked to specific project phase and group.
Updates one or more properties of a lead label. only properties included in the request will be updated.
Updates the properties of an organization.
Updates a recurring subscription.
Authorize a user by redirecting them to the pipedrive oauth authorization page and request their permissions to act on their behalf. this step is necessary to implement only when you allow app installation outside of the marketplace.
Updates a note.
Returns tasks linked to a specific project.
This api endpoint searches deals by title, notes, and custom fields, filters results by person or organization id, and is a specific use case of /v1/itemsearch with limited oauth scope.
Updates a task phase or group in a project.
Modifies a person’s details in pipedrive. see the linked tutorial for guidance. if utilizing campaigns, the endpoint also handles data.marketing status.
Updates an existing team and returns the updated object.
Updates a task.
Endpoint searches leads by title, notes, custom fields, with options to filter by person and organization ids, and is a more specific use of the /v1/itemsearch with limited oauth scope.
Updates an activity type.
Updates an organization field. for more information, see the tutorial for <a href=” https://pipedrive.readme.io/docs/updating-custom-field-value ” target=” blank” rel=“noopener noreferrer”>updating custom fields’ values</a>.
Searches all organizations by name, address, notes and/or custom fields. this endpoint is a wrapper of <a href=“https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem”>/v1/itemsearch</a> with a narrower oauth scope.
Updates and returns an organization relationship.
This endpoint searches for individuals by various identifiers and is a specific use case of /v1/itemsearch with limited oauth scope, allowing results filtering by organization id.
Updates the details of the product that has been attached to a deal.
Updates the properties of a pipeline.
Updates a person field. for more information, see the tutorial for <a href=” https://pipedrive.readme.io/docs/updating-custom-field-value ” target=” blank” rel=“noopener noreferrer”>updating custom fields’ values</a>.
Updates an existing goal.
Searches all products by name, code and/or custom fields. this endpoint is a wrapper of <a href=“https://developers.pipedrive.com/docs/api/v1/itemsearch#searchitem”>/v1/itemsearch</a> with a narrower oauth scope.
Updates a comment related to a note.
Updates product data.
Updates the properties of a file.
A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
Updates the properties of a deal. for more information, see the tutorial for <a href=“https://pipedrive.readme.io/docs/updating-a-deal” target=” blank” rel=“noopener noreferrer”>updating a deal</a>.
Updates an existing filter.
Updates an activity phase or group in a project.
Updates an activity. includes more activities scheduled in context property in response’s additional data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data).
Updates pipeline visibility settings for different roles. for details, see the pipedrive visibility groups article.
Updates the properties of a mail thread.
Updates a deal field. for more information, see the tutorial for <a href=” https://pipedrive.readme.io/docs/updating-custom-field-value ” target=” blank” rel=“noopener noreferrer”>updating custom fields’ values</a>.
Updates a project.
Updates the parent role and/or the name of a specific role.
Updates the properties of a user. currently, only active flag can be updated.
Updating lead properties modifies only specified fields; use null to unset. custom field data matches deals. unset fields are omitted. leads share deals’ custom fields. for examples, refer to the tutorial.
Updates a product field. for more information, see the tutorial for <a href=” https://pipedrive.readme.io/docs/updating-custom-field-value ” target=” blank” rel=“noopener noreferrer”>updating custom fields’ values</a>.