Pipedrive API Documentation

The testing-readme Developer Hub

Welcome to the testing-readme developer hub. You'll find comprehensive guides and documentation to help you start working with testing-readme as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Requests

Last updated January 28, 2018

All requests to the Pipedrive API must be made over SSL (https, not http).

We recommend using JSON body format when performing API requests. In order to do a proper JSON-formatted request, make sure you provide Content-Type: application/json in HTTP request headers. Regular form-encoded body format is also supported but you may experience quirks related to lack of data types. Our API uses the HTTP verbs for each action:

Method
Description

GET

Used for retrieving resources.

POST

Used for creating resources.

PUT

Used for replacing resources or collections.

DELETE

Used for deleting resources.

URL naming

Our API uses a straight-forward URL naming convention.

Field selector

When asking for a collection/list of objects, you can pass in a field selector to indicate which fields you would like to fetch per each object. Most endpoints in our API Reference support this, but not all.

The field selector is supported in both requests done with OAuth and requests done with the api_token. For example, you may only want to fetch a Deal's ID, title, value, and currency when asking the Deals list - this can be done by using the following syntax:

Request with OAuth:

GET https://api-proxy.pipedrive.com/deals:(id,title,value,currency)

Request with api_token:

GET https://companydomain.pipedrive.com/v1/deals:(id,title,value,currency)?api_token=659c9fddb16335e48cc67114694b52074e812e03

You can also see the field selector being used in our Updating Custom Fields' Values tutorial.


Further reading

Rate limiting

Requests


Last updated January 28, 2018

Suggested Edits are limited on API Reference Pages

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