Pipedrive exposes its complete platform to developers through its API. As a Web API following the RESTful architecture principles, it can be accessed through HTTP.
As a RESTful API, interacting with it can be achieved using tools like CURL or Postman or by using HTTP clients for your favorite language or framework. A few suggestions:
Pipedrive API Authentication
Pipedrive API Authentication is API-Key based. You acquire an API Key from the platform and you can use it to authenticate to the API securely. All the calls are executed over secure HTTPS.
Pipedrive Rate Limiting
Rate limiting is considered per API token. API allows performing 100 requests per 10 seconds.
Every API response includes the following headers:
- X-RateLimit-Limit: the number of requests the current API token can perform for the 10 seconds window.
- X-RateLimit-Remaining: the number of requests left for the 10 seconds window.
- X-RateLimit-Reset: the amount of seconds before the limit resets.
Suppose the limit is exceeded for the time window. In that case, the Pipedrive API will return an error response with HTTP code 429 and Retry-After header that will indicate the number of seconds before the limit resets.
Endpoints and Available Resources
Pipedrive exposes a large number of endpoints from which we can interact with the platform. These endpoints can be used to execute commands like adding a new person to our contact list and pulling data from it. A unique characteristic of the Pipedrive API is that a companion resource manages the custom fields that you might have created for the resource for many of the resources. In this way, maximum flexibility is offered to the users of the platform. The list of available resources follows:
- Activities: Activities are appointments, tasks and events in general that can be associated with a deal and your sales pipeline.
- Activity Fields: custom fields created for your activities.
- Activity Types: user-defined types for your activities
- Authorization: Authorization objects can be fetched without an API token but using an email and password.
- Currencies: Supported currencies that can represent the monetary value of a Deal or a value of any monetary type custom field.
- Deals: Deals represent ongoing, lost, or won sales to an organization or to a Person.
- Deal Fields: DealFields represent the near-complete schema for a Deal in the context of the company of the authorized user.
- Email Messages: EmailMessages represent e-mail messages sent or received through Pipedrive designated e-mail account.
- Email Threads: EmailThreads represent e-mail message threads that contain individual e-mail messages.
- Files: Files are documents of any kind (images, spreadsheets, text files, etc.) that are uploaded to Pipedrive
- Filters: Each filter is essentially a set of data validation conditions.
- Goals: Goals help your team meet your sales targets.
- Mail Messages: MailMessages represent mail messages synced with Pipedrive using the 2-way sync or the Smart Email BCC feature.
- MailThreads: MailThreads represent mail threads that contain individual mail messages.
- Notes: Notes are pieces of textual (HTML-formatted) information that can be attached to Deals, Persons, and Organizations.
- Note Fields: Custom fields for Notes.
- Organizations: Organizations are companies and other kinds of organizations you are making Deals with.
- Organization Fields: OrganizationFields represent the near-complete schema for an Organization in the context of the company of the authorized user.
- Persons: Persons are your contacts, the customers you are doing Deals with
- Person Fields: Custom fields for persons.
- Pipelines: Pipelines are essentially ordered collections of Stages.
- Products: Products are the goods or services you are dealing with.
- Product fields: ProductFields represent the near-complete schema for a Product.
- Stages: Stage is a logical component of a Pipeline and essentially a bucket that can hold many Deals.
- Users: Users are people with access to your own Pipedrive account.
For a detailed list of all endpoints together with a way to make requests to them without a client to see every data they return, if you have a Pipedrive account. Please check here.
It is clear that with such a rich platform and API all data that can be pulled out of Pipedrive are both valuable and come in large quantities. So, let’s assume that we want to pull all the persons out of Pipedrive to use the associated data for further analysis. To do so we need to make a GET request with your favorite client to the Persons’ endpoint like this.
The response headers and the actual response will look like the following:
"date": "Tue, 06 Sep 2016 15:46:38 GMT",
"x-xss-protection": "1; mode=block",
Inside the response, there will be an array of objects with each one representing one Person as it is represented in Pipedrive. Please note that all data is serialized in JSON.
After successfully pulling your data using the Pipedrive API, you are ready to extract and prepare them for BigQuery. Of course, the above process is only for one of the available resources, if you would like to have a complete view of all the available data, then you will have to create a much more complex ETL process including the majority of the resources that Pipedrive has. Alternatively, you can check RudderStack, which can simplify the whole process and you can have your own Pipedrive data available for analysis in a few minutes.