Pipedrive is a CRM & pipeline management tool that helps you focus on actions that matter.
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
Name |
Summary |
List persons |
|
List organizations |
|
List deals |
|
Add deal |
|
Add deal (V2) |
|
Get deal by id |
|
UpdateDealStage (integer dealId, UpdateDealStageRequest body) |
Update deal stage |
UpdateDealStageV2 (integer dealId, UpdateDealStageRequestV2 body) |
Update deal stage (V2) |
UpdateDealStatus (integer dealId, UpdateDealStatusRequest body) |
Update deal status |
Add activity |
|
List activity types |
|
List pipelines |
|
List deals in pipeline |
|
List stages |
|
List currencies |
|
Get stage by id |
Name |
Summary |
When a new activity is added |
|
When a new deal is added |
|
When a new deal is added (V2) |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List persons
Description: List persons
Syntax:
Pipedrive.ListPersons ()
Returns:
Type:ListPersonsResponse
Summary: List organizations
Description: List organizations
Syntax:
Pipedrive.ListOrganizations ()
Returns:
Type:ListOrganizationsResponse
Summary: List deals
Description: List deals
Syntax:
Pipedrive.ListDeals ()
Returns:
Type:ListDealsResponse
Summary: Add deal
Description: This operation creates a new deal for the authorized account.
Syntax:
Pipedrive.AddDeal (AddDealRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:DealResponse
Description: data
Summary: Add deal (V2)
Description: This operation creates a new deal for the authorized account.
Syntax:
Pipedrive.AddDealV2 (AddDealRequestV2 body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:DealResponseV2
Description: data
Summary: Get deal by id
Description: This operation retrieves all details of an existing deal, given its id.
Syntax:
Pipedrive.GetDeal (integer dealId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
dealId |
integer (Deal Id) |
Deal |
True |
Returns:
Type:DealResponse
Description: data
Summary: Update deal stage
Description: This operation is used to update the stage associated with a deal, given its id.
Syntax:
Pipedrive.UpdateDealStage (integer dealId, UpdateDealStageRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
dealId |
integer (Deal Id) |
Deal |
True |
|
body |
|
|
True |
Returns:
Type:DealResponse
Description: data
Summary: Update deal stage (V2)
Description: This operation is used to update the stage associated with a deal, given its id.
Syntax:
Pipedrive.UpdateDealStageV2 (integer dealId, UpdateDealStageRequestV2 body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
dealId |
integer (Deal Id) |
Deal |
True |
|
body |
|
|
True |
Returns:
Type:DealResponseV2
Description: data
Summary: Update deal status
Description: This operation is used to update the status associated with a deal, given its id.
Syntax:
Pipedrive.UpdateDealStatus (integer dealId, UpdateDealStatusRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
dealId |
integer (Deal Id) |
Deal |
True |
|
body |
|
|
True |
Returns:
Type:DealResponse
Description: data
Summary: Add activity
Description: This operation is used to create a new activity for the authorized account.
Syntax:
Pipedrive.AddActivity (AddActivityRequest body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
body |
|
|
True |
Returns:
Type:ActivityResponse
Description: data
Summary: List activity types
Description: List activity types
Syntax:
Pipedrive.ListActivityTypes ()
Returns:
Type:ListActivityTypesResponse
Summary: List pipelines
Description: List pipelines
Syntax:
Pipedrive.ListPipelines ()
Returns:
Summary: List deals in pipeline
Description: List deals in pipeline
Syntax:
Pipedrive.ListPipelineDeals (string pipeline_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
pipeline_id |
string (Pipeline Id) |
Unique Id of the pipeline to fetch stages |
True |
Returns:
Type:ListDealsResponse
Summary: List stages
Description: List stages
Syntax:
Pipedrive.ListStages (string pipeline_id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
pipeline_id |
string (Pipeline Id) |
Unique Id of the pipeline to fetch stages |
True |
Returns:
Type:ListStagesResponse
Summary: List currencies
Description: List currencies
Syntax:
Pipedrive.ListCurrencies ()
Returns:
Summary: Get stage by id
Description: This operation returns data about a specific stage.
Syntax:
Pipedrive.GetStage (integer stageId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
stageId |
integer (Stage Id) |
Stage Id |
True |
Returns:
Type:StageResponse
Summary: When a new activity is added
Description: Triggers when a new activity is added to the authorized account.
Syntax:
Pipedrive.TrigNewActivity ()
Returns:
Type:array of (ActivityResponse)
Description: data
Summary: When a new deal is added
Description: Triggers when a new deal is added to the authorized account.
Syntax:
Pipedrive.TrigNewDeal ()
Returns:
Type:array of (DealResponse)
Description: data
Summary: When a new deal is added (V2)
Description: Triggers when a new deal is added to the authorized account (V2).
Syntax:
Pipedrive.TrigNewDealV2 ()
Returns:
Type:array of (DealResponseV2)
Description: data
Summary:
Description: data
Properties:
Name |
Type |
Summary |
id |
integer(int32) Activity Id |
Unique id of the activity. |
user_id |
integer(int32) User Id |
Id of the user whom the activity is assigned to. |
done |
boolean Is Done |
0 = Not done, 1 = Done |
type |
string Type |
Type of the activity. |
due_date |
string Due Date |
YYYY-MM-DD |
due_time |
string Due Time |
HH:MM |
duration |
string Duration |
HH:MM |
subject |
string Subject |
Subject of the activity. |
deal_id |
integer(int32) Deal Id |
Id of deal the activity is associated with. |
deal_title |
string Deal Title |
Title of deal the activity is associated with. |
org_id |
integer(int32) Organization Id |
Id of organization the activity is associated with. |
org_name |
string Organization Name |
Name of organization the activity is associated with. |
person_id |
integer(int32) Contact Id |
Id of person the activity is associated with. |
person_name |
string Contact Name |
Name of person the activity is associated with. |
add_time |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
update_time |
string(date-time) Updates Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
marked_as_done_time |
string(date-time) Completed Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
gcal_event_id |
string Google Calendar Event Id |
Id of the google calendar event. |
google_calendar_id |
string Google Calendar Id |
Id of the google calendar. |
note |
string Note |
Note of the activity (HTML format). |
assigned_to_user_id |
integer(int32) Assigned to |
User id of user whom the activity is assigned to. |
created_by_user_id |
integer(int32) Created by |
User id of user that created the activity. |
owner_name |
string Owner Name |
Name of the activity owner. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
type |
string Type |
Activity type. |
subject |
string Subject |
Subject of the activity. |
due_date |
string Due Date |
YYYY-MM-DD |
due_time |
string Due Time |
HH:MM |
duration |
string Duration |
HH:MM |
note |
string Notes |
|
user_id |
integer(int32) Assigned to |
Id of the user whom the activity will be assigned to. |
deal_id |
integer(int32) Deal Id |
ID of deal the activity will be associated with. |
person_id |
integer(int32) Contact Id |
Id of person the activity will be associated with. |
org_id |
integer(int32) Organization Id |
ID of the organization the activity will be associated with. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Title |
Title of the deal. |
stage_id |
string Stage Id |
Stage of the deal. Values: [Lead In, Contact Made, Demo Scheduled, Proposal Made, Negotiations Started] |
status |
string Status |
Status of the deal. Values: [Open, Won, Lost, Deleted] |
value |
integer(int32) Value |
Monetary value of the deal. |
currency |
string Currency |
Currency of the deal. Values: [Afghanistan Afghani, Albanian Lek, Algerian Dinar, Angolan Kwanza, Argentine Peso, Armenian Dram, Aruban Guilder, Australian Dollar, Azerbaijan New Manat, Azerbaijanian Manat, Bahamian Dollar, Bahraini Dinar, Bangladesh Taka, Barbados Dollar, Belarussian Ruble, Belize Dollar, Bermudian Dollar, Bhutan Ngultrum, Bitcoin, Bolivian Boliviano, Bosnia and Herzegovina Convertible Marks, Botswana Pula, Brazilian Real, Brunei Dollar, Bulgarian Lev, Burundi Franc, Cambodia Riel, Canadian Dollar, Cape Verde Escudo, Cayman Islands Dollar, CFA Franc BCEAO, CFA Franc BEAC, CFP Franc, Chilean Peso, Chilean Unidad de Fomento, Chinese Yuan Renminbi, Colombian Peso, Comoro Franc, Costa Rican Colon, Croatian Kuna, Cuban Peso, Cyprus Pound, Czech Koruna, Danish Krone, Djibouti Franc, Dominican Peso, East Caribbean Dollar, Egyptian Pound, El Salvador Colon, Eritrea Nafka, Estonian Kroon, Ethiopian Birr, Euro, Falkland Islands Pound, Fiji Dollar, Franc Congolais, Gambian Dalasi, Georgian Lari, Ghana Cedi, Ghanaian Cedi, Gibraltar Pound, Gold, Guatemala Quetzal, Guinea Franc, Guyana Dollar, Haiti Gourde, Honduras Lempira, Hong Kong Dollar, Hungarian Forint, Iceland Krona, Indian Rupee, Indonesian Rupiah, Iranian Rial, Iraqi Dinar, Jamaican Dollar, Japanese Yen, Jordanian Dinar, Kazakhstan Tenge, Kenyan Shilling, Korean Won, Kuwaiti Dinar, Kyrgyzstan Som, Lao Kip, Latvian Lats, Lebanese Pound, Lesotho Loti, Liberian Dollar, Libyan Dinar, Lithuanian Litas, Macau Pataca, Macedonian Denar, Malagasy Ariary, Malawi Kwacha, Malaysian Ringgit, Maldives Rufiyaa, Maltese Lira, Mauritania Ouguiya, Mauritius Rupee, Mexican Peso, Moldovan Leu, Mongolian Tugrik, Moroccan Dirham, Mozambican Metical, Mozambique Metical, Myanmar Kyat, Namibia Dollar, Nepalese Rupee, Netherlands Antillian Guilder, New Belarusian Ruble, New Israeli Shekel, New Taiwan Dollar, New Zealand Dollar, Nicaragua Cordoba Oro, Nigerian Naira, North Korean Won, Norwegian Krone, Pakistan Rupee, Palladium, Panama Balboa, Papua New Guinea Kina, Paraguayan Guarani, Peruvian Nuevo Sol, Peso Uruguayo, Philippine Peso, Platinum, Polish Zloty, Pound Sterling, Qatari Rial, Rial Omani, Romanian Leu, Russian Ruble, Rwanda Franc, Samoa Tala, São Tome and Principe Dobra, Saudi Riyal, SDR (Special Drawing Rights), Serbian Dinar (CSD), Serbian Dinar (RSD), Seychelles Rupee, Sierra Leone Leone, Silver, Singapore Dollar, Slovak Koruna, Slovenian Tolar, Solomon Islands Dollar, Somali Shilling, South African Rand, Sri Lanka Rupee, St Helena Pound, Sudanese Dinar, Sudanese Pound, Surinam Dollar, Swaziland Lilangeni, Swedish Krona, Swiss Franc, Syrian Pound, Tajik Somoni, Tanzanian Shilling, Thai Baht, Tonga Pa'anga, Trinidad and Tobago Dollar, Tunisian Dinar, Turkish Lira, Turkmenistan Manat, Turkmenistani Manat, UAE Dirham, Uganda Shilling, Ukraine Hryvnia, US Dollar, Uzbekistan Sum, Vanuatu Vatu, Venezuelan Bolivar, Venezuelan Bolívar, Vietnamese Dong, Yemeni Rial, Zambian Kwacha (ZMK), Zambian Kwacha (ZMW), Zimbabwe Dollar] |
person_id |
string Contact Id |
User id of person the deal is associated with. |
org_id |
string Organization Id |
Id of the organization associated with the deal. |
expected_close_date |
string Expected Close Date |
yyyy-MM-dd |
visible_to |
string Visiblity |
Owner, followers or entire company. Values: [Owner and followers, Entire company] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Title |
Title of the deal. |
pipeline_id |
string Pipeline Id |
The id of the pipeline to fetch stages from. |
stage_id |
string Stage Id |
Stage of the deal. |
status |
string Status |
Status of the deal. Values: [Open, Won, Lost, Deleted] |
value |
integer(int32) Value |
Monetary value of the deal. |
currency |
string Currency |
Currency of the deal. |
person_id |
string Contact Id |
User id of person the deal is associated with. |
org_id |
string Organization Id |
Id of the organization associated with the deal. |
expected_close_date |
string Expected Close Date |
yyyy-MM-dd |
visible_to |
string Visiblity |
Owner, followers or entire company. Values: [Owner and followers, Entire company] |
Summary:
Description: data
Properties:
Name |
Type |
Summary |
id |
integer(int32) Deal Id |
Id of the deal. |
creator_user_id |
Creator |
|
user_id |
User |
|
person_id |
Contact |
|
org_id |
Organization |
|
status |
string Status |
Open, won, lost or deleted. |
title |
string Deal Title |
Title of the deal. |
value |
number Deal Value |
Monetary value of the deal. |
currency |
string Currency |
Currency associated with the deal value. |
add_time |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
update_time |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
stage_id |
integer(int32) Stage Id |
ID of stage the deal is placed in a pipeline. |
stage_name |
string Stage Name |
Name of stage the deal is placed in a pipeline |
stage_change_time |
string(date-time) Stage Uodated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
active |
boolean Is Active |
True if the deal is active. |
deleted |
boolean Is Deleted |
True if the deal has been deleted. |
next_activity_date |
string Next Activity Date |
yyyy-MM-dd |
next_activity_time |
string Next Activity Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
next_activity_id |
integer(int32) Next Activity Id |
Id of the next activity. |
last_activity_id |
integer(int32) Last Activity Id |
Id of the last activity. |
last_activity_date |
string Last Activity Date |
yyyy-MM-dd |
lost_reason |
string Lost Reason |
Message about why the deal was lost (to be used when status=lost). |
visible_to |
string Visiblity |
Owner, followers or entire company. |
close_time |
string(date-time) Closed Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
pipeline_id |
integer(int32) Pipeline Id |
Id of pipeline the deal is associated with. |
products_count |
integer(int32) Products Count |
Number of products associated with the deal. |
files_count |
integer(int32) Files Count |
Number of files associated with the deal. |
notes_count |
integer(int32) Notes Count |
Number of notes associated with the deal. |
followers_count |
integer(int32) Followers Count |
Number of followers associated with the deal. |
email_messages_count |
integer(int32) Email Message Count |
Number of email messages associated with the deal. |
activities_count |
integer(int32) Activities Count |
Number of activities associated with the deal. |
done_activities_count |
integer(int32) Done Activities Count |
Number of done activities associated with the deal. |
undone_activities_count |
integer(int32) Undone Activities Count |
Number of undone activitie associated with the deals. |
reference_activities_count |
integer(int32) Referenced Activities Count |
Number of referenced activities associated with the deal. |
participants_count |
integer(int32) Participants Count |
Number of participants associated with the deal. |
expected_close_date |
string Expected Close Date |
yyyy-MM-dd |
next_activity_subject |
string Next Activity Subject |
Subject of next activity associated with the deal. |
next_activity_type |
string Next Activity Type |
Type of next activity associated with the deal. |
next_activity_duration |
string Next Activity Duration |
Duration of next activity associated with the deal. |
next_activity_note |
string Next Activity Note |
Notes for next activity associated with the deal |
Summary: Creator
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Id |
Id of the deal creator. |
name |
string Name |
Name of the deal creator. |
|
string |
Email of the deal creator. |
Summary: User
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Id |
Id of the deal owner. |
name |
string Name |
Name of the deal owner. |
|
string |
Email of the deal owner. |
Summary: Contact
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Name of the person associated with the deal. |
value |
integer(int32) Id |
Id of the person associated with the deal. |
Summary: Organization
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Name of the organization associated with the deal. |
value |
integer(int32) Id |
Id of the organization associated with the deal. |
Summary:
Description: data
Properties:
Name |
Type |
Summary |
id |
integer(int32) Deal Id |
Id of the deal. |
creator_user_id |
Creator |
|
user_id |
User |
|
person_id |
Contact |
|
org_id |
Organization |
|
status |
string Status |
Open, won, lost or deleted. |
title |
string Deal Title |
Title of the deal. |
value |
number Deal Value |
Monetary value of the deal. |
currency |
string Currency |
Currency associated with the deal value. |
add_time |
string(date-time) Created Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
update_time |
string(date-time) Updated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
stage_id |
integer(int32) Stage Id |
ID of stage the deal is placed in a pipeline. |
stage_change_time |
string(date-time) Stage Uodated Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
active |
boolean Is Active |
True if the deal is active. |
deleted |
boolean Is Deleted |
True if the deal has been deleted. |
next_activity_date |
string Next Activity Date |
yyyy-MM-dd |
next_activity_time |
string Next Activity Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
next_activity_id |
integer(int32) Next Activity Id |
Id of the next activity. |
last_activity_id |
integer(int32) Last Activity Id |
Id of the last activity. |
last_activity_date |
string Last Activity Date |
yyyy-MM-dd |
lost_reason |
string Lost Reason |
Message about why the deal was lost (to be used when status=lost). |
visible_to |
string Visiblity |
Owner, followers or entire company. |
close_time |
string(date-time) Closed Date-Time |
yyyy-MM-ddTHH:mm:ss.fffZ |
pipeline_id |
integer(int32) Pipeline Id |
Id of pipeline the deal is associated with. |
products_count |
integer(int32) Products Count |
Number of products associated with the deal. |
files_count |
integer(int32) Files Count |
Number of files associated with the deal. |
notes_count |
integer(int32) Notes Count |
Number of notes associated with the deal. |
followers_count |
integer(int32) Followers Count |
Number of followers associated with the deal. |
email_messages_count |
integer(int32) Email Message Count |
Number of email messages associated with the deal. |
activities_count |
integer(int32) Activities Count |
Number of activities associated with the deal. |
done_activities_count |
integer(int32) Done Activities Count |
Number of done activities associated with the deal. |
undone_activities_count |
integer(int32) Undone Activities Count |
Number of undone activitie associated with the deals. |
reference_activities_count |
integer(int32) Referenced Activities Count |
Number of referenced activities associated with the deal. |
participants_count |
integer(int32) Participants Count |
Number of participants associated with the deal. |
expected_close_date |
string Expected Close Date |
yyyy-MM-dd |
next_activity_subject |
string Next Activity Subject |
Subject of next activity associated with the deal. |
next_activity_type |
string Next Activity Type |
Type of next activity associated with the deal. |
next_activity_duration |
string Next Activity Duration |
Duration of next activity associated with the deal. |
next_activity_note |
string Next Activity Note |
Notes for next activity associated with the deal |
Summary: Creator
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Id |
Id of the deal creator. |
name |
string Name |
Name of the deal creator. |
|
string |
Email of the deal creator. |
Summary: User
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Id |
Id of the deal owner. |
name |
string Name |
Name of the deal owner. |
|
string |
Email of the deal owner. |
Summary: Contact
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Name of the person associated with the deal. |
value |
integer(int32) Id |
Id of the person associated with the deal. |
Summary: Organization
Description:
Properties:
Name |
Type |
Summary |
name |
string Name |
Name of the organization associated with the deal. |
value |
integer(int32) Id |
Id of the organization associated with the deal. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
success |
boolean success |
success |
data |
array of (DataItem) data |
data |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) id |
id |
name |
string name |
name |
Summary:
Description:
Properties:
Name |
Type |
Summary |
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Id |
id |
code |
string Code |
Code of a currency |
name |
string Name |
Name of a currency |
Summary:
Description:
Properties:
Name |
Type |
Summary |
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) id |
id |
title |
string title |
title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) id |
id |
name |
string title |
title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) id |
id |
name |
string title |
title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
data |
array of (DataItem)
|
data |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) id |
id |
name |
string name |
name |
Summary:
Description:
Properties:
Name |
Type |
Summary |
data |
array of (StageResponse)
|
data |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer(int32) Stage Id |
Stage Id |
name |
string Stage Name |
Stage name |
Summary:
Description:
Properties:
Name |
Type |
Summary |
stage_id |
string Stage Id |
Stage of the deal. Values: [Lead In, Contact Made, Demo Scheduled, Proposal Made, Negotiations Started] |
expected_close_date |
string Expected Close Date |
yyyy-MM-dd |
Summary:
Description:
Properties:
Name |
Type |
Summary |
pipeline_id |
string Pipeline Id |
The id of the pipeline to fetch stages from. |
stage_id |
string Stage Id |
Stage of the deal. |
expected_close_date |
string Expected Close Date |
yyyy-MM-dd |
Summary:
Description:
Properties:
Name |
Type |
Summary |
status |
string Status |
Status of the deal. Values: [open, won, lost, deleted] |
lost_reason |
string Lost Reason |
Message about why the deal was lost. |