Pipedrive¶
-
class
pipedrive.
Pipedrive
(api_token)¶ Create a Pipedrive service.
Variables: api_token (str) – The API token
Activities¶
-
Pipedrive.
activities
()¶ Return the resource corresponding to all activities
-
Activities.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Activities.
delete
(ids)¶ Marks multiple activities as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Activities
-
Activities.
get
(user_id=None, start=None, limit=None, start_date=None, end_date=None)¶ Returns all activities assigned to a particular user
Upstream documentation: https://developers.pipedrive.com/v1#methods-Activities
-
Activities.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Activity¶
-
Pipedrive.
activity
(activity_id)¶ Return the resource corresponding to a single activity
Variables: activity_id (str) – The activity id
-
Activity.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Activity.
delete
()¶ Delete this resource.
-
Activity.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Activity.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
ActivityType¶
-
Pipedrive.
activity_type
(type_id)¶ Return the resource corresponding to a single activity type
Variables: type_id (str) – The activity type id
-
ActivityType.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
ActivityType.
delete
()¶ Delete this resource.
-
ActivityType.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
ActivityType.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
ActivityTypes¶
-
Pipedrive.
activity_types
()¶ Return the resource corresponding to all activity types
-
ActivityTypes.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
ActivityTypes.
delete
(ids)¶ Marks multiple activities as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Activities
-
ActivityTypes.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
ActivityTypes.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Authorizations¶
Return the resource corresponding to the user authorizations
-
Authorizations.
get
(email, password)¶ Returns all authorizations for a particular user. Authorization objects contain the API tokens the user has with different company accounts in Pipedrive.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Authorizations
Filter¶
-
Pipedrive.
condition_filter
(filter_id)¶ Return the resource corresponding to a single filter
Variables: filter_id (str) – The filter id
-
Filter.
delete
()¶ Delete this resource.
-
Filter.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Filters¶
-
Pipedrive.
condition_filters
()¶ Return the resource corresponding to all filters
-
Filters.
delete
(ids)¶ Marks multiple filters as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Filters
-
Filters.
get
(type=None)¶ Returns all filters.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Filters
Currencies¶
-
Pipedrive.
currencies
()¶ Return the resource corresponding to the deals currencies
-
Currencies.
get
(term=None)¶ Returns all supported currencies which should be used when saving monetary values with other objects. The ‘code’ parameter of the returning objects is the currency code according to ISO 4217.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Currencies
Deal¶
-
Pipedrive.
deal
(deal_id)¶ Return the resource corresponding to a single deal
Variables: deal_id (str) – The deal id
Products¶
-
Deal.
products
()¶ Returns the resource corresponding to the deal products
-
Products.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Products.
delete
(product_attachment_id)¶ Deletes a product attachment from a deal, using the product_attachment_id.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Products.
get
(start=None, limit=None)¶ Lists products attached to a deal.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Products.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Deal.
activities
(start=None, limit=None, done=None, exclude=None)¶ Lists activities associated with a deal.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deal.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Deal.
delete
()¶ Delete this resource.
-
Deal.
files
(start=None, limit=None)¶ Lists files associated with a deal.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deal.
followers
()¶ Lists the followers of a deal.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deal.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Deal.
participants
(start=None, limit=None)¶ Lists participants associated with a deal.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deal.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Deal.
updates
(start=None, limit=None)¶ Lists updates about a deal.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
DealField¶
-
Pipedrive.
deal_field
(field_id)¶ Return the resource corresponding to a single deal field
Variables: field_id (str) – The deal field id
-
DealField.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
DealField.
delete
()¶ Delete this resource.
-
DealField.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
DealFields¶
-
Pipedrive.
deal_fields
()¶ Return the resource corresponding to all deal fields
-
DealFields.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
DealFields.
delete
(ids)¶ Marks multiple activities as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-DealFields
-
DealFields.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Deals¶
-
Pipedrive.
deals
()¶ Return the resource corresponding to all deals
-
Deals.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Deals.
delete
(ids)¶ Marks multiple deals as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deals.
find
(term)¶ Searches all deals by their title.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deals.
get
(filter_id=None, start=None, limit=None, sort_by=None, sort_mode=None, owned_by_you=None)¶ Returns all deals
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deals.
timeline
(start_date, interval, amount, field_key, user_id=None, pipeline_id=None, filter_id=None)¶ Returns open and won deals, grouped by defined interval of time set in a date-type dealField (field_key) - e.g. when month is the chosen interval, and 3 months are asked starting from January 1st, 2012, deals are returned grouped into 3 groups - January, February and March - based on the value of the given field_key.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Deals
-
Deals.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
File¶
-
Pipedrive.
file
(file_id)¶ Return the resource corresponding to a single file
Variables: file_id (str) – The file id
-
File.
delete
()¶ Delete this resource.
-
File.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
File.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Files¶
-
Pipedrive.
files
()¶ Return the resource corresponding to all files
-
Files.
delete
()¶ Delete this resource.
-
Files.
get
(start=None, limit=None)¶ Returns data about all files.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Files
-
Files.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Goal¶
-
Pipedrive.
goal
(goal_id)¶ Return the resource corresponding to a single goal
Variables: goal_id (str) – The goal id
-
Goal.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Goal.
delete
()¶ Delete this resource.
-
Goal.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Goal.
results
(period_start=None, period_end=None)¶ Lists results of a specific goal.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Goals
-
Goal.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Goals¶
-
Pipedrive.
goals
()¶ Return the resource corresponding to all goals
-
Goals.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Goals.
delete
()¶ Delete this resource.
-
Goals.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Goals.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Note¶
-
Pipedrive.
note
(note_id)¶ Return the resource corresponding to a single note
Variables: note_id (str) – The note id
-
Note.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Note.
delete
()¶ Delete this resource.
-
Note.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Note.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Notes¶
-
Pipedrive.
notes
()¶ Return the resource corresponding to all notes
-
Notes.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Notes.
delete
()¶ Delete this resource.
-
Notes.
get
(user_id=None, deal_id=None, person_id=None, org_id=None, start=None, limit=None, sort_by=None, sort_mode=None, start_date=None, end_date=None)¶ Returns all notes.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Notes
-
Notes.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Organization¶
-
Pipedrive.
organization
(organization_id)¶ Return the resource corresponding to a single organization
Variables: organization_id (str) – The organization id
-
Organization.
activities
(start=None, limit=None, done=None, exclude=None)¶ Lists activities associated with an organization.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organization.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Organization.
deals
(start=None, limit=None)¶ Lists deals associated with an organization.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organization.
delete
()¶ Delete this resource.
-
Organization.
files
(start=None, limit=None)¶ Lists files associated with an organization.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organization.
followers
()¶ Lists the followers of an organization.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organization.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Organization.
merge
(merge_with_id)¶ Merges an organization with another organization.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organization.
persons
(start=None, limit=None)¶ Lists the persons of an organization.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organization.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Organization.
updates
(start=None, limit=None)¶ Lists updates about an organization.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
OrganizationField¶
-
Pipedrive.
organization_field
(field_id)¶ Return the resource corresponding to a single organization field
Variables: field_id (str) – The organization field id
-
OrganizationField.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
OrganizationField.
delete
()¶ Delete this resource.
-
OrganizationField.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
OrganizationFields¶
-
Pipedrive.
organization_fields
()¶ Return the resource corresponding to all organization fields
-
OrganizationFields.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
OrganizationFields.
delete
(ids)¶ Marks multiple activities as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-OrganizationFields
-
OrganizationFields.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Organizations¶
-
Pipedrive.
organizations
()¶ Return the resource corresponding to all organizations
-
Organizations.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Organizations.
delete
(ids)¶ Marks multiple organizations as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organizations.
find
(term, start=None, limit=None)¶ Searches all organizations by their name.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organizations.
get
(filter_id=None, start=None, limit=None, sort_by=None, sort_mode=None)¶ Returns all organizations
Upstream documentation: https://developers.pipedrive.com/v1#methods-Organizations
-
Organizations.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Person¶
-
Pipedrive.
person
(person_id)¶ Return the resource corresponding to a single person
Variables: person_id (str) – The person id
-
Person.
activities
(start=None, limit=None, done=None, exclude=None)¶ Lists activities associated with a person.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Person.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Person.
deals
(start=None, limit=None)¶ Lists deals associated with a person.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Person.
delete
()¶ Delete this resource.
-
Person.
files
(start=None, limit=None)¶ Lists files associated with a person.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Person.
followers
()¶ Lists the followers of a person.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Person.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Person.
merge
(merge_with_id)¶ Merges a person with another person.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Person.
products
(start=None, limit=None)¶ Lists the products of a person.
Upstream documentation: https://developers.pipedrive.com/v1#methods-products
-
Person.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Person.
updates
(start=None, limit=None)¶ Lists updates about a person.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
PersonField¶
-
Pipedrive.
person_field
(field_id)¶ Return the resource corresponding to a single person field
Variables: field_id (str) – The person field id
-
PersonField.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
PersonField.
delete
()¶ Delete this resource.
-
PersonField.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
PersonFields¶
-
Pipedrive.
person_fields
()¶ Return the resource corresponding to all person fields
-
PersonFields.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
PersonFields.
delete
(ids)¶ Marks multiple activities as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-PersonFields
-
PersonFields.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Persons¶
-
Pipedrive.
persons
()¶ Return the resource corresponding to all persons
-
Persons.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Persons.
delete
(ids)¶ Marks multiple persons as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Persons.
find
(term, org_id=None, start=None, limit=None)¶ Searches all persons by their name.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Persons.
get
(filter_id=None, start=None, limit=None, sort_by=None, sort_mode=None)¶ Returns all persons
Upstream documentation: https://developers.pipedrive.com/v1#methods-Persons
-
Persons.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Pipeline¶
-
Pipedrive.
pipeline
(pipeline_id)¶ Return the resource corresponding to a single pipeline
Variables: pipeline_id (str) – The pipeline id
-
Pipeline.
conversion_rates
(start_date, end_date, user_id=None)¶ Returns all stage-to-stage conversion and pipeline-to-close rates for given time period.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Pipelines
-
Pipeline.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Pipeline.
deals
(filter_id=None, user_id=None, everyone=None, stage_id=None, start=None, limit=None)¶ Lists deals in a specific pipeline across all its stages.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Pipelines
-
Pipeline.
delete
()¶ Delete this resource.
-
Pipeline.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Pipeline.
movements
(start_date, end_date, user_id=None)¶ Returns statistics for deals movements for given time period.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Pipelines
-
Pipeline.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Pipelines¶
-
Pipedrive.
pipelines
()¶ Return the resource corresponding to all pipelines
-
Pipelines.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Pipelines.
delete
()¶ Delete this resource.
-
Pipelines.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Pipelines.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Product¶
-
Pipedrive.
product
(product_id)¶ Return the resource corresponding to a single product
Variables: product_id (str) – The product id
-
Product.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Product.
deals
(start=None, limit=None)¶ Returns data about a deals that have a product attached to.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Products
-
Product.
delete
()¶ Delete this resource.
-
Product.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Product.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
ProductField¶
-
Pipedrive.
product_field
(field_id)¶ Return the resource corresponding to a single product field
Variables: field_id (str) – The product field id
-
ProductField.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
ProductField.
delete
()¶ Delete this resource.
-
ProductField.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
ProductFields¶
-
Pipedrive.
product_fields
()¶ Return the resource corresponding to all product fields
-
ProductFields.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
ProductFields.
delete
(ids)¶ Marks multiple activities as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-ProductFields
-
ProductFields.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Products¶
-
Pipedrive.
products
()¶ Return the resource corresponding to all products
-
Products.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Products.
delete
()¶ Delete this resource.
-
Products.
find
(term, currency=None, start=None, limit=None)¶ Returns data about the products that were found. If currency was set in request, prices in that currency are served back.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Products
-
Products.
get
(start=None, limit=None)¶ Returns all products
Upstream documentation: https://developers.pipedrive.com/v1#methods-Products
-
Products.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Stage¶
-
Pipedrive.
stage
(stage_id)¶ Return the resource corresponding to a single stage
Variables: stage_id (str) – The stage id
-
Stage.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Stage.
deals
(filter_id=None, user_id=None, everyone=None, start=None, limit=None)¶ Lists deals in a specific stage
Upstream documentation: https://developers.pipedrive.com/v1#methods-Stages
-
Stage.
delete
()¶ Delete this resource.
-
Stage.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
Stage.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
Stages¶
-
Pipedrive.
stages
()¶ Return the resource corresponding to all stages
-
Stages.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Stages.
delete
(ids)¶ Marks multiple stages as deleted.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Stages
-
Stages.
get
(pipeline_id=None)¶ Returns data about all stages
Upstream documentation: https://developers.pipedrive.com/v1#methods-Stages
-
Stages.
update
(obj)¶ Update this resource.
Variables: obj – a Python object representing the updated resource, usually in the same format as returned from get. Refer to the upstream documentation for details.
User¶
-
Pipedrive.
user
(user_id)¶ Return the resource corresponding to a single user
Variables: user_id (str) – The user id
-
User.
activities
(start=None, limit=None, done=None, exclude=None)¶ Lists activities associated with a user.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Users
-
User.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
User.
followers
()¶ Lists the followers of a user.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Users
-
User.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
-
User.
merge
(merge_with_id)¶ Merges a user with another user.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Users
-
User.
updates
(start=None, limit=None)¶ Lists updates about a user.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Users
UserConnections¶
-
Pipedrive.
user_connections
()¶ Return the resource corresponding to the user connections
-
UserConnections.
get
()¶ Returns data about all connections for the authorized user.
Upstream documentation: https://developers.pipedrive.com/v1#methods-UserConnections
Users¶
-
Pipedrive.
users
()¶ Return the resource corresponding to all users
-
Users.
create
(obj)¶ Create a new resource.
Variables: obj – a Python object representing the resource to be created, usually in the same format as returned from get. Refer to the upstream documentation for details.
-
Users.
find
(term)¶ Searches all users by their name.
Upstream documentation: https://developers.pipedrive.com/v1#methods-Users
-
Users.
get
()¶ For single-object resources, fetch the object’s data. For collections, fetch all of the objects.
Service methods¶
-
Pipedrive.
search
(term, start=None, limit=None)¶ Performs a search across the account and returns SearchResults.
Upstream documentation: https://developers.pipedrive.com/v1#methods-SearchResults
-
Pipedrive.
settings
()¶ Lists settings of authorized user.
Upstream documentation: https://developers.pipedrive.com/v1#methods-UserSettings