Organization Id

Activities

Activity Types

Deal Products

Prospector

Lead Suggestions

Web forms

Chatbot

Live chat

Web visitors

Campaigns

Marketplace

Messaging Inbox

Source channel

Manually created

Import

Automation

Lead suggestions

Web Forms

Live Chat

Web Visitors

Messaging inbox

Source origin

Deals

Filters

Lead Labels

Creator

Expected Close Date

Label(s)

Next Activity

Organization

Owner

Person

Leads

Notes

Address

Organizations

Persons by Filter

Persons

Pipelines

Owner & followers

Entire company

Products

Projects

Stages

Users

Pipedrive

Sample API

Marks multiple activities as deleted. After 30 days, the activities will be permanently deleted.

Delete multiple activities in bulk

Returns all activities assigned to a particular user.

Get all activities assigned to a particular user

Adds a new 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). For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-an-activity" target="_blank" rel="noopener noreferrer">adding an activity</a>.

Add an activity

Marks an activity as deleted. After 30 days, the activity will be permanently deleted.

Delete an activity

Returns the details of a specific activity.

Get details of 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 an activity

Get all activity fields

Marks multiple activity types as deleted.

Delete multiple activity types in bulk

Get all activity types

Add new activity type

Delete an activity type

Update an activity type

Returns the add-ons for a single company.

Get all add-ons for a single company

Add a call log

Returns all call logs assigned to a particular user.

Get all call logs assigned to a particular user

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 call log

Get details of a 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.

Attach an audio file to the call log

Adds a new messaging channel, only admins are able to register new channels. It will use the getConversations endpoint to fetch conversations, participants and messages afterward. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Add a channel

Deletes an existing messenger’s channel and all related entities (conversations and messages). To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Delete a channel

Adds a message to a conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Receives an incoming message

Deletes an existing conversation. To use the endpoint, you need to have **Messengers integration** OAuth scope enabled and the Messaging manifest ready for the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).

Delete a conversation

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 supported currencies

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>.

Get all deals

Adds a new deal. 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. To determine which custom fields exists, fetch the dealFields and look for `key` values. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/creating-a-deal" target="_blank" rel="noopener noreferrer">adding a deal</a>.

Add a deal

Marks multiple deals as deleted. After 30 days, the deals will be permanently deleted.

Delete multiple deals in bulk

Searches all deals by title, 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. Found deals can be filtered by the person ID and the organization ID.

Search deals

Get deals summary

Returns open and won deals, grouped by a defined interval of time set in a date-type dealField (`field_key`) — e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups — January, February and March — based on the value of the given `field_key`.

Get deals timeline

Marks a deal as deleted. After 30 days, the deal will be permanently deleted.

Delete a deal

Returns the details of a specific deal. Note that this also returns some additional fields which are not present when asking for all deals – such as deal age and stay in pipeline stages. Also note that custom fields appear as long hashes in the resulting data. These hashes can be mapped against the `key` value of dealFields. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/getting-details-of-a-deal" target="_blank" rel="noopener noreferrer">getting details of a deal</a>.

Get details of 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 a deal

List activities associated with a deal

Duplicate deal

List files attached to a deal

List updates about a deal

List followers of a deal

Add a follower to a deal

Delete a follower from a deal

Lists mail messages associated with a deal.

List mail messages associated with a deal

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>.

Merge two deals

Lists the participants associated with a deal.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.

List participants of a deal

Add a participant to a deal

Delete a participant from a deal

Lists the users permitted to access a deal.

List permitted users

Lists all persons associated with a deal, regardless of whether the person is the primary contact of the deal, or added as a participant.<br>If a company uses the [Campaigns product](https://pipedrive.readme.io/docs/campaigns-in-pipedrive-api), then this endpoint will also return the `data.marketing_status` field.

List all persons associated with a deal

List products attached to a deal

Adds a product to a deal, creating a new item called a deal-product.

Add a product to a deal

Updates the details of the product that has been attached to a deal.

Update the product attached to a deal

Deletes a product attachment from a deal, using the `product_attachment_id`.

Delete an attached product from a deal

Get all deal fields

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>.

Add a new deal field

Delete multiple deal fields in bulk

Returns data about a specific deal field.

Get one deal field

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>.

Delete a deal field

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>.

Update a deal field

Get all files

Lets you upload a file and associate it with a deal, person, organization, activity, product or lead. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-file" target="_blank" rel="noopener noreferrer">adding a file</a>.

Add file

Creates a new empty file in the remote location (`googledrive`) that will be linked 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>.

Create a remote file and link it 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>.

Link a remote file to an item

Marks a file as deleted. After 30 days, the file will be permanently deleted.

Delete a file

Get one file

Update file details

Download one file

Delete multiple filters in bulk

Get all filters

Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-filter" target="_blank" rel="noopener noreferrer">adding a filter</a>.

Add a new filter

Returns all supported filter helpers. It helps to know what conditions and helpers are available when you want to <a href="/docs/api/v1/Filters#addFilter">add</a> or <a href="/docs/api/v1/Filters#updateFilter">update</a> filters. For more information, see the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-filter" target="_blank" rel="noopener noreferrer">adding a filter</a>.

Get all filter helpers

Delete a filter

Returns data about a specific filter. Note that this also returns the condition lines of the filter.

Get one filter

Update filter

Adds a new goal. Along with adding a new goal, a report is created to track the progress of your goal.

Add a new goal

Returns data about goals based on criteria. For searching, append `{searchField}={searchValue}` to the URL, where `searchField` can be any one of the lowest-level fields in dot-notation (e.g. `type.params.pipeline_id`; `title`). `searchValue` should be the value you are looking for on that field. Additionally, `is_active=<true|false>` can be provided to search for only active/inactive goals. When providing `period.start`, `period.end` must also be provided and vice versa.

Find goals

Update existing goal

Delete existing goal

Gets the progress of a goal for the specified period.

Get result of a goal

Performs a search from your choice of item types and fields.

Perform a search from multiple item types

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).

Perform a search using a specific field from an item type

Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest. Pagination can be controlled using `limit` and `start` query parameters. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals.


Get all leads

Creates a lead. A lead always has to be linked to a person or an organization or both. All leads created through the Pipedrive API will have a lead source `API` assigned. Here's the tutorial for <a href="https://pipedrive.readme.io/docs/adding-a-lead" target="_blank" rel="noopener noreferrer">adding a lead</a>. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields' structure from deals. See an example given in the <a href="https://pipedrive.readme.io/docs/updating-custom-field-value" target="_blank" rel="noopener noreferrer">updating custom fields' values tutorial</a>.

Add a lead

Returns details of a specific lead. If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals.

Get one lead

Updates one or more properties of a lead. Only properties included in the request will be updated. Send `null` to unset a property (applicable for example for `value`, `person_id` or `organization_id`). If a lead contains custom fields, the fields' values will be included in the response in the same format as with the `Deals` endpoints. If a custom field's value hasn't been set for the lead, it won't appear in the response. Please note that leads do not have a separate set of custom fields, instead they inherit the custom fields’ structure from deals. See an example given in the <a href="https://pipedrive.readme.io/docs/updating-custom-field-value" target="_blank" rel="noopener noreferrer">updating custom fields’ values tutorial</a>.

Update a lead

Delete a lead

Searches all leads by title, 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. Found leads can be filtered by the person ID and the organization ID.

Search leads

Returns details of all lead labels. This endpoint does not support pagination and all labels are always returned.

Get all lead labels

Add a lead label

Updates one or more properties of a lead label. Only properties included in the request will be updated.


Update a lead label

Delete a lead label

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.


Field Name	API Key	Type
Query	query	object
User Id	query.user_id	integer
Filter Id	query.filter_id	integer
Type	query.type	string
Limit	query.limit	integer

Field Name	API Key	Type
Success	success	boolean
Data	data	array of items
Id	item.id	number
Company Id	item.company_id	number
User Id	item.user_id	number

Pipedrive API Integration Profile

Get all activities assigned to a particular user in Pipedrive API

Build every single integration your customers need with AI