Pipedrive API Documentation

Pipedrive's API Docs

Welcome to Pipedrive's Developer Documentation. Here you'll find comprehensive guides and documentation to help you start working with Pipedrive's API, as well as the Changelog to see any relevant changes regarding the public API.

About the Marketplace

What is the Pipedrive Marketplace?

The Pipedrive Marketplace is a platform that allows Pipedrive customers to install apps that add and extend both capabilities and possibilities of what a user can do with their account. If you build an app, this is where people will be able to search for and find it.

All integrations, UI extensions, background services, etc that are listed and installable in the Marketplace are referred to as apps.

Publishing an app in our Marketplace allows it to be visible to over 90,000 Pipedrive users and in addition, all newly published apps receive preliminary marketing from our end with the potential for additional marketing (dependent on additional factors).

Once your app is visible in the Marketplace, you can immediately see the advantage your app will receive, such as:

  • Better browsing experience - app listings can include images, a video, and more detailed descriptions
  • One-click installing - the ability to quickly try out apps
  • Granular permissions - different apps can perform different operations within your Pipedrive account
  • Overview - all installed apps managed in one central place

In order to inspire more people to install your app, we recommend placing creativity and thought into a well-constructed landing page. A landing page not only gives users a chance to get to know your app and it's functionalities, but also to leave reviews and rate your app. Your app's position in some of the Marketplace's Collections (e.g. Trending apps, Top rated apps) is directly based off of ratings and reviews given to the app. You can additionally increase the visibility of your app by developing app extensions, giving your app a chance to be shown in the App extensions Collection.

Want to add your own app?

Great! You can create an app using either OAuth or API token integration. You can start by requesting a Developer Sandbox accounts. Learn more about creating an app here.

The differences between OAuth apps and API token integrations

Apps listing

Each app (both OAuth app and API token-based integrations) available in the Marketplace should have its own public app's listing page which promotes the app, it's functionality and how the app works together with Pipedrive.

Read more about how to manage your app listing here.

Authentication and authorization

For API token integrations, the authentication is based on the api_token.

For apps, it's based on a way we've built to provide access to our API - a convenient, secure and transparent OAuth 2.0 protocol. Here's how the OAuth Authorization flow works and how you can start implementing it into your app.

We've also introduced OAuth access scopes that allow granular access control and help the user identify the permissions they are granting to the app.

Read more about the scopes and their mapping to Pipedrive public API endpoints here.

App installation

From the customer's perspective, the installation of Marketplace apps has become much easier than the manual set-up process of integrations. Thanks to OAuth, the apps can be installed straight from the Marketplace with a few clicks.

From the developer partner's perspective, it's possible to control a part of the installation flow (with the callback URL) and provide a better on-boarding experience for the users after app installation.

Marketing

Apps based on the API token integration will not be eligible for any preliminary or additional co-marketing campaigns. In addition, these apps won't be able to receive any reviews and thumbs up/down votes by customers in the Marketplace and they won't have their own app listing page in the Pipedrive Marketplace.

API token integration
OAuth app

Preliminary marketing

Co-marketing campaigns

Customer reviews and voting

Public app's listing page in the Pipedrive Marketplace

Updated 9 months ago


About the Marketplace


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.