Pipedrive API Essential Guide

What type of API does Pipedrive provide?

Pipedrive offers a RESTful API. Key features of Pipedrive's API include:

• It uses JSON format for output.
• It is capable of handling CORS (Cross-Origin Resource Sharing) requests.
• The API is stateless – all requests are validated against an API token.
• API access is available with every Pipedrive plan for free.

Regarding security, access to the Pipedrive API is only possible using the API key or an access token when using OAuth 2.0. Pipedrive encrypts disks, enforces HTTPS from outside the network, and encrypts certain data inside the database when necessary. They follow the OWASP Framework for security.

Pipedrive provides extensive developer resources, including an API Reference with hundreds of endpoints, Developer Documentation, API client libraries and SDKs on Github, and a ready-to-import Open API 3 specification file for Postman, Insomnia, or any API tool of choice.

The API allows users to connect any software, system, or app in their technology stack with Pipedrive, enabling them to automate tasks, share data, and customize the CRM experience.

Does the Pipedrive API have webhooks?

Yes, the official Pipedrive API does support webhooks. Here are the key points about Pipedrive's webhook functionality:

Webhook Support

• Pipedrive offers webhooks that allow you to receive real-time notifications about changes to your Pipedrive data.
• Webhooks push information to your specified endpoint rather than requiring you to pull data via the API.

Event Types

You can subscribe to various event types, including:

• Added, updated, merged, or deleted events for objects like:

  • Activities
  • Activity types
  • Deals
  • Notes
  • Organizations
  • Persons
  • Pipelines
  • Products
  • Stages
  • Users

• You can use wildcards like *.* to subscribe to all events, or combine specific actions and objects like added.deal or deleted.person.

Key Features

• Webhooks are triggered by events in both the Pipedrive UI and API calls.
• You can filter webhooks based on specific event actions and object types.
• Webhooks include metadata about the event, including whether it was triggered from the app or API.
• There's a maximum limit of 40 webhooks per user.
• Pipedrive has a retry and ban system for failed webhook deliveries.

Setting Up Webhooks

• Webhooks can be created in the Pipedrive web app under Settings > Tools and apps > Webhooks.
• When creating a webhook, you specify:
  • The endpoint URL to receive notifications
  • The event action and object type to subscribe to
  • Optional HTTP authentication for the endpoint

In summary, Pipedrive's webhook system provides a flexible way to receive real-time updates about various events and object changes in your Pipedrive account, allowing for efficient integration with external systems and automation of workflows.

Rate Limits and other limitations

Here are the key points about the API rate limits for the Pipedrive API:

General Rate Limiting

• Rate limiting is considered per token, not per company.
• The rate limit window duration is 2 seconds for both authentication methods (api_token and OAuth access_token).
• Rate limits differ based on the Pipedrive plan and authentication method used.

Rate Limits for api_token Authentication

• Essential plan: 20 requests per 2 seconds
• Advanced plan: 40 requests per 2 seconds
• Professional plan: 80 requests per 2 seconds
• Power plan: 100 requests per 2 seconds
• Enterprise plan: 120 requests per 2 seconds

Rate Limits for OAuth access_token

• Essential plan: 80 requests per 2 seconds
• Advanced plan: 160 requests per 2 seconds
• Professional plan: 320 requests per 2 seconds
• Power plan: 400 requests per 2 seconds
• Enterprise plan: 480 requests per 2 seconds

Daily API Fair Usage Limit

• There is a daily limit of 10,000 POST/PUT requests per user per 24 hours, regardless of plan.
• This daily limit applies across all apps and integrations for a given user.
• The daily limit resets at midnight UTC.

Other Key Points

• Search API endpoints have a separate rate limit of 10 requests per 2 seconds for all plans.
• Webhooks are not subject to rate limiting.
• Response headers include information on remaining rate limits.
• Exceeding rate limits will result in 429 "Too Many Requests" errors.
• Pipedrive may block high volume traffic from api_token integrations that consistently exceed limits.

To avoid hitting limits, Pipedrive recommends restructuring integrations, using webhooks where possible, and upgrading plans for higher limits. The daily 10,000 POST/PUT limit remains the same across all plans.

Latest API Version

Based on the search results provided, the most recent version of the Pipedrive API appears to be version 1 (v1). Here are the key points:

Current API Version

The Pipedrive API is currently at version 1 (v1) [2]. This is evident from the API documentation and references provided in the search results.

Key Points to Consider

• The API uses a RESTful architecture and outputs data in JSON format [2].
• It supports CORS (Cross-Origin Resource Sharing) requests [2].
• The API is stateless, with all requests validated against an API token [2].
• Pipedrive offers official client libraries for Node.js and PHP [2].

API Documentation and Resources

• Pipedrive provides comprehensive API documentation, including an API Reference and Developer Documentation [2][3].
• They offer an OpenAPI 3 specification file that can be imported into tools like Postman or Insomnia [2].
• Developers can access the API using webhooks, API endpoints, client libraries, and SDKs [3].

Best Practices

• Keep up to date with the Pipedrive API Changelog for any updates or breaking changes [3].
• Use the provided developer resources, including the Developer Community and API clients on Github, for support [3].
• Consider creating a separate Pipedrive account for sandboxing and testing purposes [2].

It's worth noting that while the current version is v1, APIs often evolve. Always check the official Pipedrive developer documentation for the most up-to-date information on API versions and features.

How to get a Pipedrive developer account and API Keys?

Here are the key steps to get a developer account for Pipedrive and create an API integration:

1. Create a developer account:

   • Go to the Pipedrive Developer Portal (https://developers.pipedrive.com/)
   • Sign up for a free developer account

2. Request a sandbox account:

   • You can request a sandbox account to test and develop your app in a risk-free environment

3. Create an OAuth app:

   • In the Developer Portal, click "Create an app"
   • Fill in the app name and callback URL (you can use localhost for testing)
   • Select the API scopes you need access to
   • You'll receive a client ID and client secret - store these securely

4. Set up authentication:

   • Implement OAuth 2.0 flow to get an access token for making API calls
   • Pipedrive has documentation on implementing OAuth

5. Start using the API:

   • Use the access token to make API calls to Pipedrive
   • Refer to the API documentation for available endpoints

What can you do with the Pipedrive API?

Here's a list of data models you can interact with using the Pipedrive API, along with what is possible for each:

Leads

• Create, update, and delete leads
• Attach activities, emails, and notes to leads
• Add multiple LeadLabels to categorize leads
• Link leads with one LeadSource
• Must have one person or organization linked
• Can have the same custom fields as deals
• Can only be converted to deals via the Pipedrive web app

Deals

• Create, update, and delete deals
• Attach activities, emails, notes, and files to deals
• Add custom fields (DealFields)
• Attach products and subscriptions
• Must be linked with either a person or organization
• Track through pipeline stages

Persons & Organizations (Contacts)

• Create, update, and delete persons and organizations
• Link to deals and leads
• Add custom fields
• Associate activities, emails, and notes

Activities

• Create, update, and delete activities
• Associate with leads, deals, persons, or organizations

Projects

• Create, update, and delete projects
• Associate with other entities (specific details not provided in sources)

Products

• Create, update, and delete products
• Attach to deals

Users

• Manage user information
• Group users into teams
• Set goals for users or teams
• Manage user permissions and roles
• Configure user settings and connections

Mail

• Sync emails with Pipedrive
• Link emails to people, deals, leads, or projects
• Automatically create new person records from emails
• Track email threads and replies
• Access email attachments

Webhooks

• Create and manage webhooks for real-time notifications
• Receive notifications for various events (e.g., new lead added)
• Create company-wide webhooks or app-specific webhooks

Custom Fields

• Add, update, and delete custom fields for various entities
• Retrieve field schemas for core entities

Additional Entities

• Manage pipelines and stages
• Work with files and attachments
• Handle notes
• Manage goals
• Configure permissions and roles

The Pipedrive API allows for comprehensive interaction with these data models, enabling developers to create, read, update, and delete records, as well as manage relationships between different entities. The API follows RESTful principles and uses JSON for data exchange.