Pipedrive is a CRM platform used by sales, customer success, and revenue operations teams to manage leads, deals, contacts, and sales activities.
The Pipedrive integration within the Wrk platform allows you to automate CRM workflows by calling the Pipedrive API through Wrk Actions.
This document provides an overview of how Pipedrive integrates into Wrk, how authentication works, general API behaviour, and a list of available Wrk Actions.
eneral API behaviour, and a list of available Wrk Actions.
Authentication
Pipedrive supports multiple authentication methods within Wrk, allowing flexibility depending on workspace policies and use cases.
Supported Authentication Methods
Method | Description |
OAuth 2.0 | Recommended method using Pipedrive’s OAuth flow |
API Token | Static token provided by Pipedrive |
OAuth 2.0
When connecting Pipedrive via OAuth:
Authentication is initiated directly inside Wrk.
Users are redirected to Pipedrive to authorize access.
Wrk receives an access token that is used for all subsequent API calls.
Tokens are scoped based on the permissions granted during authorization
API token
For API token authentication, Pipedrive requires the token to be sent on every request using the x-api-token header.
Important Notes
The API token is tied to a specific user and company and provides access to that user’s data.
Only one active API token can exist at a time; regenerating it will break existing integrations using the old token.
General API Behaviour
Base URL and response structure
Most Pipedrive API calls return JSON responses that commonly include:
successdataadditional_data(often used for pagination metadata)
Pagination
Most list-style endpoints use offset-based pagination with:
start(offset, default0)limit(page size, default100)
Pagination details are returned in additional_data.pagination, including:
more_items_in_collection(whether more results exist)next_start(the next offset to request)
Limit maximums
The documented maximum
limitvalue is 500 for offset pagination.Some endpoints may enforce lower maximums (for example, certain file-list endpoints cap
limitat 100 even if a higher value is supplied).
Why this matters
Workflows that need “all deals” (or similar) should always loop through pages using
next_startuntilmore_items_in_collectionisfalse.
Rate limiting
Pipedrive enforces burst limits using a rolling 2-second window, and limits are considered per token (not per company).
Burst limits vary by plan and auth type (API token vs OAuth). Pipedrive also notes that the Search API has its own burst limits.
Rate limit headers
Responses include headers such as:
x-ratelimit-limitx-ratelimit-remainingx-ratelimit-resetx-daily-requests-left(noted as applicable to certain request types/auth scenarios)
Throttling and blocking
When burst limits are exceeded, requests can return HTTP 429.
Continued high-volume traffic that ignores limiting responses (especially for API token integrations) can lead to HTTP 403 blocking behavior.
Custom fields
Pipedrive custom fields appear in API payloads using an account-specific field API key (often a long identifier). These keys are not universal and differ per Pipedrive account.
How to find a custom field’s API key
In Pipedrive: Settings → Data fields → (choose entity type), then use the field’s menu to Copy API key.
Referencing custom fields
When creating or updating an entity (for example, a deal), include the custom field API key as a property in the request payload.
Important Notes
The field API key cannot be renamed (the display name can).
Available Wrk Actions
Add a discount to a deal in Pipedrive
Add a follower to a deal in Pipedrive
Add a lead in Pipedrive
Add a new activity in Pipedrive
Add a new deal in Pipedrive
Add a new person in Pipedrive
Add a new user in Pipedrive
Add a participant to a deal in Pipedrive
Add a product to a deal in Pipedrive
Add a task in Pipedrive
Add an installment to a deal in Pipedrive
Add file in Pipedrive
Create deal in Pipedrive
Delete a deal in Pipedrive
Delete a lead in Pipedrive
Delete a person in Pipedrive
Delete a task in Pipedrive
Delete an activity in Pipedrive
Perform an API call in Pipedrive
Retrieve all activities from Pipedrive
Retrieve all activity fields from Pipedrive
Retrieve all activity types from Pipedrive
Retrieve all deals from Pipedrive
Retrieve all lead fields from Pipedrive
Retrieve all leads from Pipedrive
Retrieve all person fields from Pipedrive
Retrieve all persons from Pipedrive
Retrieve all pipelines from Pipedrive
Retrieve all products from Pipedrive
Retrieve all projects from Pipedrive
Retrieve all tasks from Pipedrive
Retrieve all users from Pipedrive
Retrieve deals from Pipedrive
Retrieve details of a deal from Pipedrive
Retrieve details of a person from Pipedrive
Retrieve details of a project from Pipedrive
Retrieve details of a task from Pipedrive
Retrieve details of an activity from Pipedrive
Retrieve files attached to a deal from Pipedrive
Retrieve leads from Pipedrive
Retrieve one lead from Pipedrive
Retrieve one user from Pipedrive
Retrieve persons from Pipedrive
Retrieve products from Pipedrive
Retrieve users by name from Pipedrive
Update Merge two deals in Pipedrive
Update a deal in Pipedrive
Update a lead in Pipedrive
Update a person in Pipedrive
Update a task in Pipedrive
Update an activity in Pipedrive
Update user details in Pipedrive
Additional Resources
Pipedrive API Overview: https://developers.pipedrive.com/docs/api/v1
Authentication Documentation (OAuth 2.0 and API Token): https://pipedrive.readme.io/docs/core-api-concepts-authentication
Pagination Guide: https://pipedrive.readme.io/docs/core-api-concepts-pagination
Custom Fields Documentation: https://pipedrive.readme.io/docs/core-api-concepts-custom-fields
