Skip to content

Latest commit

 

History

History
65 lines (45 loc) · 1.6 KB

copper.rst

File metadata and controls

65 lines (45 loc) · 1.6 KB

Copper

Overview

Copper is a customer relationship management (CRM) platform to track individuals, companies and activity data. This Parsons class provides methods for extracting people, companies and actions.

Note

Getting Your API Key
  • Sign into Copper
  • Click on Settings (gear icon) and then API Keys
  • Click the GENERATE API KEY button

Quickstart

To instantiate the Copper class, you can either store the Copper user email and API key as environmental variables (COPPER_USER_EMAIL, COPPER_API_KEY) or pass them in as arguments:

from parsons import Copper

# First approach: Use API key and user email via environmental variables
copper = Copper()

# Second approach: Pass API credentials and user email as arguments
copper = Copper(user_email='[email protected]', api_key='MYAPIKEY')

You can then call various endpoints:

# Get people

# This will unpack the people json as a dict of Parsons Tables.
people_tbls = copper.get_people()

# You can then save the tables as csvs
for k, v in people_tbls.items():
        v.to_csv(f'{k}_copper.csv')

# Or you send the tables to a database
pg = Postgres()
for k, v in people_tbls.items():
        v.to_postgres(f'copper.{k}', if_exists='drop')

# Get companies

# Get companies modified since a date, unix time. This will unpack the companies
json as a dict of Parsons Tables.
company_tbls = copper.get_companies({'minimum_modified_date': 1599674523})

API

.. autoclass :: parsons.Copper
   :inherited-members: