Connecting to Copper

Using API Key Authentication

To authenticate with Copper, you need to obtain an API key from your Copper account. Copper uses API key authentication combined with your user email address.

To generate an API key:

1. Log into your Copper CRM web application
2. Navigate to Settings > Integrations > API Keys
3. Click the 'Generate API Key' button
4. Label the key for its intended purpose
5. Copy the generated API key

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Copper API key obtained from the Copper web application.
• UserEmail: Set this to the email address of the API key owner (your Copper account email).

Example connection string:

Profile=C:\profiles\Copper.apip;AuthScheme=APIKey;ProfileSettings='ApiKey=your_api_key;[email protected]';

Connection Properties

The following properties are available for configuration in the ProfileSettings connection string:

• APIKey: Your Copper API key (required)
• UserEmail: The email address of the API key owner (required)
• AuthScheme: The authentication scheme (APIKey or None)

Usage Examples

Account:

SELECT * FROM Account;

Activities:

SELECT * FROM Activities;

ActivityTypes:

SELECT * FROM ActivityTypes;

Companies:

SELECT * FROM Companies;

CompanyActivities:

SELECT * FROM CompanyActivities WHERE ParentId = '74393124' and ActivityTypes = '{\"id\": 2, \"category\": \"system\"}';

ConnectFields:

SELECT * FROM ConnectFields Where SourceEntityType  = 'people' and SourceId = '178040265';

ContactTypes:

SELECT * FROM ContactTypes;

CustomActivityTypes:

SELECT * FROM CustomActivityTypes;

CustomFields:

SELECT * FROM CustomFields;

CustomerSources:

SELECT * FROM CustomerSources;

FieldLayouts:

SELECT * FROM FieldLayouts WHERE EntityType = 'people';

FileAttachments:

SELECT * FROM FileAttachments WHERE EntityType = 'people' AND EntityId = '177976744';

FileAttachmentSignedS3URL:

SELECT * FROM FileAttachmentSignedS3URL WHERE EntityType = 'people' AND EntityId = '177976744';

LeadActivities:

SELECT * FROM LeadActivities Where ParentId='92555096' AND ActivityTypes = '{\"id\": 2, \"category\": \"system\"}';

Leads:

SELECT * FROM Leads;

LeadStatuses:

SELECT * FROM LeadStatuses;

LossReasons:

SELECT * FROM LossReasons;

Opportunities:

SELECT * FROM Opportunities;

People:

SELECT * FROM People;

PeopleActivities:

SELECT * FROM PeopleActivities Where ParentId='178040265' AND ActivityTypes = '{\"id\": 2, \"category\": \"system\"}';

Pipelines:

SELECT * FROM Pipelines;

PipelineStages:

SELECT * FROM PipelineStages;

PipelineStages:

SELECT * FROM PipelineStages WHERE PipelineId = '1126631';

Projects:

SELECT * FROM Projects;

RelatedItems:

SELECT * FROM RelatedItems;

Tags:

SELECT * FROM Tags;

Tasks:

SELECT * FROM Tasks;

Users:

SELECT * FROM Users;

Webhooks:

SELECT * FROM Webhooks;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your Copper API key.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT
UserEmail	The Email address of the API Key owner.