How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pipedrive Deals API

Deals represent ongoing, lost or won sales to an organization or to a person. Each deal has a monetary value and must be placed in a stage. Deals can be owned by a user, and followed by one or many users. Each deal consists of standard data fields but can also contain a number of custom fields. The custom fields can be recognized by long hashes as keys. These hashes can be mapped against `DealField.key`. The corresponding label for each such custom field can be obtained from `DealField.name`.

Pipedrive Deals API is one of 48 APIs that Pipedrive publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Deals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 32 operations across 25 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.pipedrive.com/v1.

32 operations 25 paths 0 schemas 4 DELETE19 GET2 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Server
https://api.pipedrive.com/v1
Authentication
HTTP Basic, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Pipedrive Deals API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basic_authentication). An API key is passed in the header as x-api-token (api_key). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 27 scopes.

  • basic_authentication — Base 64 encoded string containing the clientid and clientsecret values. The header value should be Basic .
  • oauth2 — For more information, see https://pipedrive.readme.io/docs/marketplace-oauth-authorization

Paths & Operations 32

Across 25 paths, the API surfaces 32 operations — 4 DELETE, 19 GET, 2 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Deals 32

Deals represent ongoing, lost or won sales to an organization or to a person. Each deal has a monetary value and must be placed in a stage. Deals can be owned by a user, and follo…

GET
/deals/archiveddeprecated
Get all archived deals
getArchivedDeals 12 params → 200
GET
/deals/summary
Get deals summary
getDealsSummary 5 params → 200
GET
/deals/summary/archiveddeprecated
Get archived deals summary
getArchivedDealsSummary 5 params → 200
GET
/deals/timeline
Get deals timeline
getDealsTimeline 9 params → 200
GET
/deals/timeline/archiveddeprecated
Get archived deals timeline
getArchivedDealsTimeline 9 params → 200
GET
/deals/{id}/changelog
List updates about deal field values
getDealChangelog 3 params → 200
POST
/deals/{id}/duplicate
Duplicate deal
duplicateDeal 1 param → 200
GET
/deals/{id}/files
List files attached to a deal
getDealFiles 4 params → 200
GET
/deals/{id}/flow
List updates about a deal
getDealUpdates 5 params → 200
GET
/deals/{id}/participantsChangelog
List updates about participants of a deal
getDealParticipantsChangelog 3 params → 200
GET
/deals/{id}/followers
List followers of a deal
getDealFollowers 1 param → 200
POST
/deals/{id}/followers
Add a follower to a deal
addDealFollower 1 param body → 200
DELETE
/deals/{id}/followers/{follower_id}
Delete a follower from a deal
deleteDealFollower 2 params → 200
GET
/deals/{id}/mailMessages
List mail messages associated with a deal
getDealMailMessages 3 params → 200
PUT
/deals/{id}/merge
Merge two deals
mergeDeals 1 param body → 200
GET
/deals/{id}/participants
List participants of a deal
getDealParticipants 3 params → 200
POST
/deals/{id}/participants
Add a participant to a deal
addDealParticipant 1 param body → 200
DELETE
/deals/{id}/participants/{deal_participant_id}
Delete a participant from a deal
deleteDealParticipant 2 params → 200
GET
/deals/{id}/permittedUsers
List permitted users
getDealUsers 1 param → 200
GET
/deals
Get all deals
getDeals 18 params → 200
POST
/deals
Add a new deal
addDeal body → 200
DELETE
/deals/{id}
Delete a deal
deleteDeal 1 param → 200
GET
/deals/{id}
Get details of a deal
getDeal 5 params → 200
PATCH
/deals/{id}
Update a deal
updateDeal 1 param body → 200
GET
/deals/{id}/followers/changelog
List followers changelog of a deal
getDealFollowersChangelog 3 params → 200
GET
/deals/search
Search deals
searchDeals 9 params → 200
GET
/deals/{id}/discounts
List discounts added to a deal
getAdditionalDiscounts 1 param → 200
POST
/deals/{id}/discounts
Add a discount to a deal
postAdditionalDiscount 1 param body → 201
PATCH
/deals/{id}/discounts/{discount_id}
Update a discount added to a deal
updateAdditionalDiscount 2 params body → 200
DELETE
/deals/{id}/discounts/{discount_id}
Delete a discount from a deal
deleteAdditionalDiscount 2 params → 200
POST
/deals/{id}/convert/lead
Convert a deal to a lead
convertDealToLead 1 param → 200404
GET
/deals/{id}/convert/status/{conversion_id}
Get Deal conversion status
getDealConversionStatus 2 params → 200404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pipedrive-deals-api-openapi.yml Raw ↑

Other APIs Pipedrive publishes across the network.

Pipedrive Activities API
Pipedrive ActivityFields API
Pipedrive ActivityTypes API
Pipedrive Beta API
Pipedrive Billing API
Pipedrive CallLogs API
Pipedrive Channels API
Pipedrive Currencies API
Pipedrive DealFields API
Pipedrive DealInstallments API
Pipedrive DealProducts API
Pipedrive Files API
Where this information came from

This is an independent, third-party profile of Pipedrive Deals API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.