Skip to content

Pipedrive

Reference


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

Categories: [crm]

Version: 1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameTypeControl TypeDescription
Client IdSTRINGTEXT
Client SecretSTRINGTEXT

Triggers

New Activity

Trigger off whenever a new activity is added.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
STRINGTEXT
STRINGTEXT
STRINGTEXT
STRINGTEXT
INTEGERINTEGER
STRINGTEXT
INTEGERINTEGER
INTEGERINTEGER

New Deal

Trigger off whenever a new deal is added.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
INTEGERINTEGER
STRINGTEXT
INTEGERINTEGER
INTEGERINTEGER
STRINGTEXT
STRINGTEXT
STRINGTEXT
STRINGTEXT
INTEGERINTEGER

New Organization

Trigger off whenever a new organization is added.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
INTEGERINTEGER
STRINGTEXT
INTEGERINTEGER
INTEGERINTEGER
STRINGTEXT
STRINGTEXT
INTEGERINTEGER

New Person

Trigger off whenever a new person is added.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
INTEGERINTEGER
STRINGTEXT
INTEGERINTEGER
INTEGERINTEGER
STRINGTEXT
[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
STRINGTEXT
[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
INTEGERINTEGER

Updated Deal

Trigger off whenever an existing deal is updated.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
INTEGERINTEGER
STRINGTEXT
INTEGERINTEGER
INTEGERINTEGER
STRINGTEXT
STRINGTEXT
STRINGTEXT
STRINGTEXT
INTEGERINTEGER

Updated Organization

Trigger off whenever an existing organization is updated.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
INTEGERINTEGER
STRINGTEXT
INTEGERINTEGER
INTEGERINTEGER
STRINGTEXT
STRINGTEXT
INTEGERINTEGER

Updated Person

Trigger off whenever an existing person is updated.

Type: DYNAMIC_WEBHOOK

Properties

NameTypeControl TypeDescription
null

Output

Type: OBJECT

Properties

TypeControl Type
INTEGERINTEGER
STRINGTEXT
INTEGERINTEGER
INTEGERINTEGER
STRINGTEXT
[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
STRINGTEXT
[{STRING(value), BOOLEAN(primary)}]ARRAY_BUILDER
INTEGERINTEGER

Actions

Get Deals

Returns all deals.

Properties

NameTypeControl TypeDescription
UserINTEGERSELECTDeals matching the given user will be returned. However, filter_id and owned_by_you takes precedence over user_id when supplied.
FilterINTEGERSELECTFilter to use.
StageINTEGERSELECTDeals within the given stage will be returned.
StatusSTRINGSELECT
SortSTRINGTEXTThe field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys).

Output

Type: OBJECT

Properties

TypeControl Type
{[{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

Adds a new deal.

Properties

NameTypeControl TypeDescription
Deal{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_BUILDER

Output

Type: OBJECT

Properties

TypeControl Type
{{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

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

Properties

NameTypeControl TypeDescription
TermSTRINGTEXTThe 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.
FieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.
Exact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.
PersonINTEGERSELECTWill filter deals by the provided person.
OrganizationINTEGERSELECTWill filter deals by the provided organization.
StatusSTRINGSELECTWill filter deals by the provided specific status.
Include FieldsSTRINGSELECTSupports including optional fields in the results which are not provided by default.

Output

Type: OBJECT

Properties

TypeControl Type
{{[{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

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

Properties

NameTypeControl TypeDescription
DealINTEGERSELECTDeal to delete

Output

Type: OBJECT

Properties

TypeControl Type
{{INTEGER(id)}(data)}OBJECT_BUILDER

Get Details of Deal

Returns the details of a specific deal.

Properties

NameTypeControl TypeDescription
DealINTEGERSELECT

Output

Type: OBJECT

Properties

TypeControl Type
{{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

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

Properties

NameTypeControl TypeDescription
Archived StatusSTRINGSELECTFiltering based on the archived status of a lead.
OwnerINTEGERSELECTLeads matching the given user will be returned. However, filter_id takes precedence over owner_id when supplied.
PersonINTEGERSELECTIf supplied, only leads matching the given person will be returned. However, filter_id takes precedence over person_id when supplied.
OrganizationINTEGERSELECTIf supplied, only leads matching the given organization will be returned. However, filter_id takes precedence over organization_id when supplied.
FilterINTEGERSELECTFilter to use
SortSTRINGSELECTThe field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys).

Output

Type: OBJECT

Properties

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

Add Lead

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

Properties

NameTypeControl TypeDescription
Lead{STRING(title), INTEGER(owner_id), [STRING](label_ids), INTEGER(person_id), INTEGER(organization_id), {NUMBER(amount), STRING(currency)}(value), DATE(expected_close_date)}OBJECT_BUILDER

Output

Type: OBJECT

Properties

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

Delete Lead

Deletes a specific lead.

Properties

NameTypeControl TypeDescription
LeadSTRINGSELECTThe ID of the lead

Output

Type: OBJECT

Properties

TypeControl Type
{{STRING(id)}(data)}OBJECT_BUILDER

Get Lead Details

Returns details of a specific lead.

Properties

NameTypeControl TypeDescription
LeadSTRINGSELECT

Output

Type: OBJECT

Properties

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

Search Leads

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

Properties

NameTypeControl TypeDescription
TermSTRINGTEXTThe 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.
FieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.
Exact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.
PersonINTEGERSELECTWill filter leads by the provided person ID.
OrganizationINTEGERSELECTWill filter leads by the provided organization ID.
Include FieldsSTRINGSELECTSupports including optional fields in the results which are not provided by default.

Output

Type: OBJECT

Properties

TypeControl Type
{{[{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

Returns all organizations.

Properties

NameTypeControl TypeDescription
OwnerINTEGERSELECTOrganizations owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.
FilterINTEGERSELECTFilter to use
First CharactersSTRINGTEXTOrganizations whose name starts with the specified letter will be returned (case insensitive)
SortSTRINGTEXTThe 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).

Output

Type: OBJECT

Properties

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

Add Organization

Adds a new organization.

Properties

NameTypeControl TypeDescription
Organization{STRING(name), INTEGER(owner_id)}OBJECT_BUILDER

Output

Type: OBJECT

Properties

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

Search Organizations

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

NameTypeControl TypeDescription
TermSTRINGTEXTThe 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.
FieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.
Exact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.

Output

Type: OBJECT

Properties

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

Delete Organization

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

Properties

NameTypeControl TypeDescription
OrganizationINTEGERSELECTOrganization to delete

Output

Type: OBJECT

Properties

TypeControl Type
{{INTEGER(id)}(data)}OBJECT_BUILDER

Get Details of Organization

Returns the details of an organization.

Properties

NameTypeControl TypeDescription
OrganizatonINTEGERSELECTOrganization to get details.

Output

Type: OBJECT

Properties

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

Get Persons

Returns all persons.

Properties

NameTypeControl TypeDescription
OwnerINTEGERSELECTPersons owned by the given user will be returned. However, filter_id takes precedence over user_id when both are supplied.
FilterINTEGERSELECTFilter to use.
First CharactersSTRINGTEXTPersons whose name starts with the specified letter will be returned (case insensitive)
SortSTRINGTEXTThe field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys).

Output

Type: OBJECT

Properties

TypeControl Type
{[{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

Adds a new person.

Properties

NameTypeControl TypeDescription
Person{STRING(name), INTEGER(owner_id), INTEGER(org_id), [{STRING(value), BOOLEAN(primary), STRING(label)}](email), [{STRING(value), BOOLEAN(primary), STRING(label)}](phone)}OBJECT_BUILDER

Output

Type: OBJECT

Properties

TypeControl Type
{{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

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

Properties

NameTypeControl TypeDescription
TermSTRINGTEXTThe 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.
FieldsSTRINGSELECTA comma-separated string array. The fields to perform the search from. Defaults to all of them.
Exact MatchBOOLEANSELECTWhen enabled, only full exact matches against the given term are returned. It is not case sensitive.
OrganizationINTEGERSELECTWill filter persons by the provided organization.

Output

Type: OBJECT

Properties

TypeControl Type
{{[{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

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

Properties

NameTypeControl TypeDescription
PersonINTEGERSELECTPerson to delete

Output

Type: OBJECT

Properties

TypeControl Type
{{INTEGER(id)}(data)}OBJECT_BUILDER

Get Details of Person

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

Properties

NameTypeControl TypeDescription
PersonINTEGERSELECTPerson to get details

Output

Type: OBJECT

Properties

TypeControl Type
{{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