Search API Connector Documentation

Print

Import Copper CRM Data to Google Sheets

In this guide, we’ll walk through how to pull data from the Copper CRM API directly into Google Sheets, using the API Connector add-on for Sheets. We’ll first get an API key from Copper CRM, and then set up a request to pull in data to your spreadsheet.

CONTENTS

BEFORE YOU BEGIN

Click here to install the API Connector add-on from the Google Marketplace.

PART 1: GET YOUR COPPER CRM API KEY

A prerequisite for using the Copper CRM API is having a registered account on the official website. Go to this page and register.

After that go to your profile -> click on Settings -> API keys -> generate API key to create your personal API key that you will need for running requests!

PART 2: CREATE YOUR API REQUEST URL

For creating API requests we will use some examples provided in the official documentation.

  • API root: https://api.prosperworks.com/developer_api/v1/
  • Different APIs:
    • account
    • users
    • leads
    • people
    • companies
    • opportunities
    • projects
    • tasks
    • activities
    • webhooks
  • Example endpoint:
    • search

Combining all together, API link should look like this:

https://api.copper.com/developer_api/v1/{api_option}/search

PART 3: PULL COPPER CRM API DATA INTO GOOGLE SHEETS

In this example, we will first create a new person in a company, and then we will list all people in a company.

Creating a new person

  1. Open up Google Sheets and click Add-ons > API Connector > Open.
  2. In the Create tab, set the method to be POST, and enter the API URL constructed like this:
https://api.copper.com/developer_api/v1/people

3. Now enter the following headers:

  • X-PW-AccessToken – YOUR API KEY
  • X-PW-Application – developer_api
  • X-PW-UserEmail – email that you used for registering an account
  • Content-Type – application/json

4. Fill the POST body with following JSON (please note: this is an example, feel free to modify it according to your needs)

{
  "name":"My Contact",
  "emails": [
    {
    "email":"mycontact_1233@noemail.com",
    "category":"work"
    }
  ],
  "address": {
    "street": "123 Main Street",
    "city": "Savannah",
    "state": "Georgia",
    "postal_code": "31410",
    "country": "United States"
  },
  "phone_numbers": [
    {
    "number":"415-123-45678",
    "category":"mobile"
    }
  ]
}

5. Now create a new tab, give it a name and click Set current to use that tab as your data destination.

6. Give a name to your request and click run!

7. Now the pulled data will appear on the sheets as well!

8. Navigate yourself on your company’s dashboard, click on People section, and you will see the created person there!

Now let’s pull all people from a company to sheets!

  1. Open up Google Sheets and click Add-ons > API Connector > Open.
  2. In the Create tab, set the method to be POST, enter the headers and the API URL constructed like this:
https://api.copper.com/developer_api/v1/people/search

3. Set the destination sheets as described above.

4. Under POST body, enter { "page_size": 25, "sort_by": "name" }

5. Name your request and run it! You will see now all the people from the company, including the person we created before!

PART 4: MORE API EXAMPLES

In this section, we will provide some API example requests from the official documentation.

  • Fetch Account Details:
GET https://api.copper.com/developer_api/v1/account
  • Fetch details about a specific user within a company:
GET https://api.copper.com/developer_api/v1/users/{{user_id}}
  • Search list of users within a company:
POST https://api.copper.com/developer_api/v1/users/search
  • Featch a lead by ID (individual or a company that is interested in your products or services)
GET https://api.copper.com/developer_api/v1/leads/{{lead_id}}
  • List a lead’s activities:
POST https://api.copper.com/developer_api/v1/leads/{{lead_id}}/activities
  • Fetch a person (an individual with whom you communicate) by ID:
GET https://api.copper.com/developer_api/v1/people/{{person_id}}

Previous Import Constant Contact Data to Google Sheets
Next Import Crunchbase Data to Google Sheets

Leave a Comment

Table of Contents