Pipedrive
The first CRM designed by salespeople, for salespeople. Do more to grow your business.
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
Name | Label | Type | Description | Required |
---|---|---|---|---|
clientId | Client Id | STRING | true | |
clientSecret | Client Secret | STRING | true |
Actions
Get Deals
Name: getDeals
Returns all deals.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
user_id | User ID | INTEGER | Deals matching the given user will be returned. However, filter_idand owned_by_youtakes precedence over user_id when supplied. | false |
filter_id | Filter ID | INTEGER | ID of the filter to use. | false |
stage_id | Stage ID | INTEGER | Deals within the given stage will be returned. | false |
status | Status | STRING Optionsopen, won, lost, deleted, all_not_deleted | false | |
sort | Sort | STRING | The field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys). | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | ARRAY Items[{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)}] |
Output Example
Add Deal
Name: addDeal
Adds a new deal.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
title | Title | STRING | The title of the deal | true |
value | Value | STRING | The value of the deal. | false |
currency | Currency | STRING | The currency of the deal. If omitted, currency will be set to the default currency of the authorized user. | false |
user_id | User ID | INTEGER | ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used. | false |
person_id | Person ID | INTEGER | ID of the person which this deal will be linked to. This property is required unless org_id is specified. | false |
org_id | Organization ID | INTEGER | ID of the organization which this deal will be linked to. This property is required unless person_id is specified. | false |
pipeline_id | Pipeline ID | INTEGER | Id of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that pipeline_idand stage_idshould not be used together as pipeline_id will be ignored. | false |
stage_id | Stage ID | INTEGER | Stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the stage_id. If omitted, the deal will be placed in the first stage of the default pipeline. | false |
status | Status | STRING Optionsopen, won, lost, deleted | false | |
expected_close_date | Expected Close Date | DATE | The expected close date of the deal. | false |
probability | Probability | NUMBER | The success probability percentage of the deal. Used/shown only when deal_probability for the pipeline of the deal is enabled. | false |
lost_reason | Lost Reason | STRING | The optional message about why the deal was lost. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{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)} |
Output Example
Search Deals
Name: searchDeals
Searches all deals by title, notes and/or custom fields.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
term | Term | STRING | The 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 |
fields | Fields | STRING Optionscustom_fields, notes, title | A comma-separated string array. The fields to perform the search from. Defaults to all of them. | false |
exact_match | Exact Match | BOOLEAN Optionstrue, false | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | false |
person_id | Person ID | INTEGER | Will filter deals by the provided person. | false |
organization_id | Organization ID | INTEGER | Will filter deals by the provided organization. | false |
status | Status | STRING Optionsopen, won, lost | Will filter deals by the provided specific status. | false |
include_fields | Include Fields | STRING Optionsdeal.cc_email | Supports including optional fields in the results which are not provided by default. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{[{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)} |
Output Example
Delete Deal
Name: deleteDeal
Marks a deal as deleted. After 30 days, the deal will be permanently deleted.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Deal ID | INTEGER | Id of the deal to delete. | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{INTEGER(id)} |
Output Example
Get Details of Deal
Name: getDealDetails
Returns the details of a specific deal.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Deal | INTEGER | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{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)} |
Output Example
Get Leads
Name: getLeads
Returns multiple leads. Leads are sorted by the time they were created, from oldest to newest.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
archived_status | Archived Status | STRING Optionsarchived, not_archived, all | Filtering based on the archived status of a lead. | false |
owner_id | Owner iD | INTEGER | Leads matching the given user will be returned. However, filter_idtakes precedence over owner_id when supplied. | false |
person_id | Person ID | INTEGER | If supplied, only leads matching the given person will be returned. However, filter_idtakes precedence over person_id when supplied. | false |
organization_id | Organization ID | INTEGER | If supplied, only leads matching the given organization will be returned. However, filter_idtakes precedence over organization_id when supplied. | false |
filter_id | Filter ID | INTEGER | Filter to use | false |
sort | Sort | STRING Optionsid, title, owner_id, creator_id, was_seen, expected_close_date, next_activity_id, add_time, update_time | The field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys). | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | ARRAY Items[{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)}] |
Output Example
Add Lead
Name: addLead
Creates a lead. A lead always has to be linked to a person or an organization or both.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
title | Title | STRING | The name of the lead. | true |
owner_id | Owner ID | INTEGER | User which will be the owner of the created lead. | false |
label_ids | Lead Labels IDs | ARRAY Items[STRING] | ID of the labels which will be associated with the lead. | false |
person_id | Person ID | INTEGER | Person which this lead will be linked to. | false |
organization_id | Organization ID | INTEGER | Organization which this lead will be linked to. | false |
value | Value | OBJECT Properties{NUMBER(amount), STRING(currency)} | The potential value of the lead | false |
expected_close_date | Expected Close Date | DATE | The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)} |
Output Example
Delete Lead
Name: deleteLead
Deletes a specific lead.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Lead ID | STRING | The ID of the lead | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{STRING(id)} |
Output Example
Get Lead Details
Name: getLeadDetails
Returns details of a specific lead.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Lead ID | STRING | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)} |
Output Example
Search Leads
Name: searchLeads
Searches all leads by title, notes and/or custom fields.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
term | Term | STRING | The 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 |
fields | Fields | STRING Optionscustom_fields, notes, title | A comma-separated string array. The fields to perform the search from. Defaults to all of them. | false |
exact_match | Exact Match | BOOLEAN Optionstrue, false | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | false |
person_id | Person ID | INTEGER | Will filter leads by the provided person ID. | false |
organization_id | Organization ID | INTEGER | Will filter leads by the provided organization ID. | false |
include_fields | Include Fields | STRING Optionslead.was_seen | Supports including optional fields in the results which are not provided by default. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{[{STRING(id), STRING(title), INTEGER(owner_id), {INTEGER(amount), STRING(currency)}(value), DATE(expected_close_date), INTEGER(person_id)}](items)} |
Output Example
Get All Organizations
Name: getOrganizations
Returns all organizations.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
user_id | User ID | INTEGER | Organizations owned by the given user will be returned. However, filter_idtakes precedence over user_id when both are supplied. | false |
filter_id | Filter ID | INTEGER | Filter to use | false |
first_char | First Characters | STRING | Organizations whose name starts with the specified letter will be returned (case insensitive) | false |
sort | Sort | STRING | The 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 |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | ARRAY Items[{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)}] |
Output Example
Add Organization
Name: addOrganization
Adds a new organization.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
name | Name | STRING | The name of the organization. | true |
owner_id | Owner ID | INTEGER | ID of the user who will be marked as the owner of this organization. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)} |
Output Example
Search Organizations
Name: searchOrganization
Searches all organizations by name, address, notes and/or custom fields. This endpoint is a wrapper of <a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem">/v1/itemSearch</a> with a narrower OAuth scope.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
term | Term | STRING | The 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 |
fields | Fields | STRING Optionsaddress, custom_fields, notes, name | A comma-separated string array. The fields to perform the search from. Defaults to all of them. | false |
exact_match | Exact Match | BOOLEAN Optionstrue, false | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{[{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)}](items)} |
Output Example
Delete Organization
Name: deleteOrganization
Marks an organization as deleted. After 30 days, the organization will be permanently deleted.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Organization | INTEGER | Organization to delete | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{INTEGER(id)} |
Output Example
Get Details of Organization
Name: getOrganizationDetails
Returns the details of an organization.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Organizaton | INTEGER | Organization to get details. | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{INTEGER(id), INTEGER(company_id), {INTEGER(id), STRING(name), STRING(email)}(owner_id), STRING(name)} |
Output Example
Get Persons
Name: getPersons
Returns all persons.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
user_id | User ID | INTEGER | Persons owned by the given user will be returned. However, filter_idtakes precedence over user_id when both are supplied. | false |
filter_id | Filter ID | INTEGER | Filter to use. | false |
first_char | First Characters | STRING | Persons whose name starts with the specified letter will be returned (case insensitive) | false |
sort | Sort | STRING | The field names and sorting mode separated by a comma. Only first-level field keys are supported (no nested keys). | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | ARRAY Items[{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)}] |
Output Example
Add Person
Name: addPerson
Adds a new person.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
name | Name | STRING | Person full name | true |
owner_id | Owner ID | INTEGER | ID of the user who will be marked as the owner of this person. | false |
org_id | Organization ID | INTEGER | ID of the organization this person will belong to. | false |
ARRAY Items[{STRING(value), BOOLEAN(primary), STRING(label)}] | An email addresses related to the person. | false | ||
phone | Phone | ARRAY Items[{STRING(value), BOOLEAN(primary), STRING(label)}] | A phone numbers related to the person. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{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)} |
Output Example
Search Persons
Name: searchPersons
Searches all persons by name, email, phone, notes and/or custom fields.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
term | Term | STRING | The 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 |
fields | Fields | STRING Optionscustom_fields, email, notes, phone, name | A comma-separated string array. The fields to perform the search from. Defaults to all of them. | false |
exact_match | Exact Match | BOOLEAN Optionstrue, false | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. | false |
organization_id | Organization ID | INTEGER | Will filter persons by the provided organization. | false |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{[{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)} |
Output Example
Delete Person
Name: deletePerson
Marks a person as deleted. After 30 days, the person will be permanently deleted.
Properties
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Person | INTEGER | Person to delete | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{INTEGER(id)} |
Output Example
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
Name | Label | Type | Description | Required |
---|---|---|---|---|
id | Person | INTEGER | Person to get details | true |
Example JSON Structure
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
data | OBJECT Properties{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)} |
Output Example
Triggers
New Activity
Name: newActivity
Trigger off whenever a new activity is added.
Type: DYNAMIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
type_name | STRING | |
public_description | STRING | |
subject | STRING | |
type | STRING | |
id | INTEGER | |
owner_name | STRING | |
user_id | INTEGER | |
company_id | INTEGER |
JSON Example
New Deal
Name: newDeal
Trigger off whenever a new deal is added.
Type: DYNAMIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
email_messages_count | INTEGER | |
cc_email | STRING | |
id | INTEGER | |
person_id | INTEGER | |
owner_name | STRING | |
status | STRING | |
title | STRING | |
currency | STRING | |
value | INTEGER |
JSON Example
New Organization
Name: newOrganization
Trigger off whenever a new organization is added.
Type: DYNAMIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
email_messages_count | INTEGER | |
cc_email | STRING | |
owner_id | INTEGER | |
id | INTEGER | |
owner_name | STRING | |
name | STRING | |
company_id | INTEGER |
JSON Example
New Person
Name: newPerson
Trigger off whenever a new person is added.
Type: DYNAMIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
email_messages_count | INTEGER | |
cc_email | STRING | |
owner_id | INTEGER | |
id | INTEGER | |
owner_name | STRING | |
phone | ARRAY Items[{STRING(value), BOOLEAN(primary)}] | |
name | STRING | |
ARRAY Items[{STRING(value), BOOLEAN(primary)}] | ||
company_id | INTEGER |
JSON Example
Updated Deal
Name: updatedDeal
Trigger off whenever an existing deal is updated.
Type: DYNAMIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
email_messages_count | INTEGER | |
cc_email | STRING | |
id | INTEGER | |
person_id | INTEGER | |
owner_name | STRING | |
status | STRING | |
title | STRING | |
currency | STRING | |
value | INTEGER |
JSON Example
Updated Organization
Name: updatedOrganization
Trigger off whenever an existing organization is updated.
Type: DYNAMIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
email_messages_count | INTEGER | |
cc_email | STRING | |
owner_id | INTEGER | |
id | INTEGER | |
owner_name | STRING | |
name | STRING | |
company_id | INTEGER |
JSON Example
Updated Person
Name: updatedPerson
Trigger off whenever an existing person is updated.
Type: DYNAMIC_WEBHOOK
Output
Type: OBJECT
Properties
Name | Type | Description |
---|---|---|
email_messages_count | INTEGER | |
cc_email | STRING | |
owner_id | INTEGER | |
id | INTEGER | |
owner_name | STRING | |
phone | ARRAY Items[{STRING(value), BOOLEAN(primary)}] | |
name | STRING | |
ARRAY Items[{STRING(value), BOOLEAN(primary)}] | ||
company_id | INTEGER |
JSON Example
Pinecone
Pinecone is a vector database designed for efficient similarity search and storage of high-dimensional data, commonly used in machine learning and AI applications.
Pipeliner
Pipeliner CRM is a comprehensive sales management tool that helps streamline sales processes through visual pipline management, contact organization, sales forecasting, and reporting.