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. Our API supports UTF-8 for character encoding.
POST method, 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:
Used for retrieving resources.
Used for creating resources.
Used for replacing resources or collections.
Used for updating some parts of a resource.
Used for deleting resources.
Our API uses a straight-forward URL naming convention.
- Each request must be made to the API endpoint
https://companydomain.pipedrive.com/api/v1, followed by the type of object in a plural form, for example
- When one item is being asked and such method exists, the ID of the item must be appended to the URL, for example
- When asking for sub-objects of an object, append that to the ID of the master object, for example
- The API token must be provided as part of the query string for all requests using the
api_tokenvariable, for example
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:
You can also see the field selector being used in our Updating Custom Fields' Values tutorial.
Updated 6 months ago