Pipedrive is a sales management tool built around pipeline visualization, lead tracking, activity reminders, and automation to keep deals progressing
Add an activity
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.
Add an installment subscription
Adds a new installment subscription.
Add a follower to an organization
Adds a follower to an organization.
Add a comment to a note
Adds a new comment to a note.
Add a follower to a deal
Adds a follower to a deal.
Add an organization
Set up a new pipedrive organization using custom fields with unique key hashes. retrieve organizationfields for configuration. check the linked tutorial for guidance.
Add a follower to a person
Adds a follower to a person.
Add a deal
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.
Add a channel
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.
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.
Add a new filter
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 user to the company, returns the id upon success.
Add a note
Adds a new note.
Add a participant to a deal
Adds a participant to a deal.
Add a person
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.
Add a new stage
Adds a new stage, returns the id upon success.
Add a product to a deal
Adds a product to a deal, creating a new item called a deal-product.
Add a project
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.
Add a product
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>.
Add a role
Adds a new role.
Delete a deal
Marks a deal as deleted. after 30 days, the deal will be permanently deleted.
Create a new webhook
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.
Attach an audio file to the call log
Adds an audio recording to the call log. that audio can be played by those who have access to the call log object.
Add users to a team
Adds users to an existing team.
Cancel a recurring subscription
Cancels a recurring subscription.
Add or update role setting
Adds or updates the visibility setting for a role.
Add a task
Adds a new task.
Add a recurring subscription
Adds a new recurring subscription.
Create a remote file and link it to an item
Creates an empty file on google drive linked to an item. for details, refer to the pipedrive remote file adding tutorial.
Archive a project
Archives a project.
Delete a person
Marks a person as deleted. after 30 days, the person will be permanently deleted.
Marks a file as deleted. after 30 days, the file will be permanently deleted.
Create an organization relationship
Creates and returns an organization relationship.
Add new activity type
Adds a new activity type.
Add person picture
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.
Delete a pipeline
Marks a pipeline as deleted.
Delete an activity
Marks an activity as deleted. after 30 days, the activity will be permanently deleted.
Delete users from a team
Deletes users from an existing team.
Enumerate accessible users for lead
Lists the users permitted to access a lead.
Delete a task
Marks a task as deleted. if the task has subtasks then those will also be deleted.
Delete person picture
Deletes a person’s picture.
Delete multiple filters in bulk
Marks multiple filters as deleted.
Add file
Upload and link files to deals, people, organizations, activities, products, or leads in pipedrive. see the “adding a file” tutorial for details.
Marks a product as deleted. after 30 days, the product will be permanently deleted.
Duplicate deal
Duplicates a deal.
Delete multiple organizations in bulk
Marks multiple organizations as deleted. after 30 days, the organizations will be permanently deleted.
Delete existing goal
Marks a goal as deleted.
Delete multiple organization fields in bulk
Marks multiple fields as deleted.
Delete existing webhook
Deletes the specified webhook.
Get all activity fields
Returns all activity fields.
Get all activity types
Returns all activity types.
Get all activities beta
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.
Delete a filter
Marks a filter as deleted.
Get all call logs assigned to a particular user
Returns all call logs assigned to a particular user.
Returns details of all lead labels. this endpoint does not support pagination and all labels are always returned.
Delete mail thread
Marks a mail thread as deleted.
Get all filter helpers
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.
Marks multiple activities as deleted. after 30 days, the activities will be permanently deleted.
Get all leads
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.
Delete an attached product from a deal
Deletes a product attachment from a deal, using the product attachment id.
Find goals
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.
Get all mail messages of mail thread
Returns all the mail messages inside a specified mail thread.
Delete multiple persons in bulk
Marks multiple persons as deleted. after 30 days, the persons will be permanently deleted.
Get all lead sources
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.
Delete a follower from a deal
Deletes a follower from a deal.
Get all payments of a subscription
Returns all payments of an installment or recurring subscription.
Get all organizations
Returns all organizations.
Get all organizations beta
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.
Get all organization fields
Returns data about all organization fields.
Get all deals beta
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.
Delete a project
Marks a project as deleted.
Delete multiple person fields in bulk
Marks multiple fields as deleted.
Delete multiple activity types in bulk
Marks multiple activity types as deleted.
Get all persons
Returns all persons.
Delete a follower from a person
Deletes a follower from a person.
Get all deal fields
Returns data about all deal fields.
Get all persons beta
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.
Delete a role
Marks a role as deleted.
Get all product fields
Returns data about all product fields.
Delete multiple product fields in bulk
Marks multiple fields as deleted.
Get all permission sets
Returns data about all permission sets.
Get all person fields
Returns data about all person fields.if a company uses the campaigns product, then this endpoint will also return the data.marketing status field.
Get all pipelines
Returns data about all pipelines.
Get all products
Returns data about all products.
Delete a role assignment
Removes the assigned user from a role and adds to the default role.
Delete multiple deals in bulk
Marks multiple deals as deleted. after 30 days, the deals will be permanently deleted.
Delete multiple stages in bulk
Marks multiple stages as deleted.
Delete a stage
Marks a stage as deleted.
Delete a lead
Deletes a specific lead.
Add role assignment
Assigns a user to a role.
Delete a lead label
Deletes a specific lead label.
Get all notes
Returns all notes.
Find users by name
Finds users by their name.
Delete a subscription
Marks an installment or a recurring subscription as deleted.
The endpoint removes a messenger channel along with conversations and messages. requires messengers integration oauth and messaging app extension manifest.
Delete an organization relationship
Deletes an organization relationship and returns the deleted id.
Get all activities assigned to a particular user
Returns all activities assigned to a particular user.
Delete a comment related to a note
Deletes a comment.
Find subscription by deal
Returns details of an installment or a recurring subscription by the deal id.
Delete a note
Deletes a specific note.
Delete a participant from a deal
Deletes a participant from a deal.
Get all note fields
Returns data about all note fields.
Delete an organization
Marks an organization as deleted. after 30 days, the organization will be permanently deleted.
Delete a call log
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.
Delete a conversation
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.
Delete a follower from a product
Deletes a follower from a product.
Get all users
Returns data about all users within the company.
Get all supported currencies
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.
Get all tasks
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>.
Get all projects
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>.
Get all relationships for organization
Gets all of the relationships for a supplied organization id.
Get all project templates
The endpoint retrieves all non-deleted project templates with cursor-based pagination. refer to the provided documentation link for more details on pagination.
Get details of a phase
Returns the details of a specific project phase.
Get one file
Returns data about a specific file.
Get details of a deal
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.
Get a single team
Returns data about a specific team.
Get all stages
Returns data about all stages.
Get current user data
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.
Get deals timeline
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.
Get all project boards
Returns all projects boards that are not deleted.
Get details of a person
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.
Get details of a project
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.
Get all teams of a user
Returns data about all teams which have the specified user as a member.
Get all roles
Returns all the roles within the company.
Get all users in a team
Returns a list of all user ids within a team.
Get one organization field
Returns data about a specific organization field.
Get one filter
Returns data about a specific filter. note that this also returns the condition lines of the filter.
Get all user connections
Returns data about all connections for the authorized user.
Get one product field
Returns data about a specific product field.
Get one role
Returns the details of a specific role.
Get one product
Returns data about a specific product.
Get one deal field
Returns data about a specific deal field.
Get one lead
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.
Get one stage
Returns data about a specific stage.
Get result of a goal
Gets the progress of a goal for the specified period.
Get one user
Returns data about a specific user within the company.
Get all webhooks
Returns data about all the webhooks of a company.
Get one organization relationship
Finds and returns an organization relationship from its id.
Get one note
Returns details about a specific note.
Get one pipeline
Returns data about a specific pipeline. also returns the summary of the deals in this pipeline across its stages.
Get details of a subscription
Returns details of an installment or a recurring subscription.
Link a remote file to an item
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>.
List all persons associated with a deal
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.
List activities associated with a deal
Lists activities associated with a deal.
Get one mail message
Returns data about a specific mail message.
Get project phases
Returns all active project phases under a specific board.
Get deals conversion rates in pipeline
Returns all stage-to-stage conversion and pipeline-to-close rates for the given time period.
Get recents
Returns data about all recent changes occurred after the given timestamp.
List activities associated with a person
Lists activities associated with a person.
List followers of an organization
Lists the followers of an organization.
List deals associated with an organization
Lists deals associated with an organization.
List files attached to a deal
Lists files associated with a deal.
List followers of a person
Lists the followers of a person.
List files attached to a person
Lists files associated with a person.
Get all teams
Returns data about teams within the company.
Get deals in a pipeline
Lists deals in a specific pipeline across all its stages.
Get one mail thread
Returns a specific mail thread.
List files attached to a product
Lists files associated with a product.
List activities associated with an organization
Lists activities associated with an organization.
List followers of a deal
Lists the followers of a deal.
Get details of a task
Returns the details of a specific task.
Get one permission set
Returns data about a specific permission set.
Get deals movements in pipeline
Returns statistics for deals movements for the given time period.
Link a user with the installed video call integration
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.
Get one person field
Returns data about a specific person field.
Get mail threads
Returns mail threads in a specified folder ordered by the most recent message within.
List deals associated with a person
Lists deals associated with a person.
Get deals in a stage
Lists deals in a specific stage.
Get details of an activity
Returns the details of a specific activity.
Get details of a call log
Returns details of a specific call log.
Get details of a template
Returns the details of a specific project template.
Get one comment
Returns the details of a comment.
Get details of an organization
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.
Get deals summary
Returns a summary of all the deals.
Get details of a board
Returns the details of a specific project board.
List mail messages associated with a deal
Lists mail messages associated with a deal.
List mail messages associated with a person
Lists mail messages associated with a person.
List permitted users
Lists the users permitted to access a deal.
List mail messages associated with an organization
Lists mail messages associated with an organization.
List followers of a user
Lists the followers of a specific user.
Get deals where a product is attached to
Returns data about deals that have a product attached to it.
List followers of a product
Lists the followers of a product.
List files attached to an organization
Lists files associated with an organization.
List participants of a deal
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.
List role assignments lists role assignments for a user
Lists role assignments for a user.
List settings of an authorized user
Lists the settings of an authorized user. example response contains a shortened list of settings.
List permitted users list users permitted to access a person
List users permitted to access a person.
List permitted users lists users permitted to access a product
Lists users permitted to access a product.
List persons of an organization
Lists persons associated with an organization.if a company uses the campaigns product, then this endpoint will also return the data.marketing status field.
List role assignments
Returns all users assigned to a role.
List permission set assignments
Returns the list of assignments for a permission set.
List pipeline visibility for a role
Returns a list of visible or hidden pipeline ids by role. see the “visibility groups article” for details on pipeline visibility.
List updates about a person
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.
List updates about a deal
Lists updates about a deal.
Merge two organizations
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>.
Merge two deals
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>.
List user role settings
Lists the settings of user’s assigned role.
List role settings
Returns the visibility settings of a specific role.
List updates about participants of a deal
This endpoint provides cursor-paginated updates on deal participants. for pagination details, see the pipedrive documentation.
List updates about an organization
Lists updates about an organization.
List user permissions
Lists aggregated permissions over all assigned permission sets for a user.
List products associated with a person
Lists products associated with a person.
Organization accessible user list
List users permitted to access an organization.
Merge two persons
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>.
Perform a search from multiple item types
Performs a search from your choice of item types and fields.
List products attached to a deal
Lists products attached to a deal.
Perform a search using a specific field from an item type
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 project groups
Returns all active groups under a specific project.
Receives an incoming message
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.
Refreshing the tokens
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.
Update an installment subscription
Updates an installment subscription.
Update stage details
Updates the properties of a stage.
Returns project activities
Returns activities linked to a specific project.
Returns project plan
Returns information about items in a project plan. items consists of tasks and activities and are linked to specific project phase and group.
Update a lead label
Updates one or more properties of a lead label. only properties included in the request will be updated.
Update an organization
Updates the properties of an organization.
Update a recurring subscription
Updates a recurring subscription.
Requesting authorization
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.
Update a note
Updates a note.
Returns project tasks
Returns tasks linked to a specific project.
Search deals
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.
Update task in project plan
Updates a task phase or group in a project.
Update a person
Modifies a person’s details in pipedrive. see the linked tutorial for guidance. if utilizing campaigns, the endpoint also handles data.marketing status.
Update a team
Updates an existing team and returns the updated object.
Update a task
Updates a task.
Search leads
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.
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.
Update the product attached to a deal
Updates the details of the product that has been attached to a deal.
A video calling provider must call this endpoint to remove the link between a user and the installed video calling app.
Update a deal
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>.
Update filter
Updates an existing filter.
Update activity in project plan
Updates an activity phase or group in a project.
Update an activity
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).
Update pipeline visibility for a role
Updates pipeline visibility settings for different roles. for details, see the pipedrive visibility groups article.
Updates the parent role and/or the name of a specific role.
Update user details
Updates the properties of a user. currently, only active flag can be updated.
Update a lead
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.