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.

Creating an app

Apps are web applications that users can install to boost sales and enhance their Pipedrive experience. There are three main types of apps you can create, all of which require authentication either via OAuth or the API token. To get some inspiration on what kinds of apps you can create, find out more about our most popular categories and apps.

Ready to start working on your app? Read on to find out the main steps you need to take, along with key tips to help your app get approved fast:

Types of apps

There are three main types of apps you can create depending on the purpose of your app and your intended users. The app type you choose will determine its visibility on the Marketplace and who can install it.

Installed apps aren't company-wide.
Every user in a company needs to install or set up their own apps and integrations. Regular users who do not have access to the API can also install their own apps.

Public apps

Public apps are for providing a public offering of your integration to any Pipedrive user. Here are some key characteristics of public apps:

  • The app is available for all users in the Pipedrive Marketplace
  • The app is published to our Marketplace with its own public app listing/landing page
  • The app listing in the Pipedrive Marketplace is visible to all Marketplace visitors and search engine crawlers
  • You can offer your public app in the Pipedrive Marketplace
  • Public apps will receive some promotional marketing in collaboration with Pipedrive
  • The app manages authentication with OAuth 2.0
  • The app has polished installation and uninstallation flows
  • The app has to go through Pipedrive’s app approval process

Unlisted apps

Unlisted apps are for providing your integration to selected Pipedrive users. Here are some key characteristics of unlisted apps:

Internal/private apps

Internal apps, aka private apps, for providing your integration only to users in the same company of the account that your app is hosted in.
Here are some key characteristics of internal/private apps:

  • The app is only available for users in the same company as the account that the app is hosted in
  • The app is in draft status and will not be published in our Marketplace
  • The app doesn’t have to go through the app approval process

Although the internal/private app will not be published in our Marketplace, Marketplace Manager still has to be enabled for your paid account in order for your users to install it.

Need Marketplace Manager?
If you would like to have your own internal/private app, please email us at [email protected] so we can enable Marketplace Manager for your account.

Create an app in 5 simple steps

Step 1: Request a Developer Sandbox account

The Developer Sandbox account is a must-have so you can work on your app in a risk-free environment. Learn more about it here and request an account here.

Step 2: Register your app in the Marketplace Manager

The Marketplace Manager is a tool to help you manage your app and its listing page in the Marketplace. Learn more about it here.

NB: The Marketplace Manager is where you can get the client_id and redirect_URI (aka callback URL) that are necessary for implementing the OAuth flow.

Step 3: Ensure your app uses OAuth 2.0 and has proper installation flows

All new apps (public, unlisted and private) in our Marketplace should manage authentication and authorization using OAuth 2.0 and subsequently, enable a smooth installation and uninstallation.
For OAuth, you need to add server-side code to your app so it performs the OAuth flow.

In the Marketplace, users can decide to "Allow and Install" your app or "Cancel" the installation. Your app should have polished installation flows to handle the various flow scenarios that arise based on the user’s decision. To see what you should consider whilst implementing the installation flows, read more here.

Step 4: Do a quality assurance check

Before you submit your app for approval, make sure to go through our app approval process checklist and perform some quality assurance checks on your app. You can even go one step further and find out how you can get your app approved on the first review.

Step 5: Submit your app for approval

When your app is ready, fill out the rest of the details of your app listing and submit it for the app approval process. This should be done if you plan to share your app in our Marketplace or outside your Pipedrive company account.

If you’re feeling lost, our Developers' Community is a great place to connect with others to find and share answers.
In case you're still running into difficulties you can contact us via [email protected] and ask for assistance.

Key tips for building your app

Create a polished installation flow

When users in the Marketplace see your app and want to install it, one click on the “Install now” button will open the OAuth confirmation dialog with scopes and a possibility to "Allow and Install" or "Cancel".

Based on the user’s decision, multiple flow scenarios may arise. Your app should have a polished installation flow to handle any of these scenarios. Read more about installation flows here.

Every user in a company needs to install their own apps (and manual integrations). If a user has multiple companies, they'll need to install every app to each company separately.

Choose your app's scopes wisely

The user of your app has two options: to either accept or deny all scopes, there's no in-between. That's why we recommend building apps that only request scopes that are absolutely necessary for your particular use case. Read more about scopes and permissions.

Don't abuse the API; use webhooks

Instead of polling or constantly asking for data, consider using Webhooks for Apps. This way you won't hit the rate limit and you’ll have data coming to you instead.

Managing and updating your app

After your app is submitted and approved, you can update it when changes are required or if you no longer wish to have it public. Find out more about updating and managing your app here.

Updated 5 months ago

Creating an app

Suggested Edits are limited on API Reference Pages

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