Skip to main content

Pipedrive

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable PyAirbyte
Support Level
Marketplace
Connector Version
2.4.6 (last updated 6 hours ago)
Sync Success Rate
Medium
Usage Rate
High
Data workers used
0.2 per sync (Learn more)
Definition ID
d8286229-c680-4063-8c59-23b9b391c700

This page contains the setup guide and reference information for the Pipedrive source connector.

Prerequisites​

  • A Pipedrive account with API access enabled for your user
  • Your Pipedrive API Token
  • A Start Date (in UTC) from which to begin replicating data

Setup guide​

Step 1: Set up Pipedrive​

The connector authenticates with a personal API token. Each token is tied to a Pipedrive user, so the connector can only read data that user is allowed to see.

  1. In the Pipedrive web app, click your account name (top right), then Company settings > Personal preferences > API.
  2. Copy the API token shown on that page. See How to find the API token for screenshots.

Pipedrive allows one active API token per user. If you regenerate it, update the connector configuration. If you belong to more than one company, each company has its own token.

If the API tab isn't visible, your company admin hasn't enabled API access for your permission set. Ask them to follow Enabling API for company users.

Step 2: Set up the Pipedrive connector in Airbyte​

  1. In the Airbyte UI, go to Sources and click + New source.
  2. Select Pipedrive from the list.
  3. Enter a name for the source.
  4. Fill in the fields below, then click Set up source.

API Token: The personal API token you copied in Step 1. Airbyte sends it as the api_token query parameter on every request.

Start Date: A UTC date and time in the format YYYY-MM-DDTHH:MM:SSZ, for example 2017-01-25T00:00:00Z. Streams that support incremental sync only replicate records modified on or after this date. Streams that don't support incremental sync ignore it and always return all records, except deal_products, which only expands the deals returned by the deals stream. A space instead of T, as in the example shown in the UI, also works. See Incremental sync and Start Date.

When you click Set up source, Airbyte tests the connection by calling the Currencies endpoint. Every API token can read it, so the test passes even on an account that has no deals yet.

Supported sync modes​

The Pipedrive source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental SyncYes
Replicate Incremental DeletesNo
SSL connectionYes
NamespacesNo

Supported Streams​

The connector uses the Pipedrive API v1. Ten streams support incremental sync; the rest are full refresh only. Stream names below match the names shown in Airbyte.

StreamSync modesNotes
activitiesFull Refresh, IncrementalRead from Recents with items=activity. Cursor: update_time.
activity_fieldsFull RefreshActivityFields
activity_typesFull RefreshActivityTypes
currenciesFull RefreshCurrencies
deal_fieldsFull RefreshDealFields
deal_productsFull RefreshProducts attached to each deal, fetched with one request per deal (DealProducts). The connector still calls the v1 path GET /v1/deals/{id}/products, which Pipedrive stopped supporting on 2026-08-01, and only expands deals returned by the deals stream.
dealsFull Refresh, IncrementalRead from Recents with items=deal. Cursor: update_time.
filesFull Refresh, IncrementalRead from Recents with items=file. Cursor: update_time.
filtersFull Refresh, IncrementalRead from Recents with items=filter. Cursor: update_time.
goalsFull RefreshGoals
lead_labelsFull RefreshLeadLabels
leadsFull RefreshLeads
mailFull RefreshMessages in each mail thread, fetched with one request per thread (Mailbox getMailThreadMessages). See Mail streams.
mailThreadsFull RefreshMail threads from the inbox, drafts, sent, and archive folders (Mailbox getMailThreads). See Mail streams.
notesFull Refresh, IncrementalRead from Recents with items=note. Cursor: update_time.
organization_fieldsFull RefreshOrganizationFields
organizationsFull RefreshOrganizations. The connector still calls the v1 path GET /v1/organizations, which Pipedrive stopped supporting on 2026-08-01.
permission_setsFull RefreshPermissionSets
person_fieldsFull RefreshPersonFields
personsFull Refresh, IncrementalRead from Recents with items=person. Cursor: update_time.
pipelinesFull Refresh, IncrementalRead from Recents with items=pipeline. Cursor: update_time.
product_fieldsFull RefreshProductFields
productsFull Refresh, IncrementalRead from Recents with items=product. Cursor: update_time.
rolesFull RefreshRoles
stagesFull Refresh, IncrementalRead from Recents with items=stage. Cursor: update_time.
usersFull Refresh, IncrementalRead from Recents with items=user. Cursor: modified.

Incremental sync and Start Date​

The ten incremental streams read from the Pipedrive Recents endpoint, which returns items changed since a given timestamp. On the first sync, Airbyte passes your Start Date as since_timestamp. On later incremental syncs, it passes the latest cursor value it saw (update_time, or modified for users). Records modified before the Start Date are never replicated by these streams, and the Start Date has no effect on the full refresh streams.

Because these streams use the Recents endpoint, they return records that changed in the window, not only records that were created in it. For example, a deal created years before your Start Date shows up in deals as soon as anyone edits it.

Pipedrive's Recents endpoint returns at most one month of history, regardless of the Start Date. Records last modified more than a month before a sync are never backfilled by these streams, and moving the Start Date earlier does not retrieve them. The connector is being moved to Pipedrive API v2 to remove this limitation.

Custom fields​

Pipedrive lets you add custom fields to deals, persons, organizations, products, and activities. The API returns each custom field as a 40-character hash key (for example dcf558aac1ae4e8c4f849ba5e668430d8df9be12) rather than a readable name. The deals, persons, organizations, products, and activities streams pass these keys through as additional top-level properties on each record. To map a hash key to its label and type, sync the matching *_fields stream (deal_fields, person_fields, organization_fields, product_fields, or activity_fields) and join on the key column.

Mail streams​

mailThreads lists threads from the mailbox of the user who owns the API token. It queries each of the inbox, drafts, sent, and archive folders separately, so a thread that appears in more than one folder may be returned more than once. mail then requests the messages of every thread returned by mailThreads, one request per thread. Both streams are full refresh only, and you only see mail for the user whose token you configured, not for the whole company. If that user has not connected a mailbox to Pipedrive (Mail sync), both streams return no records.

Performance considerations​

Pipedrive enforces per-company, token-based rate limits that depend on your plan and the number of seats. When Pipedrive answers with HTTP 429, the connector waits for the window reported in the x-ratelimit-reset header, falls back to exponential backoff when the header is missing, and retries up to ten times before failing the sync. If the header asks for a wait of 300 seconds or more, the connector stops the sync with a retryable error instead of waiting. Two limits apply per API token: a rolling 2-second burst window (20 to 120 requests depending on your plan) that recovers after a short wait, and a daily token budget (30,000 tokens times the plan multiplier and the number of seats) that, once exhausted, rejects every request until midnight in Pipedrive's server timezone. Waiting does not help in the second case; the failure message says so. If your account is close to its limits, run fewer streams per connection or schedule syncs less often.

Two streams make one request per parent record and can be slow on large accounts:

  • deal_products makes one request per deal.
  • mail makes one request per mail thread.

Consider leaving these streams disabled unless you need them.

Limitations & Troubleshooting​

Expand to see details about Pipedrive connector limitations and troubleshooting.

Connector limitations​

How the connector treats Pipedrive HTTP errors:

HTTP statusBehavior
401, 402, 403The sync fails with a configuration error that includes Pipedrive's error text. For deal_products and mail, a 403 on a single parent record is skipped and the sync continues. If the token can't read any deal products or mail messages at all, those two streams finish empty rather than failing.
404, 410For deal_products and mail, a parent deal or mail thread deleted after the parent stream was read is skipped. On other streams these fail the sync.
429Rate limited; retried as described under Performance considerations.
500, 502, 503, 504Temporary Pipedrive errors; retried with backoff.
  • The connector doesn't replicate deletes. A record deleted in Pipedrive stays in your destination until you clear and resync the stream.
  • Only the ten streams marked Incremental above track state. The other sixteen streams are re-read in full on every sync.
  • Full refresh streams ignore the Start Date, except deal_products, which only expands the deals returned by the deals stream.
  • The incremental streams read Pipedrive's Recents endpoint, which returns at most one month of history. Records last modified more than a month before a sync are not backfilled, whatever the Start Date.
  • organizations and deal_products call v1 endpoints that Pipedrive stopped supporting on 2026-08-01. They may stop working until the connector moves to API v2.
  • The connector authenticates with a personal API token only. It doesn't support OAuth.
  • The connector uses Pipedrive API v1. Newer fields that only exist in API v2 aren't available.

Troubleshooting​

  • Missing streams or empty streams: Records are limited to what the token's user can see in Pipedrive. Use a token from a user with broader visibility, or from an admin. mail and mailThreads are empty unless that user has a mailbox connected in Pipedrive.
  • Records missing from incremental streams: The Recents endpoint only returns records modified within the last month, so older records are not backfilled even with an earlier Start Date. Records that haven't been modified since the Start Date are excluded as well.
  • Custom fields appear as hash keys: This is expected. See Custom fields.
  • Syncs fail with HTTP 429: The retries were exhausted, which usually means the daily token budget is spent. Reduce the number of enabled streams, increase the interval between syncs, or upgrade the plan.
  • Setup or syncs fail with HTTP 401, 402 or 403: The message carries Pipedrive's own error text. 401 means the token was not copied in full, has been regenerated, or API access is disabled for the user (see Step 1). 402 means the company account is not active. 403 means the token owner lacks permission for that data, or Cloudflare blocked the token after repeated rate-limit violations.

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
string
api_token
string
replication_start_date

Changelog​

VersionDatePull RequestSubject
2.4.62026-09-0985770Classify Pipedrive HTTP errors, wait on x-ratelimit-reset for 429s and skip inaccessible parent records in deal_products and mail
2.4.52026-09-0985767Restructure the documentation and add contributor guides
2.4.42026-09-0985763Set the heartbeat timeout, add a CODEOWNERS entry and tidy the changelog
2.4.32026-09-0985764Use the currencies stream for the connection check and add suggested streams
2.4.22026-09-0985766Make pagination null-safe for responses without additional_data, fixing the mail stream
2.4.12026-09-0985762Fix components.py import failure on Python 3.11+ (use default_factory for decoder) and move to SDM 7.28.3
2.4.02025-02-2854716Refactor: Optimize Parameters, remove redundant code and Improve Manifest Readability
2.3.82025-02-2247292Migrate to manifest only format
2.3.72025-02-0853488Update dependencies
2.3.62025-02-0152986Update dependencies
2.3.52025-01-2552477Update dependencies
2.3.42025-01-1851922Update dependencies
2.3.32025-01-1151305Update dependencies
2.3.22025-01-0450929Update dependencies
2.3.12024-12-2850288Update dependencies
2.3.02024-12-1748615Update airbyte-cdk to use concurrency
2.2.282024-12-1449692Update dependencies
2.2.272024-12-1249041Make the Docker image rootless (requires Airbyte platform 0.64 or later)
2.2.262024-11-0448293Update dependencies
2.2.252024-10-2947743Update dependencies
2.2.242024-10-2847103Update dependencies
2.2.232024-10-1246822Update dependencies
2.2.222024-10-0546487Update dependencies
2.2.212024-09-2846132Update dependencies
2.2.202024-09-2145748Update dependencies
2.2.192024-09-1445556Update dependencies
2.2.182024-09-0745303Update dependencies
2.2.172024-08-3144981Update dependencies
2.2.162024-08-2444644Update dependencies
2.2.152024-08-1744316Update dependencies
2.2.142024-08-1243888Update dependencies
2.2.132024-08-1043679Update dependencies
2.2.122024-08-0343056Update dependencies
2.2.112024-07-2742287Update dependencies
2.2.102024-07-1341729Update dependencies
2.2.92024-07-1041465Update dependencies
2.2.82024-07-0941082Update dependencies
2.2.72024-07-0640778Update dependencies
2.2.62024-06-2540501Update dependencies
2.2.52024-06-2240171Update dependencies
2.2.42024-06-0439095[autopull] Upgrade base image to v1.2.1
2.2.32024-05-2038405[autopull] base image + poetry + up_to_date
2.2.22024-01-1134153prepare for airbyte-lib
2.2.12023-11-0631147Bugfix: handle records with a null data field
2.2.02023-10-2531707Add new stream mail
2.1.02023-10-1031184Add new stream goals
2.0.12023-10-1331151Add additionalProperties in schemas to read custom fields
2.0.02023-08-0929293Migrated to Low-Code CDK
1.0.02023-06-2927832Remove followers_count field from Products stream
0.1.192023-07-0527967Update OrganizationFields and ProductFields with display_field field
0.1.182023-06-0226892Update DialFields schema with pipeline_ids property
0.1.172023-03-2124282Bugfix handle missed cursor_field
0.1.162023-03-0823789Add 11 new streams
0.1.152023-03-0223705Disable OAuth
0.1.142023-03-0123539Fix schema for "activities", "check" works if empty "deals"
0.1.132022-09-1616799Migrate to per-stream state
0.1.122022-05-2313082Remove date-time format from schemas
0.1.112022-05-1612867Add unit tests
0.1.102022-04-2611870Add 3 streams: DealFields, OrganizationFields and PersonFields
0.1.92021-12-078582Update connector fields title/description
0.1.82021-11-167875Extend schema for "persons" stream
0.1.72021-11-157968Update oAuth flow config
0.1.62021-10-056821Add OAuth support
0.1.52021-09-276441Fix normalization error
0.1.42021-08-265943Add organizations stream
0.1.32021-08-265642Remove date-time from deals stream
0.1.22021-07-234912Update money type to support floating point
0.1.12021-07-194686Update spec.json
0.1.02021-07-194686🎉 New source: Pipedrive connector
Was this page helpful?