pipedrive

library33.4.2jsnpmunverified

Official Node.js SDK for Pipedrive CRM REST API, supporting both API v1 and v2 endpoints. Current stable version is 33.4.2, with monthly releases. Includes full TypeScript definitions. Key differentiators: first-party library maintained by Pipedrive, supports OAuth2 and API token auth, generated from OpenAPI spec. Use for server-side integration with Pipedrive CRM for deals, persons, organizations, products, etc.

crm

npm install pipedrive

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · PIPEDRIVE

pipedrive

crmjavascriptv33.4.2

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Configuration

✓ import { Configuration } from 'pipedrive'

✗ const { Configuration } = require('pipedrive')

ESM-only package since v30. Use dynamic import for CommonJS.

DealsApi

✓ import { DealsApi } from 'pipedrive/v2'

✗ import { DealsApi } from 'pipedrive'

API v2 endpoints are under 'pipedrive/v2' subpath. Use 'pipedrive/v1' for v1.

OAuth2Configuration

✓ import { OAuth2Configuration } from 'pipedrive/v2'

✗ import { OAuth2Configuration } from 'pipedrive'

OAuth2 helpers are per-version. For v1 use 'pipedrive/v1'.

Show how to initialize the client with an API token and fetch a list of deals using API v2.

import { Configuration, DealsApi } from 'pipedrive/v2'; const config = new Configuration({ apiKey: process.env.PIPEDRIVE_API_KEY ?? '' }); async function main() { const api = new DealsApi(config); const { data } = await api.getDeals({ limit: 10 }); console.log(data); } main().catch(console.error);

Debug

Known issues

breakingPackage is ESM-only since v30. CommonJS require() will fail.

fix

Use dynamic import: const pipedrive = await import('pipedrive');

affects: >=30.0.0

breakingAPI v1 and v2 have separate namespaces. Mixing imports from wrong subpath may cause runtime errors.

fix

Use 'pipedrive/v1' for v1 endpoints, 'pipedrive/v2' for v2 endpoints.

affects: >=1.0.0

deprecatedAPI v1 is deprecated and will be removed in a future version in favor of v2.

fix

Migrate to API v2 endpoints under 'pipedrive/v2'.

affects: >=1.0.0

gotchaIf both apiKey and accessToken are set, apiKey takes precedence.

fix

Set only one authentication method to avoid unexpected authorization.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'pipedrive' or its corresponding type declarations.

Missing npm install or TypeScript not resolving types (package ships .d.ts).

fix

Run 'npm install pipedrive' and ensure tsconfig includes 'node_modules'.

TypeError: pipedrive.Configuration is not a constructor

CommonJS require() on ESM-only package.

fix

Use dynamic import: const { Configuration } = await import('pipedrive');

Configuration is not exported from 'pipedrive/v2'

Using wrong subpath or outdated package version (<30).

fix

Update to latest version and use correct import: 'pipedrive/v2'.

Upgrade

Version history

33.4.2latest on npm

Audit

Dependencies

axiosrequiredHTTP client used internally by all API classes

Agent activity

28 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/pipedrive/client-nodejs ↗

packagepipedrive ↗

homepagehttps://developers.pipedrive.com ↗