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.

Registering the app

After you've requested yourself a Developer Sandbox account, the next step of creating an app is to register your new app in the Marketplace Manager. To do this, follow the steps below:

Step 1: Go to the Marketplace Manager

First, go to the Settings page by choosing Tools and integrations from the drop-down menu:

Then choose Marketplace Manager left menu:

You must have a Developer Sandbox account for app creation to see Marketplace Manager

You must have a Developer Sandbox account for app creation to see Marketplace Manager

Step 2: Register a new app

Start by clicking the green "Create new app" button. Here you'd also see a list of your already registered apps if you'd have any:

Step 3: Fill in the form

That's what the beginning of the form you need to fill in looks like. Here we've pointed out the two required fields necessary to create the app - the App name and the OAuth Callback URL. Other fields marked as required will be validated when you're sending your app to review.

Disclaimer: The Marketplace team reserves the right to make small changes to text fields and images uploaded to the app's listing in order to give the best possible user experience. You'll be notified when something is edited.

General information

Field
Description

App name (required)

Insert your app's name by what it's going to be recognized in the Marketplace.

Example: Random

Company

This name will appear publicly on the Pipedrive Marketplace.
It should be the name of the company responsible for developing the app.
To change the company name click “edit” under the company name, you'll be taken to Company settings.

Example: Random Inc

Short summary (required)

Summarize the essence of what your app does. It will be shown in the list views and other places where the full description cannot be shown in the Marketplace.

Example: Awesome random app that will help you to manage your tasks and the workflow better

Description (required)

Clearly state what your app does and why the integration with Pipedrive is useful. It needs to be unique text specifically tailored for the Pipedrive Marketplace to avoid being marked as double content by search engines

Example: Discover this awesome app that will help to manage your tasks in Pipedrive by motivating you not to procrastinate! The Random app has received many excellent user reviews, among them Quinn Smith's feedback:
"It feels so empowering to actually have control over my work!"

Categories (required)

Choose max two categories from the drop-down menu which best represent your app's use case.

Example: Task and workflow management

App icon (required)

Upload an icon that represents your app the best (be aware of the file type and sizing requirements).
Icon criteria:

  • PNG, JPG
  • 1:1 aspect ratio
  • min 256x256 px
  • max 10 MB

YouTube video link (one link)

Add a link to a video which depicts the capabilities of your app specifically demonstration how it works together with Pipedrive. We recommend you use the video to market your app.

We currently support only Youtube video links.

App listing images (1 required, max 5)

Upload max 5 images which should be helpful to users by illustrating how the app works, highlighting key areas and demonstrating the general flow process.

Image criteria:

  • PNG, JPG
  • 16:10 aspect ratio
  • max size 10MB
  • 1280x800, 1440x900, 2560x1600 or 2880x1800 pixels - the bigger the better!

OAuth and Access scopes

Field
Description

Callback URL (required, one URL per app)

Insert a link to which an authorization code will be sent to if the user approves or declines the installation of your app. This link is also where we return the user to after successful authentication. Technically, a callback URL is the same thing as an OAuth redirect_uri. It's ok to insert a non-functioning URL when creating a new app as long as you can update this field with a proper URL after implementing the logic needed for accepting user authorization in your code. Please keep in mind that we allow only one callback URL per app.
Example: https://www.randomawesomeapp.com/API/v2/callback

Access scopes (required)

By using scopes you can specify what kind of data access your application needs exactly. Your selection will depend a lot on the endpoints you end up using in your app. Start by choosing the least amount of scopes as possible. Then, based on the endpoints you use in your code, enable additional scopes according to this mapping.
Example:
:white-check-mark+: Search for all data
:white-check-mark+: Read users data

App extensions

App actions
Learn more here.

Field
Description

Action name (required, max 30 characters)

Insert your app action's name that will be displayed in the Pipedrive UI. The name should be short, descriptive of the app action, and be in a sentence case format.

Example: Add to email list

URL link (required)

Add the URL that will redirect the user to the correct app page when an action is clicked. The URL must handle both scenarios of the user being logged into your app and not being logged in.

Example: https://www.randomawesomeapp.com/handle_action

Locations (one required)

Specify in which views the app action will be displayed. There can be a maximum of 3 app actions per app in one view, altogether 24 (8 different views x 3 actions per view).

Example:
:white-check-mark+: Activities list
:white-check-mark+: Person details

App panels
Learn more here.

Field
Description

Panel name (required)

Insert your app panel's name that will be displayed in the Pipedrive UI. App panel's name should be descriptive and maximum of 30 characters.

Example: Lead generation app - Visits

API Endpoint (required)

The URL of the endpoint which we'll use to fetch the data of the object properties

Example: www.api.pipedrive.com/deal-view/visits

HTTP Auth username (required) and HTTP Auth password (required)

Our service will send the HTTP request with these credentials as the Basic Authentication header to protect your data. To protect your data, we strongly recommend using authenticated HTTPS requests. Note that we do not support self-signed certificates.

JSON data structure (required)

A JSON file that describes the structure of your app panel seen in the Pipedrive UI. See here for more information.

Panel locations (one required)

Choose one place where the app panel would be displayed:

  • Deals details (view)
  • People details (view)
  • Organizations details (view)

Setup and installation

Field
Description

Instructions for users (max 1500 characters)

Remember to give helpful step-by-step instructions not only to existing customers but also newcomers who will set up the integration from scratch as they will need to understand the level of effort required (for example, the first step could be creating an account at your service).

Support and legal info

Field
Description

Website URL (required)

Insert a link to your app's website.

Example:
https://www.randomawesomeapp.com

Terms of Service URL (required)

Insert a link to your app's Terms of Service webpage with rules which users must agree to abide by in order to use your service/app.

Example: https://www.randomawesomeapp.com/rules

Privacy Policy URL (required)

Insert a link to your app's Privacy Policy webpage of a legal document that has most or all the information of how user's data is gathered, used, communicated and managed.

Example: https://www.randomawesomeapp.com/help/privacypolicy

Support URL

Insert a link to your app's Support website's main page, where a user with questions/problems can find answers about: different support channels and their SLAs, FAQs, self-service support resources, maybe even discover tips and tricks about your app, or get general help.

Example: https://www.randomawesomeapp.com/support

Support email

Insert an email address for your app's Support contact if the user needs direct help.

Example: [email protected]

Documentation URL

Insert a link to your app's documentation website from where the user can familiarize oneself with your app's features: a detailed description of what your app can do and how, tutorials/articles for getting started or specific use cases, etc.

Example: https://www.randomawesomeapp.com/help

Issue tracker URL

Insert a link to your issue tracker website, where users could go and report bugs or any other issues noticed when using your app.

Example: https://gitzhubz.com/randomawesomeapp/issues

Your contact info

Field
Description

Main contact email (required)

The main point of contact to receive technical updates and notifications from Pipedrive.
You can switch the toggle to green and agree to receive notifications about new, edited or deleted reviews.

Before sending to review

Field
Description

Installation scenarios are tested (required)

A user does not have an account with you and installs the app
(Installation runs through the process of creating an account and finishes the app install)

A user does have an account with you, but isn't logged in and installs the app
(Installation runs through login on your side and finished the app install)

A user has an account with you, is logged in, and install the app
(Installation recognizes the user is logged in and finishes the app install)

Pipedrive Developer Partner Agreement (required)

I agree to the terms and conditions of the Pipedrive Developer Partner Agreement
(It covers details about leaving a review for your own app, the privacy of the Customer Data, app approval process and more)

Step 4: Save app

When you've filled in the form, click on the green "Save" button and save your app.

After saving, your app will be hidden by default and you'll see your app's status next to the app name.

Your app will be assigned a unique client_id and client_secret, which can be seen on the app listing's edit page in OAuth & Access scopes section. These values are necessary to go through authorization and receive the access_token to be used in API requests.

To be published on the Marketplace, your app needs to pass our app approval process.
Note that submitting the app is not necessary if it's only used within your Pipedrive company account.

Updated 4 months ago


Registering the app


Suggested Edits are limited on API Reference Pages

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