Home
Providers
Pipedrive
Pipedrive
Pipedrive is a sales CRM and pipeline management tool focused on small and mid-market teams. The Pipedrive REST API exposes deals, persons, organizations, activities, leads, products, pipelines, stages, mail, calls, files, notes, users, permissions, filters, goals, subscriptions, and webhooks.
Pipedrive publishes 48 APIs on the APIs.io network, including Activities API, ActivityFields API, ActivityTypes API, and 45 more. Tagged areas include CRM, Sales, Pipeline Management, SaaS, and Small Business.
The Pipedrive catalog on APIs.io includes 1 event-driven AsyncAPI specification and 1 Spectral governance ruleset.
Pipedrive’s developer surface includes authentication, documentation, API reference, pricing, engineering blog, support, and 18 more developer resources.
48 APIs
10 Features
CRM Sales Pipeline Management SaaS Small Business
On this page
Kin Score
APIs 48
Postman 48
Open Collections 2
GraphQL 1
Pricing Plans 1
Rate Limits 1
FinOps 1
Features 10
Event Specs 1
Spectral Rules 1
Security Posture 2
Scopes 1
Agentic Access 1
Resources 24
apis.yml
61 Operational Transparency
Composite quality — 59.4/100 · strong
Contract Quality
17.3 / 25
Developer Ergonomics
7.4 / 20
Commercial Clarity
16.8 / 20
Operational Transparency
7.9 / 13
Agent readiness — 42/100 · agent ready
Machine-Readable Contract
18 / 18
Agentic Access Contract
10 / 10
MCP Server
0 / 12
Machine-Readable Auth
10 / 10
Idempotency
0 / 9
Stable Error Semantics
0 / 8
Request/Response Examples
7 / 7
Rate-Limit Signaling
7 / 7
Typed Event Surface
6 / 6
Agent Skills
0 / 5
Well-Known Catalog
0 / 4
Consent & Bot Identity
0 / 3
A2A Agent Card
0 / 8
Dry-Run / Simulate Mode
0 / 4
Individual APIs this provider publishes, each with its own machine-readable definition.
Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person and an organization. Activities can be of different type (such as cal...
Activity fields represent different fields that an activity has.
Activity types represent different kinds of activities that can be stored. Each activity type is presented to the user with an icon and a name. Additionally, a color can be defi...
Beta endpoints are endpoints that may have changes without a regular 60-90 day notice period.
Billing is responsible for handling your subscriptions, payments, plans and add-ons.
Call logs describe the outcome of a phone call managed by an integrated provider. Since these logs are also considered activities, they can be associated with a deal or a lead, ...
Channels API allows you to integrate your existing messaging channels into Pipedrive through [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension)....
Supported currencies which can be used to represent the monetary value of a deal, or a value of any monetary type custom field. The `Currency.code` field must be used to point t...
Deal fields represent the near-complete schema for a deal in the context of the company of the authorized user. Each company can have a different schema for their deals, with va...
Deal installments are scheduled payment entries attached to a deal, enabling split payment arrangements.
Deal products are goods or services attached to a deal. Each deal product links a product to a deal with configurable quantity, pricing, and discounts, and contributes to the to...
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 fol...
Files are documents of any kind (images, spreadsheets, text files, etc.) that are uploaded to Pipedrive, and usually associated with a particular deal, person, organization, pro...
Each filter is essentially a set of data validation conditions. A filter of the same kind can be applied when fetching a list of deals, leads, persons, organizations or products...
Goals help your team meet your sales targets. There are three types of goals - company, team and user.
Ordered reference objects, pointing to either deals, persons, organizations, leads, products, files or mail attachments.
Lead fields represent the near-complete schema for a lead in the context of the company of the authorized user. Each company can have a different schema for their leads, with va...
Lead labels allow you to visually categorize your leads. There are three default lead labels: hot, cold, and warm, but you can add as many new custom labels as you want.
Leads are potential deals stored in Leads Inbox before they are archived or converted to a deal. Each lead needs to be named (using the `title` field) and be linked to a person ...
A lead source indicates where your lead came from. Currently, these are the possible lead sources: `Manually created`, `Deal`, `Web forms`, `Prospector`, `Leadbooster`, `Live ch...
Legacy teams allow you to form groups of users withing the organization for more efficient management. Previously Legacy Teams were called Teams and occupied the `v1/teams*` pat...
Mailbox was designed to be the email control hub inside Pipedrive. Pipedrive supports all major providers (including Gmail, Outlook and also custom IMAP/SMTP). There are 2 optio...
Meetings API allows integrating video calling apps into Pipedrive through [Video Calling App extension](https://pipedrive.readme.io/docs/video-calling-app-extension). It enables...
Note fields represent different fields that a note has.
Notes are pieces of textual (HTML-formatted) information that can be attached to deals, persons and organizations. Notes are usually displayed in the UI in chronological order –...
Using OAuth 2.0 is necessary for developing apps that are available in the Pipedrive Marketplace. Authorization via OAuth 2.0 is a well-known and stable way to get fine-grained ...
Organization fields represent the near-complete schema for an organization in the context of the company of the authorized user. Each company can have a different schema for the...
Organization relationships represent how different organizations are related to each other. The relationship can be hierarchical (parent-child companies) or lateral as defined b...
Organizations are companies and other kinds of organizations you are making deals with. Persons can be associated with organizations so that each organization can contain one or...
Permission sets define what users in the account can do: which actions they are allowed to perform and which features they can access. Permission sets are app-specific, where ap...
Person fields represent the near-complete schema for a person in the context of the company of the authorized user. Each company can have a different schema for their persons, w...
Persons are your contacts, the customers you are doing deals with. Each person can belong to an organization. Persons should not be confused with users.
Pipelines are essentially ordered collections of stages.
Product fields represent the near-complete schema for a product in the context of the company of the authorized user. Each company can have a different schema for their products...
Products are the goods or services you are dealing with. Each product can have N different price points - firstly, each product can have a price in N different currencies, and s...
Project boards are used to organize projects into different phases. Each board contains phases that define the workflow for projects.
Project fields represent the schema for a project in the context of the company of the authorized user. Each company can have a different schema for their projects, with various...
Project phases represent the stages within a project board. Each phase belongs to a board and defines a step in the project workflow.
Projects represent ongoing, completed or canceled projects attached to an organization, person or to deals. Each project has an owner and must be placed in a phase. Each project...
Project templates allow you to have reusable and dynamic structure to simplify creation of a project. Project template can contain information about activities, tasks and groups...
Recent changes across all item types in Pipedrive (deals, persons, etc).
Roles are a part of the Visibility groups’ feature that allow the admin user to categorize other users and dictate what items they will be allowed access to see.
Stage is a logical component of a pipeline, and essentially a bucket that can hold a number of deals. In the context of the pipeline a stage belongs to, it has an order number w...
Tasks represent actions that need to be completed and must be associated with a project. Tasks have an optional due date, can be assigned to a user and can have subtasks.
Users are people with access to your Pipedrive account. A user may belong to one or many Pipedrive accounts, so deleting a user from one Pipedrive account will not remove the us...
Scroll for all 48
Ready-to-run Postman collections for exercising this provider's APIs.
Scroll for all 48
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
GraphQL schemas published by this provider.
Published pricing tiers and plan structures.
Documented rate limits and quota policies.
Cost, billing, and metering signals for API financial operations.
Notable capabilities this provider offers.
Scroll for all 10
AsyncAPI definitions for this provider's event-driven and streaming APIs.
Spectral governance rulesets for linting and validating these APIs.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
OAuth scopes governing access to this provider's APIs.
Recommended x-agentic-access execution contracts for AI agents.
Get Started 1
Portal, sign-up, and the first successful call
Documentation 2
Reference material describing how the API behaves
Agent Surfaces 2
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 1
Pagination, idempotency, versioning, errors, and events
Build 2
SDKs, sample code, and the tooling you integrate with
Access & Security 4
Authentication, authorization, and security posture
Operate 4
Status, limits, changes, and where to get help
Commercial 5
Pricing, plans, and the legal terms of use
Company 3
The organization behind the API
Source (apis.yml)
aid: pipedrive
url: https://raw.githubusercontent.com/api-evangelist/pipedrive/refs/heads/main/apis.yml
name: Pipedrive
kind: company
description: Pipedrive is a sales CRM and pipeline management tool focused on small and mid-market teams. The Pipedrive REST
API exposes deals, persons, organizations, activities, leads, products, pipelines, stages, mail, calls, files, notes, users,
permissions, filters, goals, subscriptions, and webhooks.
accessModel:
pricing: paid
onboarding: self-serve
trial: false
try_now: false
public: false
label: Paid · Self-serve signup
confidence: high
source:
- plans
- authentication
generated: '2026-07-22'
method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/pipedrive.png
tags:
- CRM
- Sales
- Pipeline Management
- SaaS
- Small Business
created: '2026-05-08'
modified: '2026-05-30'
specificationVersion: '0.19'
apis:
- aid: pipedrive:pipedrive-activities-api
name: Pipedrive Activities API
description: Activities are appointments/tasks/events on a calendar that can be associated with a deal, a lead, a person
and an organization. Activities can be of different type (such as call, meeting, lunch or a custom type - see ActivityTypes
object) and can be assigned to a particular user. Note that activities can also be created without a specific date/time.
tags:
- Activities
properties:
- type: OpenAPI
url: openapi/pipedrive-activities-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-activityfields-api
name: Pipedrive ActivityFields API
description: Activity fields represent different fields that an activity has.
tags:
- ActivityFields
properties:
- type: OpenAPI
url: openapi/pipedrive-activityfields-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-activitytypes-api
name: Pipedrive ActivityTypes API
description: Activity types represent different kinds of activities that can be stored. Each activity type is presented
to the user with an icon and a name. Additionally, a color can be defined (not implemented in the Pipedrive app as of
today). Activity types are linked to activities via `ActivityType.key_string = Activity.type`. The `key_string` will be
generated by the API based on the given name of the activity type upon creation, and cannot be changed. Activity types
should be presented to the user in an ordered manner, using the `ActivityType.order_nr` value.
tags:
- ActivityTypes
properties:
- type: OpenAPI
url: openapi/pipedrive-activitytypes-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-beta-api
name: Pipedrive Beta API
description: Beta endpoints are endpoints that may have changes without a regular 60-90 day notice period.
tags:
- Beta
properties:
- type: OpenAPI
url: openapi/pipedrive-beta-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-billing-api
name: Pipedrive Billing API
description: Billing is responsible for handling your subscriptions, payments, plans and add-ons.
tags:
- Billing
properties:
- type: OpenAPI
url: openapi/pipedrive-billing-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-calllogs-api
name: Pipedrive CallLogs API
description: Call logs describe the outcome of a phone call managed by an integrated provider. Since these logs are also
considered activities, they can be associated with a deal or a lead, a person and/or an organization. Call logs do differ
from other activities, as they only receive the information needed to describe the phone call.
tags:
- CallLogs
properties:
- type: OpenAPI
url: openapi/pipedrive-calllogs-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-channels-api
name: Pipedrive Channels API
description: 'Channels API allows you to integrate your existing messaging channels into Pipedrive through [Messaging app
extension](https://pipedrive.readme.io/docs/messaging-app-extension). It enables you to manage and interact with the channel’s
conversations, participants and messages inside Pipedrive Messaging inbox: get the historical conversation, receive and
send new messages. These endpoints are accessible only through **Messengers integration** OAuth scope together with Messaging
manifest in building the [Messaging app extension](https://pipedrive.readme.io/docs/messaging-app-extension).'
tags:
- Channels
properties:
- type: OpenAPI
url: openapi/pipedrive-channels-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-currencies-api
name: Pipedrive Currencies API
description: 'Supported currencies which can be used to represent the monetary value of a deal, or a value of any monetary
type custom field. The `Currency.code` field must be used to point to a currency. `Currency.code` is the ISO-4217 format
currency code for non-custom currencies. You can differentiate custom and non-custom currencies using the `is_custom_flag`
property. For custom currencies, it is intended that the formatted sums are displayed in the UI using the following format:
[sum][non-breaking space character][currency.symbol], for example: 500 users. Custom currencies cannot be added or removed
via the API yet — rather the admin users of the account must configure them from the Pipedrive app.'
tags:
- Currencies
properties:
- type: OpenAPI
url: openapi/pipedrive-currencies-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-dealfields-api
name: Pipedrive DealFields API
description: Deal fields represent the near-complete schema for a deal in the context of the company of the authorized user.
Each company can have a different schema for their deals, with various custom fields. In the context of using deal fields
as a schema for defining the data fields of a deal, it must be kept in mind that some types of custom fields can have
additional data fields which are not separate deal fields per se. Such is the case with monetary, daterange and timerange
fields – each of these fields will have one additional data field in addition to the one presented in the context of deal
fields. For example, if there is a monetary field with the key `ffk9s9` stored on the account, `ffk9s9` would hold the
numeric value of the field, and `ffk9s9_currency` would hold the ISO currency code that goes along with the numeric value.
To find out which data fields are available, fetch one deal and list its keys.
tags:
- DealFields
properties:
- type: OpenAPI
url: openapi/pipedrive-dealfields-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-dealinstallments-api
name: Pipedrive DealInstallments API
description: Deal installments are scheduled payment entries attached to a deal, enabling split payment arrangements.
tags:
- DealInstallments
properties:
- type: OpenAPI
url: openapi/pipedrive-dealinstallments-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-dealproducts-api
name: Pipedrive DealProducts API
description: Deal products are goods or services attached to a deal. Each deal product links a product to a deal with configurable
quantity, pricing, and discounts, and contributes to the total value of the deal.
tags:
- DealProducts
properties:
- type: OpenAPI
url: openapi/pipedrive-dealproducts-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentation
url: https://developers.pipedrive.com/docs/api/v1/oauth2
- aid: pipedrive:pipedrive-deals-api
name: Pipedrive Deals API
description: 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`.
tags:
- Deals
properties:
- type: OpenAPI
url: openapi/pipedrive-deals-api-openapi.yml
- type: Documentation
url: https://developers.pipedrive.com/
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Deals
- type: GraphQL
url: graphql/pipedrive-graphql.md
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Leads
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Persons
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Organizations
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Activities
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Pipelines
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Stages
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Products
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Notes
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Files
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Mailbox
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/CallLogs
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Users
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Roles
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Filters
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Goals
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Subscriptions
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Projects
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/DealFields
- type: APIReference
url: https://developers.pipedrive.com/docs/api/v1/Webhooks
- type: Documentation
url: https://pipedrive.readme.io/docs/guide-for-webhooks-v2
- type: AsyncAPI
url: asyncapi/pipedrive-webhooks-v2-asyncapi.yml
- type: Documentat
# --- truncated at 32 KB (126 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pipedrive/refs/heads/main/apis.yml