Search all guides

Reference · Tools

Pipedrive integration

Full CRUD integration with the Pipedrive CRM platform. Manages activities, deals, deal products, files, leads, notes, organizations, persons, and products.

Action (binary) Sales v1 Binary data

The Pipedrive node covers the whole CRM: activities, deals and deal products, files, leads, notes, organizations, persons and products, with binary file support. A typical build is creating a person and a deal from an inbound lead and attaching the proposal document to it.

Works as
Action (binary)
Tool name
pipedrive
Operations
10 — Create , Delete , Get , Get Many , Update and 5 more
Parameters
70
Outputs
Output, Error
Credentials
Pipedrive API
Official docs
Pipedrive docs developers.pipedrive.com

What you can build with Pipedrive

  • Create a new deal in Pipedrive.
  • Upload a file and attach it to a deal.
  • Download a file from Pipedrive.
  • Search for a person by name.
  • Get all deals with a specific filter.
  • Add a product to a deal.
  • Create a lead and associate with an organization.

Overview

The Pipedrive tool provides full CRUD operations against the Pipedrive REST API v1. Supports ten resources: (1) Activity — create, delete, get, getAll, update. (2) Deal — create, delete, duplicate, get, getAll, search, update. (3) Deal Activity — getAll. (4) Deal Product — add, getAll, remove, update. (5) File — create (upload binary), delete, download (binary), get, update. (6) Lead — create, delete, get, getAll, update. (7) Note — create, delete, get, getAll, update. (8) Organization — create, delete, get, getAll, search, update. (9) Person — create, delete, get, getAll, search, update. (10) Product — getAll. File operations handle binary data: upload reads from the item’s binary property, download writes fetched content to the binary store. Supports custom property resolution/encoding and offset-based pagination.

Node Type

Action (Binary) — handles file/binary data operations

Input / Output

DirectionPort(s)
InputInput
OutputOutput, Error

Credentials

This tool requires Pipedrive API credentials. See the Credentials Guide for setup instructions.

Resources

ResourceValue
Activityactivity
Dealdeal
Deal ActivitydealActivity
Deal ProductdealProduct
Filefile
Leadlead
Notenote
Organizationorganization
Personperson
Productproduct

Operations

Which operations are available depends on the selected resource — see the parameter subsections below.

OperationValueDescription
CreatecreateCreate a new record — for the File resource this uploads a file
DeletedeleteDelete a record by its ID
GetgetRetrieve a single record by its ID — file metadata for the File resource
Get ManygetAllRetrieve many records, with optional filters and pagination
UpdateupdateUpdate an existing record
DuplicateduplicateDuplicate an existing deal
AddaddAdd a product to a deal
RemoveremoveRemove a product from a deal
DownloaddownloadDownload a file’s contents into a binary property

Parameters

Activity: Create

ParameterTypeRequiredDefaultDescription
SubjectstringYes—Subject line of the activity.
DoneoptionsNo0Whether the activity is done.
Options: 0 (Not Done), 1 (Done)
TypestringNocallActivity type key (e.g. call, meeting, task, email, lunch, deadline).
Additional FieldscollectionNo{}Optional fields to set on the new activity.
— Deal ID (deal_id)numberNo0Associated deal ID.
— Due DatestringNo—Due date in YYYY-MM-DD format.
— NotestringNo—HTML-formatted note content.
— Organization ID (org_id)numberNo0Associated organization ID.
— Person ID (person_id)numberNo0Associated person ID.
— User IDnumberNo0Assignee user ID.
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——

Activity: Delete

ParameterTypeRequiredDefaultDescription
Activity ID (activityId)numberYes0ID of the activity.

Activity: Get

ParameterTypeRequiredDefaultDescription
Activity ID (activityId)numberYes0ID of the activity.
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.

Activity: Get Many

ParameterTypeRequiredDefaultDescription
Additional FieldscollectionNo{}Optional filters applied to the query.
— DonebooleanNofalse—
— End DatestringNo——
— Filter ID (filterId)stringNo——
— Start DatestringNo——
— TypemultiOptionsNo[]—
Options: call, meeting, task, deadline, email, lunch
— User IDnumberNo0—
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

Activity: Update

ParameterTypeRequiredDefaultDescription
Activity ID (activityId)numberYes0ID of the activity.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— Deal ID (deal_id)numberNo0—
— DoneoptionsNo0—
Options: 0 (Not Done), 1 (Done)
— Due DatestringNo——
— NotestringNo——
— Organization ID (org_id)numberNo0—
— Person ID (person_id)numberNo0—
— SubjectstringNo——
— TypestringNo——
— User IDnumberNo0—
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——
Encode PropertiesbooleanNofalseEncode custom property names to hash keys before sending.

Deal: Create

ParameterTypeRequiredDefaultDescription
TitlestringYes—Title of the deal.
Associate WithoptionsNoorganizationEntity type to link the deal with.
Options: organization, person
Organization ID (org_id)numberYes0Organization ID to associate. (shown when Associate With is organization)
Person ID (person_id)numberYes0Person ID to associate. (shown when Associate With is person)
Additional FieldscollectionNo{}Optional fields to set on the new deal.
— CurrencystringNoUSD3-letter ISO currency code.
— LabelstringNo—Deal label ID.
— Lost ReasonstringNo——
— ProbabilitynumberNo0Deal success probability (0-100).
— Stage IDnumberNo0Numeric stage ID. To find: GET /api/v1/stages or use the Pipedrive admin URL.
— StatusoptionsNoopen—
Options: open, won, lost, deleted
— User IDnumberNo0—
— ValuenumberNo0—
— Visible TooptionsNo3—
Options: 1 (Owner Only), 3 (Entire Company)
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——

Deal: Delete

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID.

Deal: Duplicate

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID.

Deal: Get

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID.
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.

Deal: Get Many

ParameterTypeRequiredDefaultDescription
FilterscollectionNo{}Optional filters applied to the query.
— Filter ID (filter_id)stringNo—Predefined filter ID.
— Stage IDnumberNo0Numeric stage ID. To find: GET /api/v1/stages or use the Pipedrive admin URL.
— StatusoptionsNoall_not_deleted—
Options: all_not_deleted, deleted, lost, open, won
— User IDnumberNo0—
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)
ParameterTypeRequiredDefaultDescription
Search TermstringYes—Search term (min 2 chars or 1 with exact match).
Exact MatchbooleanNofalseWhen enabled, search term must match exactly.
Additional FieldscollectionNo{}Optional query parameters sent with the search.
— FieldsmultiOptionsNo[]—
Options: custom_fields, notes, title
— Include FieldsstringNo——
— Organization ID (organizationId)stringNo——
— Person ID (personId)stringNo——
— Raw DatabooleanNofalseReturn raw search results without unwrapping.
— StatusoptionsNo——
Options: open, won, lost
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

Deal: Update

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— CurrencystringNo——
— LabelstringNo—Deal label ID. Set to “null” to clear.
— Lost ReasonstringNo——
— Organization ID (org_id)numberNo0—
— Person ID (person_id)numberNo0—
— ProbabilitynumberNo0—
— Stage IDnumberNo0Numeric stage ID. To find: GET /api/v1/stages or use the Pipedrive admin URL.
— StatusoptionsNoopen—
Options: open, won, lost, deleted
— TitlestringNo——
— User IDnumberNo0—
— ValuenumberNo0—
— Visible TooptionsNo3—
Options: 1 (Owner Only), 3 (Entire Company)
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——
Encode PropertiesbooleanNofalseEncode custom property names to hash keys before sending.

Deal Activity: Get Many

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID this activity/product belongs to.
Additional FieldscollectionNo{}Optional filters applied to the query.
— DonebooleanNofalse—
— ExcludestringNo—Comma-separated activity IDs to exclude.
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

Deal Product: Add

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID this activity/product belongs to.
Product ID (productId)numberYes0Product ID to attach to deal.
Item PricenumberYes0Price per item.
QuantitynumberYes1Quantity of the product.
Additional FieldscollectionNo{}Optional fields to set on the attached product.
— CommentsstringNo——
— Discount PercentagenumberNo0—
— Product Variation IDstringNo——

Deal Product: Get Many

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID this activity/product belongs to.

Deal Product: Remove

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID this activity/product belongs to.
Product Attachment IDnumberYes0Product attachment ID in the deal.

Deal Product: Update

ParameterTypeRequiredDefaultDescription
Deal ID (dealId)numberYes0The Pipedrive deal ID this activity/product belongs to.
Product Attachment IDnumberYes0Product attachment ID in the deal.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— CommentsstringNo——
— Discount PercentagenumberNo0—
— Item PricenumberNo0—
— Product Variation IDstringNo——
— QuantitynumberNo1—

File: Create

ParameterTypeRequiredDefaultDescription
Binary PropertystringNodataName of the binary property to read from (upload) or write to (download).
Additional FieldscollectionNo{}Optional records to attach the uploaded file to.
— Activity ID (activity_id)numberNo0—
— Deal ID (deal_id)numberNo0—
— Organization ID (org_id)numberNo0—
— Person ID (person_id)numberNo0—
— Product ID (product_id)numberNo0—

File: Delete

ParameterTypeRequiredDefaultDescription
File IDnumberYes0ID of the file.

File: Download

ParameterTypeRequiredDefaultDescription
File IDnumberYes0ID of the file.
Binary PropertystringNodataName of the binary property to read from (upload) or write to (download).

File: Get

ParameterTypeRequiredDefaultDescription
File IDnumberYes0ID of the file.

File: Update

ParameterTypeRequiredDefaultDescription
File IDnumberYes0ID of the file.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— DescriptionstringNo——
— NamestringNo——

Lead: Create

ParameterTypeRequiredDefaultDescription
TitlestringYes—Title of the lead.
Associate WithoptionsNoorganization—
Options: organization, person
Organization ID (organization_id)numberYes0(shown when Associate With is organization)
Person ID (person_id)numberYes0(shown when Associate With is person)
Additional FieldscollectionNo{}Optional fields to set on the new lead.
— Expected Close DatestringNo—Expected close date (YYYY-MM-DD or datetime; will be truncated to date).
— Label IDsstringNo—Comma-separated list of lead label UUIDs.
— Owner IDnumberNo0—
— ValuefixedCollectionNo{}The lead’s monetary value.
— — AmountnumberNo0—
— — CurrencystringNoUSD—
— Visible TooptionsNo3—
Options: 1 (Owner Only), 3 (Entire Company), 5 (Entire Company + Followers), 7 (Everyone)

Lead: Delete

ParameterTypeRequiredDefaultDescription
Lead ID (leadId)stringYes—UUID of the lead.

Lead: Get

ParameterTypeRequiredDefaultDescription
Lead ID (leadId)stringYes—UUID of the lead.

Lead: Get Many

ParameterTypeRequiredDefaultDescription
FilterscollectionNo{}Optional filters applied to the query.
— Archived StatusoptionsNonot_archived—
Options: all, archived, not_archived
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

Lead: Update

ParameterTypeRequiredDefaultDescription
Lead ID (leadId)stringYes—UUID of the lead.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— Expected Close DatestringNo——
— Label IDsstringNo——
— Owner IDnumberNo0—
— Person ID (person_id)numberNo0—
— TitlestringNo——
— ValuefixedCollectionNo{}The lead’s monetary value.
— — AmountnumberNo0—
— — CurrencystringNoUSD—

Note: Create

ParameterTypeRequiredDefaultDescription
ContentstringYes—HTML content of the note.
Additional FieldscollectionNo{}Record associations — set them when creating a note, or filter by them when listing notes.
— Deal ID (deal_id)numberNo0—
— Lead ID (lead_id)stringNo——
— Organization ID (org_id)numberNo0—
— Person ID (person_id)numberNo0—

Note: Delete

ParameterTypeRequiredDefaultDescription
Note IDnumberYes0ID of the note.

Note: Get

ParameterTypeRequiredDefaultDescription
Note IDnumberYes0ID of the note.

Note: Get Many

ParameterTypeRequiredDefaultDescription
Additional FieldscollectionNo{}Record associations — set them when creating a note, or filter by them when listing notes.
— Deal ID (deal_id)numberNo0—
— Lead ID (lead_id)stringNo——
— Organization ID (org_id)numberNo0—
— Person ID (person_id)numberNo0—
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

Note: Update

ParameterTypeRequiredDefaultDescription
Note IDnumberYes0ID of the note.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— ContentstringNo——
— Deal ID (deal_id)numberNo0—
— Lead ID (lead_id)stringNo——
— Organization ID (org_id)numberNo0—
— Person ID (person_id)numberNo0—

Organization: Create

ParameterTypeRequiredDefaultDescription
NamestringYes—Name of the organization.
Additional FieldscollectionNo{}Optional fields to set on the new organization.
— LabelstringNo——
— Visible TooptionsNo3—
Options: 1 (Owner Only), 3 (Entire Company)
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——

Organization: Delete

ParameterTypeRequiredDefaultDescription
Organization ID (organizationId)numberYes0ID of the organization.

Organization: Get

ParameterTypeRequiredDefaultDescription
Organization ID (organizationId)numberYes0ID of the organization.
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.

Organization: Get Many

ParameterTypeRequiredDefaultDescription
FilterscollectionNo{}Optional filters applied to the query.
— Filter ID (filterId)stringNo——
— First CharacterstringNo—Filter by first character of the name.
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)
ParameterTypeRequiredDefaultDescription
Search TermstringYes—Search term (min 2 chars or 1 with exact match).
Additional FieldscollectionNo{}Optional query parameters sent with the search.
— Exact MatchbooleanNofalse—
— FieldsmultiOptionsNo[]—
Options: address, custom_fields, name, notes
— Raw DatabooleanNofalse—
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

Organization: Update

ParameterTypeRequiredDefaultDescription
Organization ID (organizationId)numberYes0ID of the organization.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— LabelstringNo—Set to “null” to clear label.
— NamestringNo——
— Owner IDnumberNo0—
— Visible TooptionsNo3—
Options: 1 (Owner Only), 3 (Entire Company)
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——
Encode PropertiesbooleanNofalseEncode custom property names to hash keys before sending.

Person: Create

ParameterTypeRequiredDefaultDescription
NamestringYes—Name of the person.
Additional FieldscollectionNo{}Optional fields to set on the new person.
— EmailstringNo——
— LabelstringNo——
— Marketing StatusoptionsNono_consent—
Options: no_consent, unsubscribed, subscribed, archived
— Organization ID (org_id)numberNo0—
— Owner IDnumberNo0—
— PhonestringNo——
— Visible TooptionsNo3—
Options: 1 (Owner Only), 3 (Entire Company)
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——

Person: Delete

ParameterTypeRequiredDefaultDescription
Person ID (personId)numberYes0ID of the person.

Person: Get

ParameterTypeRequiredDefaultDescription
Person ID (personId)numberYes0ID of the person.
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.

Person: Get Many

ParameterTypeRequiredDefaultDescription
Additional FieldscollectionNo{}Optional query parameters sent with the request.
— Filter ID (filterId)stringNo——
— First CharacterstringNo——
— SortstringNo—Sort order (e.g. “name ASC, id DESC”).
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)
ParameterTypeRequiredDefaultDescription
Search TermstringYes—Search term (min 2 chars or 1 with exact match).
Additional FieldscollectionNo{}Optional query parameters sent with the search.
— Exact MatchbooleanNofalse—
— FieldsstringNo—Search fields (comma-separated).
— Include FieldsstringNo——
— Organization ID (organizationId)stringNo——
— Raw DatabooleanNofalse—
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

Person: Update

ParameterTypeRequiredDefaultDescription
Person ID (personId)numberYes0ID of the person.
Update FieldscollectionNo{}Fields to change — only the fields you add are sent.
— EmailstringNo——
— LabelstringNo—Set to “null” to clear label.
— Marketing StatusoptionsNono_consent—
Options: no_consent, unsubscribed, subscribed, archived
— NamestringNo——
— Organization ID (org_id)numberNo0—
— Owner IDnumberNo0—
— PhonestringNo——
— Visible TooptionsNo3—
Options: 1 (Owner Only), 3 (Entire Company)
— Custom PropertiesfixedCollectionNo{}Custom field values, each given as a name and a value.
— — NamestringNo——
— — ValuestringNo——
Encode PropertiesbooleanNofalseEncode custom property names to hash keys before sending.

Product: Get Many

ParameterTypeRequiredDefaultDescription
Resolve PropertiesbooleanNofalseResolve custom property hash keys to human-readable names.
Return AllbooleanNofalseWhether to return all results or only up to a given limit.
LimitnumberNo50Maximum number of results to return. (shown when Return All is false)

All Operations

ParameterTypeRequiredDefaultDescription
Max ConcurrencynumberNo5Maximum number of items to process concurrently. Keep low to avoid Pipedrive rate limits.

Output Data

The Pipedrive response is merged onto the incoming item JSON — the node spreads the returned record over the fields already on the item, so upstream fields survive unless the record uses the same key. Binary data on the input item is forwarded to every output item, including error items.

How many items come out

  • Get Many and Search emit one output item per record returned, each one a copy of the input item merged with that record. A page of 50 deals from a single input item therefore produces 50 output items.
  • Every other operation emits exactly one output item per input item.
  • An empty response (no records matched) emits the input item unchanged — no fields are added, so check for a field you expect rather than assuming a match.
  • An empty input produces no output items at all.

Shapes the node builds itself

Most of the item is whatever the Pipedrive API returned for that record — the node does not rename or reshape it. Three things are determined here rather than by the API:

  • Delete and Remove. When the API answers with a bare true rather than a record, the node writes this onto the item instead:

    { "success": true }
  • Search. Results are unwrapped from the API’s search envelope, and unless Raw Data is on each output item carries the match score alongside the matched record’s own fields:

    { "result_score": 0.71 }

    With Raw Data on, the raw search entry is kept as returned, with the record still nested inside it.

  • File: Download. The item JSON passes through unchanged — nothing is merged. The downloaded content is written to the binary property named by Binary Property and merged with any binary already on the item, using the file’s own name and type from its Pipedrive metadata. Read the file downstream from that binary property, not from the item JSON.

Custom properties

With Resolve Properties on (Get and Get Many for Activity, Deal, Organization, Person and Product), custom-field hash keys in the result are replaced by the field’s human-readable name before the merge. Single-select fields resolve to the option label and multi-select fields to an array of labels, so a custom field named industry reads as {{ $json.industry }} rather than as a hash key. With Encode Properties on (Update for Activity, Deal, Organization and Person), the reverse happens on the way out — custom field names you supply are translated to hash keys before the request is sent.

Pagination

With Return All on, the node pages through the whole collection and emits every record. With it off, Limit caps the request. Deal Product: Get Many has neither control and returns whatever one request yields.

Reference the merged fields downstream by expression, e.g. {{ $json.result_score }} after a search or {{ $json.success }} after a delete.

Example Configuration

Create a deal and link it to an organization, setting value, stage and one custom field:

{
  "type": "pipedrive",
  "parameters": {
    "resource": "deal",
    "operation": "create",
    "title": "{{ $json.company }} — Enterprise License",
    "associateWith": "organization",
    "org_id": 789,
    "additionalFields": {
      "value": 50000,
      "currency": "USD",
      "stage_id": 2,
      "probability": 75,
      "visible_to": "3",
      "customProperties": {
        "property": [
          { "name": "deal_source", "value": "website" }
        ]
      }
    }
  }
}

Search for persons by name and cap the result set:

{
  "type": "pipedrive",
  "parameters": {
    "resource": "person",
    "operation": "search",
    "term": "{{ $json.contactName }}",
    "returnAll": false,
    "limit": 20,
    "additionalFields": {
      "exactMatch": false,
      "fields": "name,email",
      "organizationId": "789"
    }
  }
}

List open activities for a date range, with custom fields resolved to readable names:

{
  "type": "pipedrive",
  "parameters": {
    "resource": "activity",
    "operation": "getAll",
    "returnAll": false,
    "limit": 100,
    "resolveProperties": true,
    "additionalFields": {
      "done": false,
      "type": ["call", "meeting"],
      "start_date": "2026-01-01",
      "end_date": "2026-01-31",
      "user_id": 123
    }
  }
}

Upload the file held on the item’s data binary property and attach it to a deal and a person:

{
  "type": "pipedrive",
  "parameters": {
    "resource": "file",
    "operation": "create",
    "binaryPropertyName": "data",
    "additionalFields": {
      "deal_id": 123,
      "person_id": 456
    }
  }
}

Download a file into a named binary property so a later node can write or send it:

{
  "type": "pipedrive",
  "parameters": {
    "resource": "file",
    "operation": "download",
    "fileId": "{{ $json.fileId }}",
    "binaryPropertyName": "attachment"
  }
}

Error Handling

ModeBehavior
stopHalts workflow on first error
continueSkips failed items, passes successful ones through
errorPortRoutes failed items to Error output port

Tips

Pipedrive manages activities, deals, deal products, files, leads, notes, organizations and persons in a Pipedrive CRM account, and lists its products. It is the right tool when a workflow must create, update, fetch, list or delete those sales records, search deals, organizations or persons, duplicate a deal, add or remove products on a deal, or upload and download files, rather than another CRM; products are read-only. It returns the affected or matching records as JSON items, a downloaded file as binary data, and getAll paging through lists.

Common Patterns

Creating records with custom properties. When creating or updating records that support custom properties, use the customProperties fixedCollection:

{
  "customProperties": {
    "property": [
      { "name": "custom_field_name", "value": "custom_field_value" },
      { "name": "another_field", "value": "another_value" }
    ]
  }
}

Pagination control. For operations that return multiple records, control pagination with returnAll and limit. Leave Return All off and set Limit for a bounded page; turn Return All on to walk the whole collection.

Property resolution. When retrieving data, turn on Resolve Properties to get custom property names instead of hash keys. When updating data, turn on Encode Properties so the names you supply are translated back to hash keys.

Search operations. Search requires a term of at least 2 characters, or 1 character with exact match. Deal and Organization searches pick their search fields from a fixed list; Person search takes a comma-separated string of field names.

File operations. Uploads and downloads both work through the Binary Property parameter — upload reads the named property from the incoming item, download writes the fetched file to it.

Rate limits. Keep Max Concurrency low to stay inside Pipedrive’s API rate limits. When the API does throttle a request, the node waits and retries it.

Frequently asked questions

How do I set custom fields?

Through the `customProperties` fixedCollection, as a `property` array of `{ name, value }` objects — one entry per custom field you want to write.

Can it attach files to records?

Yes — the files resource supports binary data, so documents produced earlier in the workflow can be attached to the relevant deal or person.

What is the difference between a lead and a deal?

Pipedrive treats them as separate resources: leads are unqualified prospects, deals are active opportunities. The node manages both, so a workflow can convert between them deliberately.

How do I react to CRM changes?

Use the Pipedrive Trigger, which fires on create, change and delete events for the entity types you select.

Build with Pipedrive

Drop it into a workflow, wire it to an agent, or call it on a schedule. You'll need Pipedrive API credentials first.

Open BusyBot

Last reviewed . Spotted something wrong? Tell us.