Skip to content

PipedriveClient

Attributes

TrigNewActivityResponse module-attribute 

TrigNewActivityResponse = List['ActivityResponse']

TrigNewDealResponse module-attribute 

TrigNewDealResponse = List['DealResponseV2']

TRIGGER_OPERATIONS module-attribute 

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'TrigNewActivity': {'operation_id': 'TrigNewActivity', 'path': '/{connectionId}/trigger/v1/activities', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TrigNewActivityResponse'}, 'TrigNewDealV2': {'operation_id': 'TrigNewDealV2', 'path': '/{connectionId}/connector-v2/trigger/v1/deals', 'method': 'get', 'required_parameters': [], 'callback_payload_type': 'TrigNewDealResponse'}}

Classes

DealResponse dataclass 

DealResponse(id: Optional[int] = None, creator_user_id: Optional[Dict[str, Any]] = None, user_id: Optional[Dict[str, Any]] = None, person_id: Optional[Dict[str, Any]] = None, org_id: Optional[Dict[str, Any]] = None, status: Optional[str] = None, title: Optional[str] = None, value: Optional[float] = None, currency: Optional[str] = None, add_time: Optional[str] = None, update_time: Optional[str] = None, stage_id: Optional[int] = None, stage_name: Optional[str] = None, stage_change_time: Optional[str] = None, active: Optional[bool] = None, deleted: Optional[bool] = None, next_activity_date: Optional[str] = None, next_activity_time: Optional[str] = None, next_activity_id: Optional[int] = None, last_activity_id: Optional[int] = None, last_activity_date: Optional[str] = None, lost_reason: Optional[str] = None, visible_to: Optional[str] = None, close_time: Optional[str] = None, pipeline_id: Optional[int] = None, products_count: Optional[int] = None, files_count: Optional[int] = None, notes_count: Optional[int] = None, followers_count: Optional[int] = None, email_messages_count: Optional[int] = None, activities_count: Optional[int] = None, done_activities_count: Optional[int] = None, undone_activities_count: Optional[int] = None, reference_activities_count: Optional[int] = None, participants_count: Optional[int] = None, expected_close_date: Optional[str] = None, next_activity_subject: Optional[str] = None, next_activity_type: Optional[str] = None, next_activity_duration: Optional[str] = None, next_activity_note: Optional[str] = None)

Response for Get deal by id

Attributes

id class-attribute instance-attribute 
id: Optional[int] = None

Id of the deal.

status class-attribute instance-attribute 
status: Optional[str] = None

Open, won, lost or deleted.

title class-attribute instance-attribute 
title: Optional[str] = None

Title of the deal.

value class-attribute instance-attribute 
value: Optional[float] = None

Monetary value of the deal.

currency class-attribute instance-attribute 
currency: Optional[str] = None

Currency associated with the deal value.

add_time class-attribute instance-attribute 
add_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

update_time class-attribute instance-attribute 
update_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

stage_id class-attribute instance-attribute 
stage_id: Optional[int] = None

ID of stage the deal is placed in a pipeline.

stage_name class-attribute instance-attribute 
stage_name: Optional[str] = None

Name of stage the deal is placed in a pipeline

stage_change_time class-attribute instance-attribute 
stage_change_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

active class-attribute instance-attribute 
active: Optional[bool] = None

True if the deal is active.

deleted class-attribute instance-attribute 
deleted: Optional[bool] = None

True if the deal has been deleted.

next_activity_date class-attribute instance-attribute 
next_activity_date: Optional[str] = None

yyyy-MM-dd

next_activity_time class-attribute instance-attribute 
next_activity_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

next_activity_id class-attribute instance-attribute 
next_activity_id: Optional[int] = None

Id of the next activity.

last_activity_id class-attribute instance-attribute 
last_activity_id: Optional[int] = None

Id of the last activity.

last_activity_date class-attribute instance-attribute 
last_activity_date: Optional[str] = None

yyyy-MM-dd

lost_reason class-attribute instance-attribute 
lost_reason: Optional[str] = None

Message about why the deal was lost (to be used when status=lost).

visible_to class-attribute instance-attribute 
visible_to: Optional[str] = None

Owner, followers or entire company.

close_time class-attribute instance-attribute 
close_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

pipeline_id class-attribute instance-attribute 
pipeline_id: Optional[int] = None

Id of pipeline the deal is associated with.

products_count class-attribute instance-attribute 
products_count: Optional[int] = None

Number of products associated with the deal.

files_count class-attribute instance-attribute 
files_count: Optional[int] = None

Number of files associated with the deal.

notes_count class-attribute instance-attribute 
notes_count: Optional[int] = None

Number of notes associated with the deal.

followers_count class-attribute instance-attribute 
followers_count: Optional[int] = None

Number of followers associated with the deal.

email_messages_count class-attribute instance-attribute 
email_messages_count: Optional[int] = None

Number of email messages associated with the deal.

activities_count class-attribute instance-attribute 
activities_count: Optional[int] = None

Number of activities associated with the deal.

done_activities_count class-attribute instance-attribute 
done_activities_count: Optional[int] = None

Number of done activities associated with the deal.

undone_activities_count class-attribute instance-attribute 
undone_activities_count: Optional[int] = None

Number of undone activities associated with the deals.

reference_activities_count class-attribute instance-attribute 
reference_activities_count: Optional[int] = None

Number of referenced activities associated with the deal.

participants_count class-attribute instance-attribute 
participants_count: Optional[int] = None

Number of participants associated with the deal.

expected_close_date class-attribute instance-attribute 
expected_close_date: Optional[str] = None

yyyy-MM-dd

next_activity_subject class-attribute instance-attribute 
next_activity_subject: Optional[str] = None

Subject of next activity associated with the deal.

next_activity_type class-attribute instance-attribute 
next_activity_type: Optional[str] = None

Type of next activity associated with the deal.

next_activity_duration class-attribute instance-attribute 
next_activity_duration: Optional[str] = None

Duration of next activity associated with the deal.

next_activity_note class-attribute instance-attribute 
next_activity_note: Optional[str] = None

Notes for next activity associated with the deal

ActivityResponse dataclass 

ActivityResponse(id: Optional[int] = None, user_id: Optional[int] = None, done: Optional[bool] = None, type_: Optional[str] = None, due_date: Optional[str] = None, due_time: Optional[str] = None, duration: Optional[str] = None, subject: Optional[str] = None, deal_id: Optional[int] = None, deal_title: Optional[str] = None, org_id: Optional[int] = None, org_name: Optional[str] = None, person_id: Optional[int] = None, person_name: Optional[str] = None, add_time: Optional[str] = None, update_time: Optional[str] = None, marked_as_done_time: Optional[str] = None, gcal_event_id: Optional[str] = None, google_calendar_id: Optional[str] = None, note: Optional[str] = None, assigned_to_user_id: Optional[int] = None, created_by_user_id: Optional[int] = None, owner_name: Optional[str] = None)

Response for Add activity

Attributes

id class-attribute instance-attribute 
id: Optional[int] = None

Unique id of the activity.

user_id class-attribute instance-attribute 
user_id: Optional[int] = None

Id of the user whom the activity is assigned to.

done class-attribute instance-attribute 
done: Optional[bool] = None

0 = Not done, 1 = Done

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Type of the activity.

due_date class-attribute instance-attribute 
due_date: Optional[str] = None

YYYY-MM-DD

due_time class-attribute instance-attribute 
due_time: Optional[str] = None

HH:MM

duration class-attribute instance-attribute 
duration: Optional[str] = None

HH:MM

subject class-attribute instance-attribute 
subject: Optional[str] = None

Subject of the activity.

deal_id class-attribute instance-attribute 
deal_id: Optional[int] = None

Id of deal the activity is associated with.

deal_title class-attribute instance-attribute 
deal_title: Optional[str] = None

Title of deal the activity is associated with.

org_id class-attribute instance-attribute 
org_id: Optional[int] = None

Id of organization the activity is associated with.

org_name class-attribute instance-attribute 
org_name: Optional[str] = None

Name of organization the activity is associated with.

person_id class-attribute instance-attribute 
person_id: Optional[int] = None

Id of person the activity is associated with.

person_name class-attribute instance-attribute 
person_name: Optional[str] = None

Name of person the activity is associated with.

add_time class-attribute instance-attribute 
add_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

update_time class-attribute instance-attribute 
update_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

marked_as_done_time class-attribute instance-attribute 
marked_as_done_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

gcal_event_id class-attribute instance-attribute 
gcal_event_id: Optional[str] = None

Id of the google calendar event.

google_calendar_id class-attribute instance-attribute 
google_calendar_id: Optional[str] = None

Id of the google calendar.

note class-attribute instance-attribute 
note: Optional[str] = None

Note of the activity (HTML format).

assigned_to_user_id class-attribute instance-attribute 
assigned_to_user_id: Optional[int] = None

User id of user whom the activity is assigned to.

created_by_user_id class-attribute instance-attribute 
created_by_user_id: Optional[int] = None

User id of user that created the activity.

owner_name class-attribute instance-attribute 
owner_name: Optional[str] = None

Name of the activity owner.

StageResponse dataclass 

StageResponse(id: Optional[int] = None, name: Optional[str] = None)

Response for Get stage by id

Attributes

id class-attribute instance-attribute 
id: Optional[int] = None

Stage Id

name class-attribute instance-attribute 
name: Optional[str] = None

Stage name

DealResponseV2 dataclass 

DealResponseV2(id: Optional[int] = None, creator_user_id: Optional[Dict[str, Any]] = None, user_id: Optional[Dict[str, Any]] = None, person_id: Optional[Dict[str, Any]] = None, org_id: Optional[Dict[str, Any]] = None, status: Optional[str] = None, title: Optional[str] = None, value: Optional[float] = None, currency: Optional[str] = None, add_time: Optional[str] = None, update_time: Optional[str] = None, stage_id: Optional[int] = None, stage_change_time: Optional[str] = None, active: Optional[bool] = None, deleted: Optional[bool] = None, next_activity_date: Optional[str] = None, next_activity_time: Optional[str] = None, next_activity_id: Optional[int] = None, last_activity_id: Optional[int] = None, last_activity_date: Optional[str] = None, lost_reason: Optional[str] = None, visible_to: Optional[str] = None, close_time: Optional[str] = None, pipeline_id: Optional[int] = None, products_count: Optional[int] = None, files_count: Optional[int] = None, notes_count: Optional[int] = None, followers_count: Optional[int] = None, email_messages_count: Optional[int] = None, activities_count: Optional[int] = None, done_activities_count: Optional[int] = None, undone_activities_count: Optional[int] = None, reference_activities_count: Optional[int] = None, participants_count: Optional[int] = None, expected_close_date: Optional[str] = None, next_activity_subject: Optional[str] = None, next_activity_type: Optional[str] = None, next_activity_duration: Optional[str] = None, next_activity_note: Optional[str] = None)

Response for Add deal (V2)

Attributes

id class-attribute instance-attribute 
id: Optional[int] = None

Id of the deal.

status class-attribute instance-attribute 
status: Optional[str] = None

Open, won, lost or deleted.

title class-attribute instance-attribute 
title: Optional[str] = None

Title of the deal.

value class-attribute instance-attribute 
value: Optional[float] = None

Monetary value of the deal.

currency class-attribute instance-attribute 
currency: Optional[str] = None

Currency associated with the deal value.

add_time class-attribute instance-attribute 
add_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

update_time class-attribute instance-attribute 
update_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

stage_id class-attribute instance-attribute 
stage_id: Optional[int] = None

ID of stage the deal is placed in a pipeline.

stage_change_time class-attribute instance-attribute 
stage_change_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

active class-attribute instance-attribute 
active: Optional[bool] = None

True if the deal is active.

deleted class-attribute instance-attribute 
deleted: Optional[bool] = None

True if the deal has been deleted.

next_activity_date class-attribute instance-attribute 
next_activity_date: Optional[str] = None

yyyy-MM-dd

next_activity_time class-attribute instance-attribute 
next_activity_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

next_activity_id class-attribute instance-attribute 
next_activity_id: Optional[int] = None

Id of the next activity.

last_activity_id class-attribute instance-attribute 
last_activity_id: Optional[int] = None

Id of the last activity.

last_activity_date class-attribute instance-attribute 
last_activity_date: Optional[str] = None

yyyy-MM-dd

lost_reason class-attribute instance-attribute 
lost_reason: Optional[str] = None

Message about why the deal was lost (to be used when status=lost).

visible_to class-attribute instance-attribute 
visible_to: Optional[str] = None

Owner, followers or entire company.

close_time class-attribute instance-attribute 
close_time: Optional[str] = None

yyyy-MM-ddTHH:mm:ss.fffZ

pipeline_id class-attribute instance-attribute 
pipeline_id: Optional[int] = None

Id of pipeline the deal is associated with.

products_count class-attribute instance-attribute 
products_count: Optional[int] = None

Number of products associated with the deal.

files_count class-attribute instance-attribute 
files_count: Optional[int] = None

Number of files associated with the deal.

notes_count class-attribute instance-attribute 
notes_count: Optional[int] = None

Number of notes associated with the deal.

followers_count class-attribute instance-attribute 
followers_count: Optional[int] = None

Number of followers associated with the deal.

email_messages_count class-attribute instance-attribute 
email_messages_count: Optional[int] = None

Number of email messages associated with the deal.

activities_count class-attribute instance-attribute 
activities_count: Optional[int] = None

Number of activities associated with the deal.

done_activities_count class-attribute instance-attribute 
done_activities_count: Optional[int] = None

Number of done activities associated with the deal.

undone_activities_count class-attribute instance-attribute 
undone_activities_count: Optional[int] = None

Number of undone activities associated with the deals.

reference_activities_count class-attribute instance-attribute 
reference_activities_count: Optional[int] = None

Number of referenced activities associated with the deal.

participants_count class-attribute instance-attribute 
participants_count: Optional[int] = None

Number of participants associated with the deal.

expected_close_date class-attribute instance-attribute 
expected_close_date: Optional[str] = None

yyyy-MM-dd

next_activity_subject class-attribute instance-attribute 
next_activity_subject: Optional[str] = None

Subject of next activity associated with the deal.

next_activity_type class-attribute instance-attribute 
next_activity_type: Optional[str] = None

Type of next activity associated with the deal.

next_activity_duration class-attribute instance-attribute 
next_activity_duration: Optional[str] = None

Duration of next activity associated with the deal.

next_activity_note class-attribute instance-attribute 
next_activity_note: Optional[str] = None

Notes for next activity associated with the deal

ListDealsResponse dataclass 

ListDealsResponse(data: Optional[List[Dict[str, Any]]] = None)

Response for List deals

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

data

AddActivityRequest dataclass 

AddActivityRequest(type_: Optional[str] = None, subject: Optional[str] = None, due_date: Optional[str] = None, due_time: Optional[str] = None, duration: Optional[str] = None, note: Optional[str] = None, user_id: Optional[int] = None, deal_id: Optional[int] = None, person_id: Optional[int] = None, org_id: Optional[int] = None)

Definition: AddActivityRequest

Attributes

type_ class-attribute instance-attribute 
type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

Activity type.

subject class-attribute instance-attribute 
subject: Optional[str] = None

Subject of the activity.

due_date class-attribute instance-attribute 
due_date: Optional[str] = None

YYYY-MM-DD

due_time class-attribute instance-attribute 
due_time: Optional[str] = None

HH:MM

duration class-attribute instance-attribute 
duration: Optional[str] = None

HH:MM

user_id class-attribute instance-attribute 
user_id: Optional[int] = None

Id of the user whom the activity will be assigned to.

deal_id class-attribute instance-attribute 
deal_id: Optional[int] = None

ID of deal the activity will be associated with.

person_id class-attribute instance-attribute 
person_id: Optional[int] = None

Id of person the activity will be associated with.

org_id class-attribute instance-attribute 
org_id: Optional[int] = None

ID of the organization the activity will be associated with.

AddDealRequest dataclass 

AddDealRequest(title: Optional[str] = None, pipeline_id: Optional[str] = None, stage_id: Optional[str] = None, status: Optional[str] = None, value: Optional[int] = None, currency: Optional[str] = None, person_id: Optional[str] = None, org_id: Optional[str] = None, expected_close_date: Optional[str] = None, visible_to: Optional[str] = None)

Definition: AddDealRequest

Attributes

title class-attribute instance-attribute 
title: Optional[str] = None

Title of the deal.

pipeline_id class-attribute instance-attribute 
pipeline_id: Optional[str] = None

The id of the pipeline to fetch stages from.

stage_id class-attribute instance-attribute 
stage_id: Optional[str] = None

Stage of the deal.

status class-attribute instance-attribute 
status: Optional[str] = None

Status of the deal.

value class-attribute instance-attribute 
value: Optional[int] = None

Monetary value of the deal.

currency class-attribute instance-attribute 
currency: Optional[str] = None

Currency of the deal.

person_id class-attribute instance-attribute 
person_id: Optional[str] = None

User id of person the deal is associated with.

org_id class-attribute instance-attribute 
org_id: Optional[str] = None

Id of the organization associated with the deal.

expected_close_date class-attribute instance-attribute 
expected_close_date: Optional[str] = None

yyyy-MM-dd

visible_to class-attribute instance-attribute 
visible_to: Optional[str] = None

Owner, followers or entire company.

UpdateDealStageRequest dataclass 

UpdateDealStageRequest(pipeline_id: Optional[str] = None, stage_id: Optional[str] = None, expected_close_date: Optional[str] = None)

Definition: UpdateDealStageRequest

Attributes

pipeline_id class-attribute instance-attribute 
pipeline_id: Optional[str] = None

The id of the pipeline to fetch stages from.

stage_id class-attribute instance-attribute 
stage_id: Optional[str] = None

Stage of the deal.

expected_close_date class-attribute instance-attribute 
expected_close_date: Optional[str] = None

yyyy-MM-dd

UpdateDealStatusRequest dataclass 

UpdateDealStatusRequest(status: Optional[str] = None, lost_reason: Optional[str] = None)

Definition: UpdateDealStatusRequest

Attributes

status class-attribute instance-attribute 
status: Optional[str] = None

Status of the deal.

lost_reason class-attribute instance-attribute 
lost_reason: Optional[str] = None

Message about why the deal was lost.

ListActivityTypesResponse dataclass 

ListActivityTypesResponse(success: Optional[bool] = None, data: Optional[List[Dict[str, Any]]] = None)

Definition: ListActivityTypesResponse

Attributes

success class-attribute instance-attribute 
success: Optional[bool] = None

success

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

data

ListCurrenciesResponse dataclass 

ListCurrenciesResponse(data: Optional[List[Dict[str, Any]]] = None)

Definition: ListCurrenciesResponse

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

data

ListPipelinesResponse dataclass 

ListPipelinesResponse(data: Optional[List[Dict[str, Any]]] = None)

Definition: ListPipelinesResponse

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

data

ListStagesResponse dataclass 

ListStagesResponse(data: Optional[List[StageResponse]] = None)

Definition: ListStagesResponse

Attributes

data class-attribute instance-attribute 
data: Optional[List[StageResponse]] = None

data

ListPersonsResponse dataclass 

ListPersonsResponse(data: Optional[List[Dict[str, Any]]] = None)

Definition: ListPersonsResponse

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

data

ListOrganizationsResponse dataclass 

ListOrganizationsResponse(data: Optional[List[Dict[str, Any]]] = None)

Definition: ListOrganizationsResponse

Attributes

data class-attribute instance-attribute 
data: Optional[List[Dict[str, Any]]] = None

data

PipedriveClient 

PipedriveClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for pipedrive connector.

Initialize a PipedriveClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

get_deal_async async 
get_deal_async(deal_id: int) -> dict[str, Any] | None

Get deal by id

This operation retrieves all details of an existing deal, given its id.

update_deal_status_async async 
update_deal_status_async(input: UpdateDealStatusRequest, deal_id: int) -> dict[str, Any] | None

Update deal status

This operation is used to update the status associated with a deal, given its id.

add_activity_async async 
add_activity_async(input: AddActivityRequest) -> dict[str, Any] | None

Add activity

This operation is used to create a new activity for the authorized account.

get_stage_async async 
get_stage_async(stage_id: int) -> dict[str, Any] | None

Get stage by id

This operation returns data about a specific stage.

add_deal_async async 
add_deal_async(input: AddDealRequest) -> dict[str, Any] | None

Add deal

This operation creates a new deal for the authorized account.

update_deal_stage_async async 
update_deal_stage_async(input: UpdateDealStageRequest, deal_id: int) -> dict[str, Any] | None

Update deal stage

This operation is used to update the stage associated with a deal, given its id.

list_deals_async async 
list_deals_async() -> dict[str, Any] | None

List deals

List deals