API Data Provider - Online Help

Connecting to Copper

The Copper API uses API Key authentication.

Using API Keys

In order to authenticate to the Copper API, you will need to generate an API token. To generate this API token, in the Copper web app, navigate to 'System Settings' > 'API Keys' and click the Create a Key button. Once created, you will need to set the APIKey profile setting to your token, and the UserEmail profile setting to the email address associated with your Copper account.

Example connection string

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

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.
UserEmail The Email address of the API Key owner.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0