Pipedrive

App · CRM Systems · 20 actions

Manage the people, organizations and deals in your Pipedrive sales pipeline, and the activities scheduled against them.

Actions

ActionWhat it does
Create a dealOpen a deal in a pipeline, optionally linked to a person and an organization and with a value attached.
Create a personAdd a person to Pipedrive, optionally with an email, a phone number and the organization they work for.
Create an activitySchedule a call, meeting or task, optionally against a deal, a person or an organization.
Create an organizationAdd a company to Pipedrive as an organization.
Delete a dealDelete a deal and its activities.
Delete a personDelete a person.
Delete an activityDelete an activity from Pipedrive.
Delete an organizationDelete an organization.
Get a dealRead one deal from Pipedrive by its ID.
Get a personRead one person from Pipedrive by their ID.
List activitiesList activities, one page at a time, optionally narrowed to a deal, a person, an owner, or whether they are done.
List dealsList deals, one page at a time, optionally narrowed to a pipeline, a stage, a status or the person they are with.
List organizationsList organizations in Pipedrive, one page at a time.
List personsList people in Pipedrive, one page at a time, optionally narrowed to an organization or an owner.
List pipelinesList the account's pipelines.
List stagesList the stages of one pipeline, or of every pipeline.
Search personsFind people by name, email, phone or notes.
Update a dealChange a deal: move it to another stage, mark it won or lost, or edit its value.
Update a personChange a person's name, contact details, owner, labels or organization.
Update an organizationChange an organization's name, address, website, owner or labels.

Create a deal

Open a deal in a pipeline, optionally linked to a person and an organization and with a value attached.

Inputs

TitletitletextRequired
What the deal is called.
Valuevaluenumber
What the deal is worth, in whole currency units (1500 means 1,500.00, not 15.00).
Currencycurrencytext
The three-letter currency code for the value. Leave blank to use the account's default currency.
Person IDperson_idtext
The person this deal is with. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Organization IDorganization_idtext
The organization this deal is with. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Pipelinepipeline_idtext
Which pipeline to open the deal in. Only needed when no stage is chosen, since a stage already belongs to a pipeline.
Stagestage_idtext
Which stage to open the deal in. Leave blank to use the first stage of the chosen pipeline.
Statusstatustext
Whether the deal is open, already won, or lost.One of: open, won, lost.
Expected close dateexpected_close_datedate
When the deal is expected to close.
Probabilityprobabilitynumber
How likely the deal is to close, as a whole-number percentage from 0 to 100. Only used when the pipeline has deal probability switched on.From 0.0 to 100.0.
Owner IDowner_idnumber
The numeric ID of the Pipedrive user who should own the deal. Leave blank to use the user whose API token this connection holds.

Outputs

acvnumber
add_timetext
arrnumber
channelnumber
channel_idtext
close_timetext
currencytext
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
expected_close_datetext
idnumber
is_archivedtrue/false
is_deletedtrue/false
label_idslist
lost_reasontext
lost_timetext
mrrnumber
org_idnumber
origintext
origin_idtext
owner_idnumber
person_idnumber
pipeline_idnumber
probabilitynumber
source_lead_idtext
stage_change_timetext
stage_idnumber
statustext
titletext
update_timetext
valuenumber
visible_tonumber
won_timetext
Example output
{
  "id": 1,
  "title": "New engine order"
}

Create a person

Add a person to Pipedrive, optionally with an email, a phone number and the organization they work for.

Inputs

NamenametextRequired
The person's full name.
Emailemailtext
The person's email address. Several can be given; the first becomes their primary address.
Phonephonetext
The person's phone number. Several can be given; the first becomes their primary number.
Organization IDorganization_idtext
The organization this person works for. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Owner IDowner_idnumber
The numeric ID of the Pipedrive user who should own the person. Leave blank to use the user whose API token this connection holds.
Label IDslabel_idslist
The numeric IDs of the labels to put on the person. Pipedrive's labels are per-account, so their IDs come from the label's own settings screen.
Marketing statusmarketing_statustext
The person's marketing consent. Pipedrive allows each change of this only once, and ignores it entirely for a person with no valid email address.One of: no_consent (No consent), subscribed, unsubscribed, archived.

Outputs

add_timetext
birthdaytext
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
emailslist
first_nametext
idnumber
imlist
is_deletedtrue/false
job_titletext
label_idslist
last_nametext
marketing_statustext
nametext
notestext
org_idnumber
owner_idnumber
phoneslist
picture_idnumber
postal_addressobject
update_timetext
visible_tonumber
Example output
{
  "id": 1,
  "name": "Ada Lovelace"
}

Create an activity

Schedule a call, meeting or task, optionally against a deal, a person or an organization.

Inputs

SubjectsubjecttextRequired
What the activity is called.
Activity typeactivity_typetext
The kind of activity. Leave blank to use the account's default type.
Due datedue_datedate
The day the activity is due.
Due timedue_timetime
The time of day the activity starts. Leave blank for an all-day activity.
Durationdurationtime
How long the activity lasts, as a length of time on the clock (01:30 means an hour and a half).
Deal IDdeal_idtext
The deal this activity is about. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Person IDperson_idtext
The person this activity is with. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Organization IDorganization_idtext
The organization this activity is with. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Notenotetext
A note to attach to the activity.
Already donedonetrue/false
Mark the activity as already completed.
Owner IDowner_idnumber
The numeric ID of the Pipedrive user who should own the activity. Leave blank to use the user whose API token this connection holds.

Outputs

add_timetext
attendeeslist
busytrue/false
creator_user_idnumber
deal_idnumber
donetrue/false
due_datetext
due_timetext
durationtext
idnumber
is_deletedtrue/false
lead_idtext
locationobject
marked_as_done_timetext
notetext
org_idnumber
owner_idnumber
participantslist
person_idnumber
prioritynumber
project_idnumber
public_descriptiontext
subjecttext
typetext
update_timetext
Example output
{
  "id": 1,
  "subject": "Intro call"
}

Create an organization

Add a company to Pipedrive as an organization.

Inputs

NamenametextRequired
The organization's name.
Addressaddresstext
The organization's address, as one line.
Websitewebsitetext
The organization's website URL.
Owner IDowner_idnumber
The numeric ID of the Pipedrive user who should own the organization. Leave blank to use the user whose API token this connection holds.
Label IDslabel_idslist
The numeric IDs of the labels to put on the organization. Pipedrive's labels are per-account, so their IDs come from the label's own settings screen.

Outputs

add_timetext
addressobject
annual_revenuenumber
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
employee_countnumber
idnumber
industrynumber
is_deletedtrue/false
label_idslist
linkedintext
nametext
owner_idnumber
update_timetext
visible_tonumber
websitetext
Example output
{
  "id": 1,
  "name": "Analytical Engines Ltd"
}

Delete a deal

Delete a deal and its activities. Pipedrive keeps the deal recoverable for 30 days before removing it permanently.

Inputs

Deal IDdeal_idtextRequired
The deal to delete. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.

Outputs

deletedtrue/false
idnumber
permanently_deletedtrue/false
Example output
{
  "deleted": true,
  "id": 1,
  "permanently_deleted": false
}

Delete a person

Delete a person. Pipedrive keeps them recoverable for 30 days before removing them permanently.

Inputs

Person IDperson_idtextRequired
The person to delete. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.

Outputs

deletedtrue/false
idnumber
permanently_deletedtrue/false
Example output
{
  "deleted": true,
  "id": 1,
  "permanently_deleted": false
}

Delete an activity

Delete an activity from Pipedrive.

Inputs

Activity IDactivity_idtextRequired
The activity to delete. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.

Outputs

deletedtrue/false
idnumber
permanently_deletedtrue/false
Example output
{
  "deleted": true,
  "id": 1,
  "permanently_deleted": false
}

Delete an organization

Delete an organization. The people and deals linked to it are kept, just no longer linked.

Inputs

Organization IDorganization_idtextRequired
The organization to delete. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.

Outputs

deletedtrue/false
idnumber
permanently_deletedtrue/false
Example output
{
  "deleted": true,
  "id": 1,
  "permanently_deleted": false
}

Get a deal

Read one deal from Pipedrive by its ID.

Inputs

Deal IDdeal_idtextRequired
The deal to read. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.

Outputs

acvnumber
add_timetext
arrnumber
channelnumber
channel_idtext
close_timetext
currencytext
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
expected_close_datetext
idnumber
is_archivedtrue/false
is_deletedtrue/false
label_idslist
lost_reasontext
lost_timetext
mrrnumber
org_idnumber
origintext
origin_idtext
owner_idnumber
person_idnumber
pipeline_idnumber
probabilitynumber
source_lead_idtext
stage_change_timetext
stage_idnumber
statustext
titletext
update_timetext
valuenumber
visible_tonumber
won_timetext
Example output
{
  "id": 1,
  "title": "New engine order"
}

Get a person

Read one person from Pipedrive by their ID.

Inputs

Person IDperson_idtextRequired
The person to read. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.

Outputs

add_timetext
birthdaytext
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
emailslist
first_nametext
idnumber
imlist
is_deletedtrue/false
job_titletext
label_idslist
last_nametext
marketing_statustext
nametext
notestext
org_idnumber
owner_idnumber
phoneslist
picture_idnumber
postal_addressobject
update_timetext
visible_tonumber
Example output
{
  "id": 1,
  "name": "Ada Lovelace"
}

List activities

List activities, one page at a time, optionally narrowed to a deal, a person, an owner, or whether they are done.

Inputs

Deal IDdeal_idtext
Only return activities on this deal. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Person IDperson_idtext
Only return activities with this person. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Organization IDorganization_idtext
Only return activities with this organization. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Owner IDowner_idnumber
Only return activities owned by this Pipedrive user ID. Leave blank for all owners.
Donedonetrue/false
Only return activities that are done, or only those that are not. Leave blank for both.
Updated sinceupdated_sincedate and time
Only return activities changed at or after this moment. Leave blank for all of them.
Sort bysort_bytext
Which field to order the results by.One of: id, update_time (Last updated), add_time (Created), due_date (Due date).
Sort directionsort_directiontext
Whether to order the results ascending or descending.One of: asc (Ascending), desc (Descending).
Limitlimitnumber
How many activities to return in this page, from 1 to 500.From 1 to 500. Default: 100.
Cursorcursortext
Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.

Outputs

activitieslist
countnumber
has_moretrue/false
next_cursortext
Example output
{
  "activities": [
    {}
  ],
  "count": 1,
  "has_more": false,
  "next_cursor": null
}

List deals

List deals, one page at a time, optionally narrowed to a pipeline, a stage, a status or the person they are with.

Inputs

Statusstatuslist
Only return deals in these states. Choose none to return every deal that has not been deleted.One or more of: open, won, lost, deleted (Deleted (within the last 30 days)).
Pipelinepipeline_idtext
Only return deals in this pipeline.
Stagestage_idtext
Only return deals in this stage.
Person IDperson_idtext
Only return deals with this person. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Organization IDorganization_idtext
Only return deals with this organization. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Owner IDowner_idnumber
Only return deals owned by this Pipedrive user ID. Leave blank for all owners.
Updated sinceupdated_sincedate and time
Only return deals changed at or after this moment. Leave blank for all of them.
Sort bysort_bytext
Which field to order the results by.One of: id, update_time (Last updated), add_time (Created).
Sort directionsort_directiontext
Whether to order the results ascending or descending.One of: asc (Ascending), desc (Descending).
Limitlimitnumber
How many deals to return in this page, from 1 to 500.From 1 to 500. Default: 100.
Cursorcursortext
Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.

Outputs

countnumber
dealslist
has_moretrue/false
next_cursortext
Example output
{
  "count": 1,
  "deals": [
    {}
  ],
  "has_more": false,
  "next_cursor": null
}

List organizations

List organizations in Pipedrive, one page at a time.

Inputs

Owner IDowner_idnumber
Only return organizations owned by this Pipedrive user ID. Leave blank for all owners.
Updated sinceupdated_sincedate and time
Only return organizations changed at or after this moment. Leave blank for all of them.
Sort bysort_bytext
Which field to order the results by.One of: id, update_time (Last updated), add_time (Created).
Sort directionsort_directiontext
Whether to order the results ascending or descending.One of: asc (Ascending), desc (Descending).
Limitlimitnumber
How many organizations to return in this page, from 1 to 500.From 1 to 500. Default: 100.
Cursorcursortext
Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.

Outputs

countnumber
has_moretrue/false
next_cursortext
organizationslist
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "organizations": [
    {}
  ]
}

List persons

List people in Pipedrive, one page at a time, optionally narrowed to an organization or an owner.

Inputs

Organization IDorganization_idtext
Only return people at this organization. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Owner IDowner_idnumber
Only return people owned by this Pipedrive user ID. Leave blank for all owners.
Updated sinceupdated_sincedate and time
Only return people changed at or after this moment. Leave blank for all of them.
Sort bysort_bytext
Which field to order the results by.One of: id, update_time (Last updated), add_time (Created).
Sort directionsort_directiontext
Whether to order the results ascending or descending.One of: asc (Ascending), desc (Descending).
Limitlimitnumber
How many people to return in this page, from 1 to 500.From 1 to 500. Default: 100.
Cursorcursortext
Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.

Outputs

countnumber
has_moretrue/false
next_cursortext
personslist
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "persons": [
    {}
  ]
}

List pipelines

List the account's pipelines. Use this to find the pipeline ID a deal should go into.

Inputs

Sort bysort_bytext
Which field to order the results by.One of: id, update_time (Last updated), add_time (Created).
Sort directionsort_directiontext
Whether to order the results ascending or descending.One of: asc (Ascending), desc (Descending).
Limitlimitnumber
How many pipelines to return in this page, from 1 to 500.From 1 to 500. Default: 100.
Cursorcursortext
Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.

Outputs

countnumber
has_moretrue/false
next_cursortext
pipelineslist
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "pipelines": [
    {}
  ]
}

List stages

List the stages of one pipeline, or of every pipeline. Use this to find the stage ID to move a deal to.

Inputs

Pipelinepipeline_idtext
Only return the stages of this pipeline. Leave blank for every pipeline's stages.
Sort bysort_bytext
Which field to order the results by.One of: id, update_time (Last updated), add_time (Created), order_nr (Order in pipeline).
Sort directionsort_directiontext
Whether to order the results ascending or descending.One of: asc (Ascending), desc (Descending).
Limitlimitnumber
How many stages to return in this page, from 1 to 500.From 1 to 500. Default: 100.
Cursorcursortext
Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.

Outputs

countnumber
has_moretrue/false
next_cursortext
stageslist
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "stages": [
    {}
  ]
}

Search persons

Find people by name, email, phone or notes. Use this to look someone up when you have their email rather than their ID.

Inputs

Search termtermtextRequired
What to search for. Pipedrive needs at least two characters, or one when 'Exact match' is on.
Fieldsfieldslist
Which fields to search in. Choose none to search all of them.One or more of: name, email, phone, notes, custom_fields (Custom fields).
Exact matchexact_matchtrue/false
Only return people matching the whole term exactly. Not case sensitive.
Organization IDorganization_idtext
Only return people at this organization. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Limitlimitnumber
How many matches to return in this page, from 1 to 500.From 1 to 500. Default: 100.

Outputs

countnumber
has_moretrue/false
next_cursortext
personslist
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": null,
  "persons": [
    {}
  ]
}

Update a deal

Change a deal: move it to another stage, mark it won or lost, or edit its value. Fields left blank keep their current value.

Inputs

Deal IDdeal_idtextRequired
The deal to update. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Titletitletext
A new title for the deal.
Valuevaluenumber
A new value, in whole currency units (1500 means 1,500.00, not 15.00).
Currencycurrencytext
A new three-letter currency code for the value.
Stagestage_idtext
Move the deal to this stage.
Statusstatustext
Mark the deal open, won or lost. A lost reason can only be given alongside 'lost'.One of: open, won, lost.
Lost reasonlost_reasontext
Why the deal was lost. Pipedrive only accepts this when the status is being set to lost in the same step.
Expected close dateexpected_close_datedate
A new expected close date.
Probabilityprobabilitynumber
How likely the deal is to close, as a whole-number percentage from 0 to 100.From 0.0 to 100.0.
Person IDperson_idtext
Link the deal to this person. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Organization IDorganization_idtext
Link the deal to this organization. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Owner IDowner_idnumber
The numeric ID of the Pipedrive user who should own the deal. Leave blank to use the user whose API token this connection holds.

Outputs

acvnumber
add_timetext
arrnumber
channelnumber
channel_idtext
close_timetext
currencytext
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
expected_close_datetext
idnumber
is_archivedtrue/false
is_deletedtrue/false
label_idslist
lost_reasontext
lost_timetext
mrrnumber
org_idnumber
origintext
origin_idtext
owner_idnumber
person_idnumber
pipeline_idnumber
probabilitynumber
source_lead_idtext
stage_change_timetext
stage_idnumber
statustext
titletext
update_timetext
valuenumber
visible_tonumber
won_timetext
Example output
{
  "id": 1,
  "title": "New engine order"
}

Update a person

Change a person's name, contact details, owner, labels or organization. Fields left blank keep their current value.

Inputs

Person IDperson_idtextRequired
The person to update. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Namenametext
A new full name for the person.
Emailemailtext
Replaces the person's email addresses. The first becomes their primary address.
Phonephonetext
Replaces the person's phone numbers. The first becomes their primary number.
Organization IDorganization_idtext
Move the person to this organization. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Owner IDowner_idnumber
The numeric ID of the Pipedrive user who should own the person. Leave blank to use the user whose API token this connection holds.
Label IDslabel_idslist
The numeric IDs of the labels to put on the person. Pipedrive's labels are per-account, so their IDs come from the label's own settings screen.
Marketing statusmarketing_statustext
The person's marketing consent. Pipedrive allows each change of this only once.One of: no_consent (No consent), subscribed, unsubscribed, archived.

Outputs

add_timetext
birthdaytext
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
emailslist
first_nametext
idnumber
imlist
is_deletedtrue/false
job_titletext
label_idslist
last_nametext
marketing_statustext
nametext
notestext
org_idnumber
owner_idnumber
phoneslist
picture_idnumber
postal_addressobject
update_timetext
visible_tonumber
Example output
{
  "id": 1,
  "name": "Ada Lovelace"
}

Update an organization

Change an organization's name, address, website, owner or labels. Fields left blank keep their current value.

Inputs

Organization IDorganization_idtextRequired
The organization to update. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Namenametext
A new name for the organization.
Addressaddresstext
A new address, as one line.
Websitewebsitetext
A new website URL.
Owner IDowner_idnumber
The numeric ID of the Pipedrive user who should own the organization. Leave blank to use the user whose API token this connection holds.
Label IDslabel_idslist
The numeric IDs of the labels to put on the organization. Pipedrive's labels are per-account, so their IDs come from the label's own settings screen.

Outputs

add_timetext
addressobject
annual_revenuenumber
custom_fieldsobject
The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
employee_countnumber
idnumber
industrynumber
is_deletedtrue/false
label_idslist
linkedintext
nametext
owner_idnumber
update_timetext
visible_tonumber
websitetext
Example output
{
  "id": 1,
  "name": "Analytical Engines Ltd"
}

On this page