Pipedrive API wrapper for Pypedrive written in Python.
pip install pipedrive-python-lib
- If you are not going to use the authentication flow, just send the "pipedrive company domain" and instance the library like this:
from pipedrive.client import Client
client = Client(api_base_url='https://companydomain.pipedrive.com/')
- If on the contrary you will use it, send the "pipedrive company domain", the "client_id", the "client secret" and the parameter "oauth=True" in the main instance like this:
from pipedrive.client import Client
client = Client(api_base_url='https://companydomain.pipedrive.com/', 'CLIENT_ID', 'CLIENT_SECRET', oauth=True)
And to make requests send the access token
client.set_token(access_token)
url = client.get_oauth_uri("REDIRECT_URL", "OPTIONAL - state")
token = client.exchange_code('REDIRECT_URL', 'CODE')
token = client.refresh_token('REFRESH TOKEN')
token = client.get_recent_changes(since_timestamp="YYYY-MM-DD HH:MM:SS")
Deals section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Deals
If you need a specific deal send the deal id, if you don't just call the method
get_specific_deal = client.get_deals(deal_id="")
get_deals = client.get_deals()
create_deal = client.create_deal(title="")
update_deal = client.update_deal(deal_id="")
delete_deal = client.delete_deal(deal_id="")
duplicate_deal = client.duplicate_deal(deal_id="")
details_deal = client.get_deal_details(deal_id="")
find_deal = client.get_deals_by_name(term="")
followers_deal = client.get_deal_followers(deal_id="")
add_follower_deal = client.add_follower_to_deal(deal_id="", user_id="")
delete_followers_deal = client.delete_follower_to_deal(deal_id="", follower_id="")
get_participants_deal = client.get_deal_participants(deal_id="")
add_participants_deal = client.add_participants_to_deal(deal_id="", person_id="")
delete_participants_deal = client.delete_participant_to_deal(deal_id="", participant_id="")
get_activities_deal = client.get_deal_activities(deal_id="")
get_messages_deal = client.get_deal_mail_messages(deal_id="")
get_products_deal = client.get_deal_products(deal_id="")
Notes section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Notes
If you need a specific note send the note id, if you don't just call the method
get_specific_note = client.get_notes(note_id="")
get_notes = client.get_notes()
add_note = client.create_note(content="", org_id="")
update_note = client.update_note(note_id="", content="")
delete_note = client.delete_note(note_id="")
Organizations section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Organizations
If you need a specific organization send the organization id, if you don't just call the method
get_specific_organization = client.get_organizations(org_id="")
get_organizations = client.get_organizations()
add_organization = client.create_organization(name="")
update_organization = client.update_organization(data_id="", name="")
delete_organization = client.delete_organization(data_id="")
Persons section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Persons
If you need the details of a person send the person id, if you don't just call the method
get_details_person = client.get_persons(person_id="")
get_persons = client.get_persons()
find_persons = client.get_persons_by_name(term="")
add_persons = client.create_person(name="")
update_persons = client.update_person(data_id="", name="")
delete_persons = client.delete_person(data_id="")
get_persons_deals = client.get_person_deals(person_id="")
Products section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Products
If you need a specific product send the product id, if you don't just call the method
get_specific_product = client.get_products(product_id="")
get_products = client.get_products()
find_product = client.get_product_by_name(term="")
add_product = client.create_product(name="")
update_product = client.update_product(product_id="", name="")
delete_product = client.delete_product(product_id="")
get_product_deal = client.get_product_deal(product_id="")
Activities section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Activities
If you need the activity details send the activity id, if you don't just call the method
get_details_activity = client.get_activities(activity_id="")
get_activities = client.get_activities()
add_activity = client.create_activity(subject="", type="")
edit_activity = client.update_activity(activity_id="")
delete_activity = client.delete_activity(activity_id="")
Webhook section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Webhooks
get_hooks = client.get_hooks_subscription()
add_hook = client.create_hook_subscription(subscription_url="", event_action="", event_object="")
delete_hooks = client.delete_hook_subscription(hook_id="")
Users section, see the api documentation: https://developers.pipedrive.com/docs/api/v1/#!/Users
users = client.get_users(user_id="")
- requests
We are always grateful for any kind of contribution including but not limited to bug reports, code enhancements, bug fixes, and even functionality suggestions.
You can report any bug you find or suggest new functionality with a new issue.
- Fork it ( https://github.com/GearPlug/pipedrive-python )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Adds my new feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request