Skip to content

Pipedrive

The first CRM designed by salespeople, for salespeople. Do more to grow your business.

Categories: crm

Type: pipedrive/v1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameLabelTypeControl TypeDescriptionRequired
clientIdClient IdSTRINGTEXTtrue
clientSecretClient SecretSTRINGTEXTtrue

Actions

Get Deals

Name: getDeals

Returns all deals.

Properties

NameLabelTypeControl TypeDescriptionRequired
user_idUser IDINTEGERSELECTDeals matching the given user will be returned. However, filter_id and owned_by_you takes precedence over user_id when supplied.false
filter_idFilter IDINTEGERSELECTID of the filter to use.false
stage_idStage IDINTEGERSELECTDeals within the given stage will be returned.false
statusStatusSTRINGSELECTfalse
sortSortSTRINGTEXTThe field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys).false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{[{INTEGER(id), {INTEGER(id), STRING(name), STRING(email)}(user_id), {STRING(name)}(person_id), {STRING(name), STRING(owner_id)}(org_id), INTEGER(stage_id), STRING(title), INTEGER(value), STRING(currency), STRING(status)}](data)}OBJECT_BUILDER

Add Deal

Name: addDeal

Adds a new deal.

Properties

NameLabelTypeControl TypeDescriptionRequired
__itemDeal{STRING(title), STRING(value), STRING(currency), INTEGER(user_id), INTEGER(person_id), INTEGER(org_id), INTEGER(pipeline_id), INTEGER(stage_id), STRING(status), DATE(expected_close_date), NUMBER(probability), STRING(lost_reason)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id), {INTEGER(id), STRING(name), STRING(email)}(user_id), {STRING(name)}(person_id), {STRING(name), STRING(owner_id)}(org_id), INTEGER(stage_id), STRING(title), INTEGER(value), STRING(currency), STRING(status)}(data)}OBJECT_BUILDER

Search Deals

Name: searchDeals

Searches all deals by title, notes and/or custom fields.

Properties

NameLabelTypeControl TypeDescriptionRequired
termTermSTRINGTEXTThe search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.true
fieldsFieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.false
exact_matchExact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.false
person_idPerson IDINTEGERSELECTWill filter deals by the provided person.false
organization_idOrganization IDINTEGERSELECTWill filter deals by the provided organization.false
statusStatusSTRINGSELECTWill filter deals by the provided specific status.false
include_fieldsInclude FieldsSTRINGSELECTSupports including optional fields in the results which are not provided by default.false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{[{STRING(id), STRING(type), {INTEGER(id), STRING(name), STRING(email)}(user_id), {STRING(name)}(person_id), {STRING(name), STRING(owner_id)}(org_id), INTEGER(stage_id), STRING(title), INTEGER(value), STRING(currency), STRING(status)}](items)}(data)}OBJECT_BUILDER

Delete Deal

Name: deleteDeal

Marks a deal as deleted. After 30 days, the deal will be permanently deleted.

Properties

NameLabelTypeControl TypeDescriptionRequired
idDeal IDINTEGERSELECTId of the deal to delete.true

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id)}(data)}OBJECT_BUILDER

Get Details of Deal

Name: getDealDetails

Returns the details of a specific deal.

Properties

NameLabelTypeControl TypeDescriptionRequired
idDealINTEGERSELECTtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id), {INTEGER(id), STRING(name), STRING(email)}(user_id), {STRING(name)}(person_id), {STRING(name), STRING(owner_id)}(org_id), INTEGER(stage_id), STRING(title), INTEGER(value), STRING(currency), STRING(status)}(data)}OBJECT_BUILDER

Get Leads

Name: getLeads

Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest.

Properties

NameLabelTypeControl TypeDescriptionRequired
archived_statusArchived StatusSTRINGSELECTFiltering based on the archived status of a lead.false
owner_idOwner iDINTEGERSELECTLeads matching the given user will be returned. However, filter_id takes precedence over owner_id when supplied.false
person_idPerson IDINTEGERSELECTIf supplied, only leads matching the given person will be returned. However, filter_id takes precedence over person_id when supplied.false
organization_idOrganization IDINTEGERSELECTIf supplied, only leads matching the given organization will be returned. However, filter_id takes precedence over organization_id when supplied.false
filter_idFilter IDINTEGERSELECTFilter to usefalse
sortSortSTRINGSELECTThe field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys).false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{[{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)}](data)}OBJECT_BUILDER

Add Lead

Name: addLead

Creates a lead. A lead always has to be linked to a person or an organization or both.

Properties

NameLabelTypeControl TypeDescriptionRequired
__itemLead{STRING(title), INTEGER(owner_id), [STRING](label_ids), INTEGER(person_id), INTEGER(organization_id), {NUMBER(amount), STRING(currency)}(value), DATE(expected_close_date)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)}(data)}OBJECT_BUILDER

Delete Lead

Name: deleteLead

Deletes a specific lead.

Properties

NameLabelTypeControl TypeDescriptionRequired
idLead IDSTRINGSELECTThe ID of the leadtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{STRING(id)}(data)}OBJECT_BUILDER

Get Lead Details

Name: getLeadDetails

Returns details of a specific lead.

Properties

NameLabelTypeControl TypeDescriptionRequired
idLead IDSTRINGSELECTtrue

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)}(data)}OBJECT_BUILDER

Search Leads

Name: searchLeads

Searches all leads by title, notes and/or custom fields.

Properties

NameLabelTypeControl TypeDescriptionRequired
termTermSTRINGTEXTThe search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.true
fieldsFieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.false
exact_matchExact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.false
person_idPerson IDINTEGERSELECTWill filter leads by the provided person ID.false
organization_idOrganization IDINTEGERSELECTWill filter leads by the provided organization ID.false
include_fieldsInclude FieldsSTRINGSELECTSupports including optional fields in the results which are not provided by default.false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{[{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)}](items)}(data)}OBJECT_BUILDER

Get All Organizations

Name: getOrganizations

Returns all organizations.

Properties

NameLabelTypeControl TypeDescriptionRequired
user_idUser IDINTEGERSELECTOrganizations owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.false
filter_idFilter IDINTEGERSELECTFilter to usefalse
first_charFirst CharactersSTRINGTEXTOrganizations whose name starts with the specified letter will be returned (case insensitive)false
sortSortSTRINGTEXTThe field names and sorting mode separated by a comma (field_name_1ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys).false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{[{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)}](data)}OBJECT_BUILDER

Add Organization

Name: addOrganization

Adds a new organization.

Properties

NameLabelTypeControl TypeDescriptionRequired
__itemOrganization{STRING(name), INTEGER(owner_id)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)}(data)}OBJECT_BUILDER

Search Organizations

Name: searchOrganization

Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope.

Properties

NameLabelTypeControl TypeDescriptionRequired
termTermSTRINGTEXTThe search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.true
fieldsFieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.false
exact_matchExact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{[{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)}](items)}(data)}OBJECT_BUILDER

Delete Organization

Name: deleteOrganization

Marks an organization as deleted. After 30 days, the organization will be permanently deleted.

Properties

NameLabelTypeControl TypeDescriptionRequired
idOrganizationINTEGERSELECTOrganization to deletetrue

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id)}(data)}OBJECT_BUILDER

Get Details of Organization

Name: getOrganizationDetails

Returns the details of an organization.

Properties

NameLabelTypeControl TypeDescriptionRequired
idOrganizatonINTEGERSELECTOrganization to get details.true

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)}(data)}OBJECT_BUILDER

Get Persons

Name: getPersons

Returns all persons.

Properties

NameLabelTypeControl TypeDescriptionRequired
user_idUser IDINTEGERSELECTPersons owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.false
filter_idFilter IDINTEGERSELECTFilter to use.false
first_charFirst CharactersSTRINGTEXTPersons whose name starts with the specified letter will be returned (case insensitive)false
sortSortSTRINGTEXTThe field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys).false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{[{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), {STRING(name), INTEGER(owner_id), STRING(cc_email)}(org_id), STRING(name), [{STRING(value), BOOLEAN(primary), STRING(label)}](phone), [{STRING(value), BOOLEAN(primary), STRING(label)}](email)}](data)}OBJECT_BUILDER

Add Person

Name: addPerson

Adds a new person.

Properties

NameLabelTypeControl TypeDescriptionRequired
__itemPerson{STRING(name), INTEGER(owner_id), INTEGER(org_id), [{STRING(value), BOOLEAN(primary), STRING(label)}](email), [{STRING(value), BOOLEAN(primary), STRING(label)}](phone)}OBJECT_BUILDERnull

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), {STRING(name), INTEGER(owner_id), STRING(cc_email)}(org_id), STRING(name), [{STRING(value), BOOLEAN(primary), STRING(label)}](phone), [{STRING(value), BOOLEAN(primary), STRING(label)}](email)}(data)}OBJECT_BUILDER

Search Persons

Name: searchPersons

Searches all persons by name, email, phone, notes and/or custom fields.

Properties

NameLabelTypeControl TypeDescriptionRequired
termTermSTRINGTEXTThe search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.true
fieldsFieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.false
exact_matchExact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.false
organization_idOrganization IDINTEGERSELECTWill filter persons by the provided organization.false

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{[{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), {STRING(name), INTEGER(owner_id), STRING(cc_email)}(org_id), STRING(name), [{STRING(value), BOOLEAN(primary), STRING(label)}](phone), [{STRING(value), BOOLEAN(primary), STRING(label)}](email)}](items)}(data)}OBJECT_BUILDER

Delete Person

Name: deletePerson

Marks a person as deleted. After 30 days, the person will be permanently deleted.

Properties

NameLabelTypeControl TypeDescriptionRequired
idPersonINTEGERSELECTPerson to deletetrue

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id)}(data)}OBJECT_BUILDER

Get Details of Person

Name: getPersonDetails

Returns the details of a person. This also returns some additional fields which are not present when asking for all persons.

Properties

NameLabelTypeControl TypeDescriptionRequired
idPersonINTEGERSELECTPerson to get detailstrue

Output

Type: OBJECT

Properties

NameTypeControl Type
body{{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), {STRING(name), INTEGER(owner_id), STRING(cc_email)}(org_id), STRING(name), [{STRING(value), BOOLEAN(primary), STRING(label)}](phone), [{STRING(value), BOOLEAN(primary), STRING(label)}](email)}(data)}OBJECT_BUILDER

Triggers

New Activity

Trigger off whenever a new activity is added.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
type_nameSTRINGTEXT
public_descriptionSTRINGTEXT
subjectSTRINGTEXT
typeSTRINGTEXT
idINTEGERINTEGER
owner_nameSTRINGTEXT
user_idINTEGERINTEGER
company_idINTEGERINTEGER

New Deal

Trigger off whenever a new deal is added.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
email_messages_countINTEGERINTEGER
cc_emailSTRINGTEXT
idINTEGERINTEGER
person_idINTEGERINTEGER
owner_nameSTRINGTEXT
statusSTRINGTEXT
titleSTRINGTEXT
currencySTRINGTEXT
valueINTEGERINTEGER

New Organization

Trigger off whenever a new organization is added.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
email_messages_countINTEGERINTEGER
cc_emailSTRINGTEXT
owner_idINTEGERINTEGER
idINTEGERINTEGER
owner_nameSTRINGTEXT
nameSTRINGTEXT
company_idINTEGERINTEGER

New Person

Trigger off whenever a new person is added.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
email_messages_countINTEGERINTEGER
cc_emailSTRINGTEXT
owner_idINTEGERINTEGER
idINTEGERINTEGER
owner_nameSTRINGTEXT
phone[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
nameSTRINGTEXT
email[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
company_idINTEGERINTEGER

Updated Deal

Trigger off whenever an existing deal is updated.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
email_messages_countINTEGERINTEGER
cc_emailSTRINGTEXT
idINTEGERINTEGER
person_idINTEGERINTEGER
owner_nameSTRINGTEXT
statusSTRINGTEXT
titleSTRINGTEXT
currencySTRINGTEXT
valueINTEGERINTEGER

Updated Organization

Trigger off whenever an existing organization is updated.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
email_messages_countINTEGERINTEGER
cc_emailSTRINGTEXT
owner_idINTEGERINTEGER
idINTEGERINTEGER
owner_nameSTRINGTEXT
nameSTRINGTEXT
company_idINTEGERINTEGER

Updated Person

Trigger off whenever an existing person is updated.

Type: DYNAMIC_WEBHOOK

Properties

NameLabelTypeControl TypeDescriptionRequired
null

Output

Type: OBJECT

Properties

NameTypeControl Type
email_messages_countINTEGERINTEGER
cc_emailSTRINGTEXT
owner_idINTEGERINTEGER
idINTEGERINTEGER
owner_nameSTRINGTEXT
phone[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
nameSTRINGTEXT
email[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
company_idINTEGERINTEGER