Pipedrive¶

Node: pipedrive · Full type: n8n-nodes-base.pipedrive · Version: 1

Credentials¶

pipedriveApi (alias: @pipedrive) / pipedriveOAuth2Api (alias: @pipedrive)

CREDENTIAL @pipedrive = pipedriveApi "My Pipedrive"

Operations¶

Resource: `activity`¶

`create`¶

Parameter	Type	Default	Details
`subject`	string	""	required
`done`	options	"0"	`0`, `1`
`type`	string	""	required
`additionalFields`	collection	{}	keys: `deal_id`, `due_date`, `note`, `org_id`, `person_id`, `user_id`, ...

`delete`¶

Parameter	Type	Default	Details
`activityId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`activityId`	number	0	required
`resolveProperties`	boolean	false

`getAll`¶

Parameter	Type	Default	Details
`resolveProperties`	boolean	false
`additionalFields`	collection	{}	keys: `done`, `end_date`, `filterId`, `start_date`, `type`, `user_id`

`update`¶

Parameter	Type	Default	Details
`activityId`	number	0	required
`updateFields`	collection	{}	keys: `busy_flag`, `deal_id`, `due_date`, `done`, `note`, `org_id`, ...
`encodeProperties`	boolean	false

Resource: `deal`¶

`create`¶

Parameter	Type	Default	Details
`title`	string	""	required
`associateWith`	options	"organization"	required; `organization`, `person`
`org_id`	number	0	required
`person_id`	number	0
`additionalFields`	collection	{}	keys: `currency`, `customProperties`, `label`, `lost_reason`, `org_id`, `person_id`, ...

`delete`¶

Parameter	Type	Default	Details
`dealId`	number	0	required

`duplicate`¶

Parameter	Type	Default	Details
`dealId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`dealId`	number	0	required
`resolveProperties`	boolean	false

`getAll`¶

Parameter	Type	Default	Details
`resolveProperties`	boolean	false
`filters`	collection	{}	keys: `filter_id`, `stage_id`, `status`, `user_id`

`search`¶

Parameter	Type	Default	Details
`term`	string	""	required
`exactMatch`	boolean	false
`additionalFields`	collection	{}	keys: `includeFields`, `organizationId`, `personId`, `fields`, `status`

`update`¶

Parameter	Type	Default	Details
`dealId`	number	0	required
`updateFields`	collection	{}	keys: `currency`, `customProperties`, `user_id`, `label`, `lost_reason`, `org_id`, ...
`encodeProperties`	boolean	false

Resource: `dealActivity`¶

`getAll`¶

Parameter	Type	Default	Details
`dealId`	options	""	required
`additionalFields`	collection	{}	keys: `done`, `exclude`

Resource: `dealProduct`¶

`add`¶

Parameter	Type	Default	Details
`dealId`	options	""	required
`productId`	options	""	required
`item_price`	number	0	required
`quantity`	number	1	required
`additionalFields`	collection	{}	keys: `comments`, `discount_percentage`, `product_variation_id`

`getAll`¶

Parameter	Type	Default	Details
`dealId`	options	""	required

`remove`¶

Parameter	Type	Default	Details
`dealId`	options	""	required
`productAttachmentId`	options	""	required

`update`¶

Parameter	Type	Default	Details
`dealId`	options	""	required
`productAttachmentId`	options	""	required
`updateFields`	collection	{}	keys: `comments`, `discount_percentage`, `item_price`, `quantity`, `product_variation_id`

Resource: `file`¶

`create`¶

Parameter	Type	Default	Details
`binaryPropertyName`	string	"data"	required
`additionalFields`	collection	{}	keys: `activity_id`, `deal_id`, `org_id`, `person_id`, `product_id`

`delete`¶

Parameter	Type	Default	Details
`fileId`	number	0	required

`download`¶

Parameter	Type	Default	Details
`fileId`	number	0	required
`binaryPropertyName`	string	"data"	required

`get`¶

Parameter	Type	Default	Details
`fileId`	number	0	required

`update`¶

Parameter	Type	Default	Details
`fileId`	number	0	required
`updateFields`	collection	{}	keys: `name`, `description`

Resource: `lead`¶

`create`¶

Parameter	Type	Default	Details
`title`	string	""	required
`associateWith`	options	"organization"	required; `organization`, `person`
`organization_id`	number	0	required
`person_id`	number	0	required
`additionalFields`	collection	{}	keys: `expected_close_date`, `label_ids`, `organization_id`, `owner_id`, `person_id`, `value`

`delete`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`get`¶

Parameter	Type	Default	Details
`leadId`	string	""	required

`getAll`¶

Parameter	Type	Default	Details
`filters`	collection	{}	keys: `archived_status`

`update`¶

Parameter	Type	Default	Details
`leadId`	string	""	required
`updateFields`	collection	{}	keys: `title`, `owner_id`, `label_ids`, `person_id`, `value`, `expected_close_date`

Resource: `note`¶

`create`¶

Parameter	Type	Default	Details
`content`	string	""	required
`additionalFields`	collection	{}	keys: `deal_id`, `lead_id`, `org_id`, `person_id`

`delete`¶

Parameter	Type	Default	Details
`noteId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`noteId`	number	0	required

`getAll`¶

Parameter	Type	Default	Details
`additionalFields`	collection	{}	keys: `deal_id`, `lead_id`, `org_id`, `person_id`

`update`¶

Parameter	Type	Default	Details
`noteId`	number	0	required
`updateFields`	collection	{}	keys: `content`, `deal_id`, `lead_id`, `org_id`, `person_id`

Resource: `organization`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `customProperties`, `label`, `visible_to`

`delete`¶

Parameter	Type	Default	Details
`organizationId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`organizationId`	number	0	required
`resolveProperties`	boolean	false

`getAll`¶

Parameter	Type	Default	Details
`resolveProperties`	boolean	false
`filters`	collection	{}	keys: `firstChar`, `filterId`

`search`¶

Parameter	Type	Default	Details
`term`	string	""	required
`additionalFields`	collection	{}	keys: `exactMatch`, `fields`, `rawData`

`update`¶

Parameter	Type	Default	Details
`organizationId`	number	""	required
`updateFields`	collection	{}	keys: `customProperties`, `label`, `name`, `owner_id`, `visible_to`
`encodeProperties`	boolean	false

Resource: `person`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `customProperties`, `email`, `label`, `marketing_status`, `org_id`, `phone`, ...

`delete`¶

Parameter	Type	Default	Details
`personId`	number	0	required

`get`¶

Parameter	Type	Default	Details
`personId`	number	0	required
`resolveProperties`	boolean	false

`getAll`¶

Parameter	Type	Default	Details
`resolveProperties`	boolean	false
`additionalFields`	collection	{}	keys: `filterId`, `firstChar`, `sort`

`search`¶

Parameter	Type	Default	Details
`term`	string	""	required
`additionalFields`	collection	{}	keys: `exactMatch`, `fields`, `includeFields`, `organizationId`, `rawData`

`update`¶

Parameter	Type	Default	Details
`personId`	number	0	required
`updateFields`	collection	{}	keys: `customProperties`, `email`, `label`, `marketing_status`, `name`, `org_id`, ...
`encodeProperties`	boolean	false

Resource: `product`¶

`getAll`¶

Parameter	Type	Default	Details
`resolveProperties`	boolean	false

Common Parameters¶

Parameter	Type	Default	Details
`authentication`	options	"apiToken"	`apiToken`, `oAuth2`

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`deal_id`	number	0
`due_date`	dateTime	""
`note`	string	""
`org_id`	options	""
`person_id`	number	0
`user_id`	options	""
`customProperties`	fixedCollection	{}	groups: `property`

updateFields children:

Parameter	Type	Default	Details
`busy_flag`	boolean	false
`deal_id`	number	0
`due_date`	dateTime	""
`done`	options	"0"	`0`, `1`
`note`	string	""
`org_id`	options	""
`person_id`	number	0
`public_description`	string	""
`subject`	string	""
`type`	string	""
`user_id`	options	""
`customProperties`	fixedCollection	{}	groups: `property`

filters children:

Parameter	Type	Default	Details
`filter_id`	options	""
`stage_id`	options	""
`status`	options	"all_not_deleted"	`all_not_deleted`, `deleted`, `lost`, `open`, `won`
`user_id`	options	""

Example¶

NODE "pipedrive" @pipedrive AS "Pipedrive" {
  resource: "activity",
  operation: "get",
  subject: {{ $json.subject }},
  type: {{ $json.type }},
  activityId: 0
}

Pipedrive¶

Credentials¶

Operations¶

Resource: activity¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: deal¶

create¶

delete¶

duplicate¶

get¶

getAll¶

search¶

update¶

Resource: dealActivity¶

getAll¶

Resource: dealProduct¶

add¶

getAll¶

remove¶

update¶

Resource: file¶

create¶

delete¶

download¶

get¶

update¶

Resource: lead¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: note¶

create¶

delete¶

get¶

getAll¶

update¶

Resource: organization¶

create¶

delete¶

get¶

getAll¶

search¶

update¶

Resource: person¶

create¶

delete¶

get¶

getAll¶

search¶

update¶

Resource: product¶

getAll¶

Common Parameters¶

Parameter Details¶

Example¶

Resource: `activity`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `deal`¶

`create`¶

`delete`¶

`duplicate`¶

`get`¶

`getAll`¶

`search`¶

`update`¶

Resource: `dealActivity`¶

`getAll`¶

Resource: `dealProduct`¶

`add`¶

`getAll`¶

`remove`¶

`update`¶

Resource: `file`¶

`create`¶

`delete`¶

`download`¶

`get`¶

`update`¶

Resource: `lead`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `note`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶

Resource: `organization`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`search`¶

`update`¶

Resource: `person`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`search`¶

`update`¶

Resource: `product`¶

`getAll`¶