Pipedrive
App · CRM Systems · 20 actions
Manage the people, organizations and deals in your Pipedrive sales pipeline, and the activities scheduled against them.
Actions
| Action | What it does |
|---|---|
| Create a deal | Open a deal in a pipeline, optionally linked to a person and an organization and with a value attached. |
| Create a person | Add a person to Pipedrive, optionally with an email, a phone number and the organization they work for. |
| Create an activity | Schedule a call, meeting or task, optionally against a deal, a person or an organization. |
| Create an organization | Add a company to Pipedrive as an organization. |
| Delete a deal | Delete a deal and its activities. |
| Delete a person | Delete a person. |
| Delete an activity | Delete an activity from Pipedrive. |
| Delete an organization | Delete an organization. |
| Get a deal | Read one deal from Pipedrive by its ID. |
| Get a person | Read one person from Pipedrive by their ID. |
| List activities | List activities, one page at a time, optionally narrowed to a deal, a person, an owner, or whether they are done. |
| List deals | List deals, one page at a time, optionally narrowed to a pipeline, a stage, a status or the person they are with. |
| List organizations | List organizations in Pipedrive, one page at a time. |
| List persons | List people in Pipedrive, one page at a time, optionally narrowed to an organization or an owner. |
| List pipelines | List the account's pipelines. |
| List stages | List the stages of one pipeline, or of every pipeline. |
| Search persons | Find people by name, email, phone or notes. |
| Update a deal | Change a deal: move it to another stage, mark it won or lost, or edit its value. |
| Update a person | Change a person's name, contact details, owner, labels or organization. |
| Update an organization | Change 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
- Title
titletextRequired - What the deal is called.
- Value
valuenumber - What the deal is worth, in whole currency units (1500 means 1,500.00, not 15.00).
- Currency
currencytext - The three-letter currency code for the value. Leave blank to use the account's default currency.
- Person ID
person_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 ID
organization_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.
- Pipeline
pipeline_idtext - Which pipeline to open the deal in. Only needed when no stage is chosen, since a stage already belongs to a pipeline.
- Stage
stage_idtext - Which stage to open the deal in. Leave blank to use the first stage of the chosen pipeline.
- Status
statustext - Whether the deal is open, already won, or lost.One of:
open,won,lost. - Expected close date
expected_close_datedate - When the deal is expected to close.
- Probability
probabilitynumber - 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 ID
owner_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
acvnumberadd_timetextarrnumberchannelnumberchannel_idtextclose_timetextcurrencytextcustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
expected_close_datetextidnumberis_archivedtrue/falseis_deletedtrue/falselabel_idslistlost_reasontextlost_timetextmrrnumberorg_idnumberorigintextorigin_idtextowner_idnumberperson_idnumberpipeline_idnumberprobabilitynumbersource_lead_idtextstage_change_timetextstage_idnumberstatustexttitletextupdate_timetextvaluenumbervisible_tonumberwon_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
- Name
nametextRequired - The person's full name.
- Email
emailtext - The person's email address. Several can be given; the first becomes their primary address.
- Phone
phonetext - The person's phone number. Several can be given; the first becomes their primary number.
- Organization ID
organization_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 ID
owner_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 IDs
label_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 status
marketing_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_timetextbirthdaytextcustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
emailslistfirst_nametextidnumberimlistis_deletedtrue/falsejob_titletextlabel_idslistlast_nametextmarketing_statustextnametextnotestextorg_idnumberowner_idnumberphoneslistpicture_idnumberpostal_addressobjectupdate_timetextvisible_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
- Subject
subjecttextRequired - What the activity is called.
- Activity type
activity_typetext - The kind of activity. Leave blank to use the account's default type.
- Due date
due_datedate - The day the activity is due.
- Due time
due_timetime - The time of day the activity starts. Leave blank for an all-day activity.
- Duration
durationtime - How long the activity lasts, as a length of time on the clock (01:30 means an hour and a half).
- Deal ID
deal_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 ID
person_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 ID
organization_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.
- Note
notetext - A note to attach to the activity.
- Already done
donetrue/false - Mark the activity as already completed.
- Owner ID
owner_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_timetextattendeeslistbusytrue/falsecreator_user_idnumberdeal_idnumberdonetrue/falsedue_datetextdue_timetextdurationtextidnumberis_deletedtrue/falselead_idtextlocationobjectmarked_as_done_timetextnotetextorg_idnumberowner_idnumberparticipantslistperson_idnumberprioritynumberproject_idnumberpublic_descriptiontextsubjecttexttypetextupdate_timetext
Example output
{
"id": 1,
"subject": "Intro call"
}Create an organization
Add a company to Pipedrive as an organization.
Inputs
- Name
nametextRequired - The organization's name.
- Address
addresstext - The organization's address, as one line.
- Website
websitetext - The organization's website URL.
- Owner ID
owner_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 IDs
label_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_timetextaddressobjectannual_revenuenumbercustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
employee_countnumberidnumberindustrynumberis_deletedtrue/falselabel_idslistlinkedintextnametextowner_idnumberupdate_timetextvisible_tonumberwebsitetext
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 ID
deal_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/falseidnumberpermanently_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 ID
person_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/falseidnumberpermanently_deletedtrue/false
Example output
{
"deleted": true,
"id": 1,
"permanently_deleted": false
}Delete an activity
Delete an activity from Pipedrive.
Inputs
- Activity ID
activity_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/falseidnumberpermanently_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 ID
organization_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/falseidnumberpermanently_deletedtrue/false
Example output
{
"deleted": true,
"id": 1,
"permanently_deleted": false
}Get a deal
Read one deal from Pipedrive by its ID.
Inputs
- Deal ID
deal_idtextRequired - The deal to read. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
Outputs
acvnumberadd_timetextarrnumberchannelnumberchannel_idtextclose_timetextcurrencytextcustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
expected_close_datetextidnumberis_archivedtrue/falseis_deletedtrue/falselabel_idslistlost_reasontextlost_timetextmrrnumberorg_idnumberorigintextorigin_idtextowner_idnumberperson_idnumberpipeline_idnumberprobabilitynumbersource_lead_idtextstage_change_timetextstage_idnumberstatustexttitletextupdate_timetextvaluenumbervisible_tonumberwon_timetext
Example output
{
"id": 1,
"title": "New engine order"
}Get a person
Read one person from Pipedrive by their ID.
Inputs
- Person ID
person_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_timetextbirthdaytextcustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
emailslistfirst_nametextidnumberimlistis_deletedtrue/falsejob_titletextlabel_idslistlast_nametextmarketing_statustextnametextnotestextorg_idnumberowner_idnumberphoneslistpicture_idnumberpostal_addressobjectupdate_timetextvisible_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 ID
deal_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 ID
person_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 ID
organization_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 ID
owner_idnumber - Only return activities owned by this Pipedrive user ID. Leave blank for all owners.
- Done
donetrue/false - Only return activities that are done, or only those that are not. Leave blank for both.
- Updated since
updated_sincedate and time - Only return activities changed at or after this moment. Leave blank for all of them.
- Sort by
sort_bytext - Which field to order the results by.One of:
id,update_time(Last updated),add_time(Created),due_date(Due date). - Sort direction
sort_directiontext - Whether to order the results ascending or descending.One of:
asc(Ascending),desc(Descending). - Limit
limitnumber - How many activities to return in this page, from 1 to 500.From 1 to 500. Default:
100. - Cursor
cursortext - Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.
Outputs
activitieslistcountnumberhas_moretrue/falsenext_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
- Status
statuslist - 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)). - Pipeline
pipeline_idtext - Only return deals in this pipeline.
- Stage
stage_idtext - Only return deals in this stage.
- Person ID
person_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 ID
organization_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 ID
owner_idnumber - Only return deals owned by this Pipedrive user ID. Leave blank for all owners.
- Updated since
updated_sincedate and time - Only return deals changed at or after this moment. Leave blank for all of them.
- Sort by
sort_bytext - Which field to order the results by.One of:
id,update_time(Last updated),add_time(Created). - Sort direction
sort_directiontext - Whether to order the results ascending or descending.One of:
asc(Ascending),desc(Descending). - Limit
limitnumber - How many deals to return in this page, from 1 to 500.From 1 to 500. Default:
100. - Cursor
cursortext - Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.
Outputs
countnumberdealslisthas_moretrue/falsenext_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 ID
owner_idnumber - Only return organizations owned by this Pipedrive user ID. Leave blank for all owners.
- Updated since
updated_sincedate and time - Only return organizations changed at or after this moment. Leave blank for all of them.
- Sort by
sort_bytext - Which field to order the results by.One of:
id,update_time(Last updated),add_time(Created). - Sort direction
sort_directiontext - Whether to order the results ascending or descending.One of:
asc(Ascending),desc(Descending). - Limit
limitnumber - How many organizations to return in this page, from 1 to 500.From 1 to 500. Default:
100. - Cursor
cursortext - Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.
Outputs
countnumberhas_moretrue/falsenext_cursortextorganizationslist
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 ID
organization_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 ID
owner_idnumber - Only return people owned by this Pipedrive user ID. Leave blank for all owners.
- Updated since
updated_sincedate and time - Only return people changed at or after this moment. Leave blank for all of them.
- Sort by
sort_bytext - Which field to order the results by.One of:
id,update_time(Last updated),add_time(Created). - Sort direction
sort_directiontext - Whether to order the results ascending or descending.One of:
asc(Ascending),desc(Descending). - Limit
limitnumber - How many people to return in this page, from 1 to 500.From 1 to 500. Default:
100. - Cursor
cursortext - Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.
Outputs
countnumberhas_moretrue/falsenext_cursortextpersonslist
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 by
sort_bytext - Which field to order the results by.One of:
id,update_time(Last updated),add_time(Created). - Sort direction
sort_directiontext - Whether to order the results ascending or descending.One of:
asc(Ascending),desc(Descending). - Limit
limitnumber - How many pipelines to return in this page, from 1 to 500.From 1 to 500. Default:
100. - Cursor
cursortext - Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.
Outputs
countnumberhas_moretrue/falsenext_cursortextpipelineslist
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
- Pipeline
pipeline_idtext - Only return the stages of this pipeline. Leave blank for every pipeline's stages.
- Sort by
sort_bytext - Which field to order the results by.One of:
id,update_time(Last updated),add_time(Created),order_nr(Order in pipeline). - Sort direction
sort_directiontext - Whether to order the results ascending or descending.One of:
asc(Ascending),desc(Descending). - Limit
limitnumber - How many stages to return in this page, from 1 to 500.From 1 to 500. Default:
100. - Cursor
cursortext - Leave blank for the first page. To read the next one, pass the 'next_cursor' this action returned.
Outputs
countnumberhas_moretrue/falsenext_cursortextstageslist
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 term
termtextRequired - What to search for. Pipedrive needs at least two characters, or one when 'Exact match' is on.
- Fields
fieldslist - 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 match
exact_matchtrue/false - Only return people matching the whole term exactly. Not case sensitive.
- Organization ID
organization_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.
- Limit
limitnumber - How many matches to return in this page, from 1 to 500.From 1 to 500. Default:
100.
Outputs
countnumberhas_moretrue/falsenext_cursortextpersonslist
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 ID
deal_idtextRequired - The deal to update. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
- Title
titletext - A new title for the deal.
- Value
valuenumber - A new value, in whole currency units (1500 means 1,500.00, not 15.00).
- Currency
currencytext - A new three-letter currency code for the value.
- Stage
stage_idtext - Move the deal to this stage.
- Status
statustext - Mark the deal open, won or lost. A lost reason can only be given alongside 'lost'.One of:
open,won,lost. - Lost reason
lost_reasontext - Why the deal was lost. Pipedrive only accepts this when the status is being set to lost in the same step.
- Expected close date
expected_close_datedate - A new expected close date.
- Probability
probabilitynumber - How likely the deal is to close, as a whole-number percentage from 0 to 100.From 0.0 to 100.0.
- Person ID
person_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 ID
organization_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 ID
owner_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
acvnumberadd_timetextarrnumberchannelnumberchannel_idtextclose_timetextcurrencytextcustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
expected_close_datetextidnumberis_archivedtrue/falseis_deletedtrue/falselabel_idslistlost_reasontextlost_timetextmrrnumberorg_idnumberorigintextorigin_idtextowner_idnumberperson_idnumberpipeline_idnumberprobabilitynumbersource_lead_idtextstage_change_timetextstage_idnumberstatustexttitletextupdate_timetextvaluenumbervisible_tonumberwon_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 ID
person_idtextRequired - The person to update. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
- Name
nametext - A new full name for the person.
- Email
emailtext - Replaces the person's email addresses. The first becomes their primary address.
- Phone
phonetext - Replaces the person's phone numbers. The first becomes their primary number.
- Organization ID
organization_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 ID
owner_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 IDs
label_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 status
marketing_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_timetextbirthdaytextcustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
emailslistfirst_nametextidnumberimlistis_deletedtrue/falsejob_titletextlabel_idslistlast_nametextmarketing_statustextnametextnotestextorg_idnumberowner_idnumberphoneslistpicture_idnumberpostal_addressobjectupdate_timetextvisible_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 ID
organization_idtextRequired - The organization to update. The numeric Pipedrive ID. Pasting the record's URL works too; the ID is read out of it.
- Name
nametext - A new name for the organization.
- Address
addresstext - A new address, as one line.
- Website
websitetext - A new website URL.
- Owner ID
owner_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 IDs
label_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_timetextaddressobjectannual_revenuenumbercustom_fieldsobject- The account's custom fields, keyed by Pipedrive's 40-character field hash rather than by name.
employee_countnumberidnumberindustrynumberis_deletedtrue/falselabel_idslistlinkedintextnametextowner_idnumberupdate_timetextvisible_tonumberwebsitetext
Example output
{
"id": 1,
"name": "Analytical Engines Ltd"
}