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 OpenAPI 3 specification files (available for both v1 and v2 APIs) into your tool of choice.

📘
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 this button:

Authorization

The easiest way to authorize your requests is by using your API token. To do that you will first need to find it under your Personal preferences settings page in Pipedrive (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 collection name.
Click on the "Auth" tab.
Add the type of authorization method, the Key (which is x-api-token), the value of your API token and choose "Add to" to be "Header".

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 and Authorization

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:

Open Insomnia and click on the "Import"
Choose "Url" and add the URL of the specification file: https://developers.pipedrive.com/docs/api/v1/openapi.yaml (v1) or https://developers.pipedrive.com/docs/api/v1/openapi-v2.yaml (v2)
Once the API specification has been imported, click on it and select "Generate collection" from the Spec tab
Choose "OpenAPI env" from the Environments dropdown menu.
Click on the Edit icon next to "Collection Environments" and add your API token as the xApiToken variable value

Now you can make your first requests! The Auth tab should be pre-filled with the correct environment values: