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

You've learned about the Pipedrive Marketplace and now you want to start working on your own app? You're in the right place! Click here to see the main steps to take.

Types of apps

First, let's introduce you to what types of apps you can create using Pipedrive API:

Public app
Unlisted app
Private app

A public app is visible for all Marketplace visitors.
It'll have it's own public app listing's URL which is also visible to search engine crawlers.
The app has gone through the app approval process and is published to the Marketplace.

An unlisted app offers a way for Pipedrive users to install your app without it being publicly visible in the Marketplace.

Users can access the app via a URL to the (non-public) app listing's page in the Marketplace.
You can access this URL after the app has gone through the app approval process.

A private app is in draft status and only available for users in the same company the app is hosted in.

If you want to have your own internal app available only to the users in your Pipedrive account, please email to [email protected] with the request to have Marketplace Manager enabled for your paid account.

All apps should be developed using OAuth. See OAuth authorization and OAuth API for more information.

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

Creating the app

Follow steps to help your app become a part of our Marketplace.

Step 1: Request a Developer Sandbox account

Work through your integration process in a risk-free environment. Learn more about it here.

Step 2: Register your app in the Marketplace Manager

The Marketplace Manager is a tool to help you manage your apps in the Marketplace. Learn more about it here. From there you can get the client_id and redirect_URI aka callback URL necessary for implementing the OAuth flow.

Step 3: Implement the OAuth flow

You have to add server-side code to your app that performs the OAuth flow. To see what you should consider whilst implementing the installation flows, check out advice for app creation.

Step 4: Submit your app for approval

After you’ve built and tested your app, fill out the rest of the "Creating an app" form and submit the app 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. Don't forget to check out this article about getting your app approved on the first review.
Before submitting your app go over the checklist to make sure your app follows the guidelines. Learn more about it here.

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.

Advice for app creation

Below we'll give you some tips and tricks on how you can create a proper app for the Pipedrive Marketplace.

Don't abuse the API

Instead of long polling (constantly asking for data), consider using Webhooks for Apps. This way you won't hit the rate limit and have data coming to you, not the other way around.

Create a polished installation flow

Let's say a user opens the Marketplace, sees your app, and wants to install it. One-click on the install button will open the OAuth confirmation pop-up with scopes and a possibility to "Allow and Install" or "Cancel". Let's look at these two possibilities:

A. User decides to "Allow and Install"

If the user allows the app installation, they will be directed to your website which must handle any of the following flow scenarios:

  • The user doesn't have an account on your website and will need to become registered
  • The user has an account at your end, but the user is not logged into it
  • The user is logged in to your website
  • The user has multiple companies in Pipedrive (installing an app in one company will not automatically install it for any other company)

The end result should be a successful installation for all the flow scenarios described above.

The installation can either start from our end or yours. If the installation begins from your website and you have the landing page with the app's install button, this will also open the OAuth confirmation pop-up with scopes and a possibility to "Allow and Install" or "Cancel".

If the user clicks on "Allow and Install", then we:

  • Issue the authorization code to you
  • You exchange the code for the tokens
  • You'll have the tokens and use them with the API

B. User decides to "Cancel"

If the user clicks "Cancel", you’ll be notified that the installation didn’t happen as we will send a GET request to your callback URL with the additional parameter of error=user_denied (see also OAuth authorization flow Step 3). The app will need to handle this situation and direct the user back to Pipedrive’s Marketplace to accept the scopes and allow the installation for successful completion of the flow

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 the 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 it's a good idea to build apps that only request scopes that are absolutely necessary for your particular use-case. Read more about scopes and permissions.

Go through the App Approval Process checklist

Although you may have only just begun building your app for the Pipedrive Marketplace, it's still quite useful to read through the checklist we put together that explains the App Approval Process. Following it will help speed up the approval process and avoid resubmissions.

Updated about a month 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.