Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (
Help us improve Python packaging - Donate today!

BaseCRM Official API V2 library client for Python

Project Description

BaseCRM Official API V2 library client for Python


BaseCRM package can be installed either via pip or easy_install:

$ pip install --upgrade basecrm


$ easy_install --upgrade basecrm

You can install from the source code as well. First clone the repo and then execute:

$ python install

After installing, import basecrm package:

import basecrm


import basecrm

# Then we instantiate a client (as shown below)

Build a client

Using this api without authentication gives an error

client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')

Client Options

The following options are available while instantiating a client:

  • access_token: Personal access token
  • base_url: Base url for the api
  • user_agent: Default user-agent for all requests
  • timeout: Request timeout
  • verbose: Verbose/debug mode


The library follows few architectural principles you should understand before digging deeper. 1. Interactions with resources are done via service objects. 2. Service objects are exposed as properties on client instances. 3. Service objects expose resource-oriented actions. 4. Actions return dictionaries that support attribute-style access, a la JavaScript (thanks to Bunch and it’s form Munch).

For example, to interact with deals API you will use basecrm.DealsService, which you can get if you call:

client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>') # basecrm.DealsService

To retrieve list of resources and use filtering you will call #list method:

client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>'), hot=True) # list(dict|Munch)

To find a resource by it’s unique identifier use #retrieve method:

client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')

When you’d like to create a resource, or update it’s attributes you want to use either #create or #update methods. For example if you want to create a new deal you will call:

client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
deal ='Website redesign',

deal.value = 1000
deal.currency = 'USD', deal)

To destroy a resource use #destroy method:

client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')

There other non-CRUD operations supported as well. Please contact corresponding service files for in-depth documentation.

Full example

Create a new organization and after that change it’s attributes (website).

client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
lead = client.leads.create(organization_name='Design service company') = ''
client.leads.update(, lead)

Error handling

When you instantiate a client or make any request via service objects, exceptions can be raised for multiple of reasons e.g. a network error, an authentication error, an invalid param error etc.

Sample below shows how to properly handle exceptions:

    # Instantiate a client.
    client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
    lead = client.leads.create(organization_name='Design service company')
    print lead
except basecrm.ConfigurationError as e:
    #  Invalid client configuration option
except basecrm.ResourceError as e:
    # Resource related error
    print 'Http status = ' + e.http_status
    print 'Request ID = ' + e.logref
    for error in e.errors:
        print 'field = ' + error.field
        print 'code = ' + error.code
        print 'message = ' + error.message
        print 'details = ' + error.details
except basecrm.RequestError as e:
    # Invalid query parameters, authentication error etc.
except Exception as e:
    # Other kind of exceptioni, probably connectivity related

Resources and actions

Documentation for every action can be found in basecrm/ file.


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.accounts # => basecrm.AccountsService

Actions: * Retrieve account details - client.accounts.self


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.associated_contacts # => basecrm.AssociatedContactsService

Actions: * Retrieve deal’s associated contacts - client.associated_contacts.list * Create an associated contact - client.associated_contacts.create * Remove an associated contact - client.associated_contacts.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.contacts # => basecrm.ContactsService

Actions: * Retrieve all contacts - client.contacts.list * Create a contact - client.contacts.create * Retrieve a single contact - client.contacts.retrieve * Update a contact - client.contacts.update * Delete a contact - client.contacts.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>') # => basecrm.DealsService

Actions: * Retrieve all deals - * Create a deal - * Retrieve a single deal - * Update a deal - * Delete a deal -


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.leads # => basecrm.LeadsService

Actions: * Retrieve all leads - client.leads.list * Create a lead - client.leads.create * Retrieve a single lead - client.leads.retrieve * Update a lead - client.leads.update * Delete a lead - client.leads.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.loss_reasons # => basecrm.LossReasonsService

Actions: * Retrieve all reasons - client.loss_reasons.list * Create a loss reason - client.loss_reasons.create * Retrieve a single reason - client.loss_reasons.retrieve * Update a loss reason - client.loss_reasons.update * Delete a reason - client.loss_reasons.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.notes # => basecrm.NotesService

Actions: * Retrieve all notes - client.notes.list * Create a note - client.notes.create * Retrieve a single note - client.notes.retrieve * Update a note - client.notes.update * Delete a note - client.notes.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.pipelines # => basecrm.PipelinesService

Actions: * Retrieve all pipelines - client.pipelines.list


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.sources # => basecrm.SourcesService

Actions: * Retrieve all sources - client.sources.list * Create a source - client.sources.create * Retrieve a single source - client.sources.retrieve * Update a source - client.sources.update * Delete a source - client.sources.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.stages # => basecrm.StagesService

Actions: * Retrieve all stages - client.stages.list


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.tags # => basecrm.TagsService

Actions: * Retrieve all tags - client.tags.list * Create a tag - client.tags.create * Retrieve a single tag - client.tags.retrieve * Update a tag - client.tags.update * Delete a tag - client.tags.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.tasks # => basecrm.TasksService

Actions: * Retrieve all tasks - client.tasks.list * Create a task - client.tasks.create * Retrieve a single task - client.tasks.retrieve * Update a task - client.tasks.update * Delete a task - client.tasks.destroy


client = basecrm.Client(access_token='<YOUR_PERSONAL_ACCESS_TOKEN>')
client.users # => basecrm.UsersService

Actions: * Retrieve all users - client.users.list * Retrieve a single user - client.users.retrieve * Retrieve an authenticating user - client.users.self


To run all test suites:

$ python test

And to run a single suite:

$ python test -s basecrm.test.test_associated_contacts_service.AssociatedContactsServiceTests


We would like to give huge thanks to YunoJuno. They reqlinquished the package name so we were able to publish official wrapper under basecrm name.

Thank You!



Bug Reports

Report here.


BaseCRM developers (

Release History

Release History

This version
History Node


Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting