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.

Pipedrive API in Postman or Insomnia

In this guide, we'll give you a basic overview of how to make your first requests to the Pipedrive API using two API testing tools - Postman and Insomnia.

If you prefer to use a different tool, you can always import our Open API 3 specification file to your tool of choice using this URL: https://developers.pipedrive.com/docs/api/v1/openapi.yaml

Keep in mind that we'll occasionally update our Open API 3 specification file, so you might need to re-import it from time to time.


Pipedrive + Postman

Setup

If you don't have Postman yet, start by downloading and installing it from https://www.getpostman.com/downloads/.

Once you have Postman installed, you can start adding the Pipedrive API collection by clicking to this button:

Authorization

The easiest way to authorize your requests is to add your api_token. To do that you will first need to find your API token (see how to do that here).

Next, continue with the following steps:

  • To authorize your requests, add your api_token to Postman by clicking on the drop-down menu (three-dot icon) next to the collection name.
  • Choose "Edit".
  • In the new edit screen, click on the "Authorization" tab.
  • Add the type of authorization method, the Key (which is api_token), the value of your api_token and choose "Add to" to be "Query Params".
  • Now confirm it all by clicking on "Update".

Now you can make your first requests. Make sure that under the Authorization tab, the authorization type is selected as "Inherit auth from parent".


Pipedrive + Insomnia

Setup

If you don't have Insomnia yet, first start by installing it from https://insomnia.rest/download/.

Next, continue with adding the Pipedrive API collection:

  1. Open Insomnia and click on the small arrow next to "Insomnia". From the drop-down menu choose "Import/Export".
  2. From the "Import Data" tab choose "From URL" and add the URL of the specification file: https://developers.pipedrive.com/docs/api/v1/openapi.yaml
  3. Once the Collection has been imported, you will see a small yellow triangle on the left-hand side indicating that no environment has been chosen yet. Choose the "Use OpenAPI env" to get started.

Authorization

In Insomnia you can use many different authorization methods similar to Postman. These can be added by clicking on the small down-pointing arrow next to the "Auth" tab.

If you want to use your api_token, it needs to be added as an environment variable.

To add it as an environment variable, first, choose the "Manage environment" from the same drop-down menu where you previously chose to use the OpenAPI environment. Next, add your api_token to the already existing variables. api_token's value needs to also include the ?api_token=param in addition to the token as it isn't included in the base URL.

Now you can make your first requests. Make sure to add the api_token variable to the URL before sending your request.

Updated about a month ago

Pipedrive API in Postman or Insomnia


Suggested Edits are limited on API Reference Pages

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