Skip to main content
API key generation requires Admin role on the Copper workspace. The Copper trial signup user is the workspace Admin by default.

​
Generate an API Key

To connect Copper with StackOne you’ll need an API key from your Copper account. Copper’s API uses three custom headers (X-PW-AccessToken, X-PW-Application, X-PW-UserEmail) — you’ll need to provide both the API key value AND the email of the admin user that generated it.

1

Sign in to Copper

Sign in to your Copper account with an Admin user.

2

Open System settings > API Keys

Navigate to API key management.

  • Click your profile / avatar in the top-right corner.
  • Select Settings from the dropdown.
  • In the left settings nav, click Integrations > API Keys.
3

Generate a new API Key

Create the API key for the StackOne integration.

  • Click GENERATE API KEY.
  • Give it a descriptive label (e.g. “stackone-integration”).
  • Copy the generated API key — it will only be displayed once.
4

Note the admin email

The email address of the admin user that generated the key is required as a separate field. Copper validates every request against the {key, email} pair.

  • Use the same email you used to sign in to Copper when generating the key.

​
Available Scopes

Copper’s API key auth has no OAuth scopes. The connector models the one real feature-level permission Copper enforces — the Leads module toggle — as the leads scope. Every other resource (People, Companies, Opportunities, Projects, Tasks, Activities, Tags, Related Items, Custom Field Definitions, Account & Users) is universally available to any valid API key and does not need its own scope.

  • leads — Required by every Lead action (list_leads, fetch_lead_by_id, create_lead, update_lead, delete_lead, upsert_lead, convert_lead, list_lead_activities, list_lead_statuses). Granted by enabling the Leads feature module in Copper workspace settings — see “Enable the Leads feature” step below. Without it every lead endpoint returns HTTP 403 “Feature not enabled”.
  • No scope required — All other resources (People, Companies, Opportunities, Projects, Tasks, Activities, Tags, Related Items, Custom Field Definitions, Account & Users) work with any valid Admin-generated API key. Copper does not expose per-resource read/write toggles for these.

​
Enable the Leads feature (grants the leads scope)

Lead-related actions require the Leads module to be turned on. New Copper workspaces — including 14-day trials — ship with Leads disabled by default and every lead endpoint returns HTTP 403 “Feature not enabled” until you flip the toggle. This step grants the leads scope to the API key.

1

Open Lead Management settings

Sign in as the workspace Admin and open the Lead Management settings page.

  • Direct URL — https://app.copper.com/companies/{COMPANY_ID}/app#/settings/lead-management (replace {COMPANY_ID} with the numeric workspace ID in your Copper URL bar).
  • Or — click your avatar > Settings > Lead Management in the left nav.
2

Toggle Leads on (grants `leads`)

Click the Enable Leads switch so it shows ON. The change takes ~30 seconds to propagate through Copper’s API. This grants the leads scope to your API key — every lead-related StackOne action requires it.

3

Verify

Reload Copper — a “Leads” tab should now appear in the main left navigation. Once the tab is visible the leads scope is granted and lead-related StackOne actions will work.

​
Trial usage

Copper offers a 14-day free trial with full Business-tier features including API access. After 14 days you’ll need a Professional or Business plan to keep using the API.

  • Sign up at https://www.copper.com/signup — no credit card required for the trial.
  • Trial signup user is the workspace Admin automatically.
  • The trial includes Leads at the Business tier, but the Leads feature toggle still needs to be turned on manually per the steps above.

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • API Key
  • User Email
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.