> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Copper with API Key – StackOne Hub

> Link a Copper account in the StackOne Hub using API Key. End-user guide to authorize the integration and start using Copper actions.

<Warning>API key generation requires Admin role on the Copper workspace. The Copper trial signup user is the workspace Admin by default.</Warning>

<section data-guide-section data-guide-scopes="">
  <h2>Generate an API Key</h2>

  <p>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.</p>

  <Steps>
    <Step title="Sign in to Copper">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in to your <a href="https://app.copper.com/" target="_blank" rel="noopener noreferrer">Copper account</a> with an Admin user.</p>
      </div>
    </Step>

    <Step title="Open System settings > API Keys">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Navigate to API key management.</p>

        <ul>
          <li>Click your profile / avatar in the top-right corner.</li>
          <li>Select <strong>Settings</strong> from the dropdown.</li>
          <li>In the left settings nav, click <strong>Integrations</strong> > <strong>API Keys</strong>.</li>
        </ul>
      </div>
    </Step>

    <Step title="Generate a new API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Create the API key for the StackOne integration.</p>

        <ul>
          <li>Click <strong>GENERATE API KEY</strong>.</li>
          <li>Give it a descriptive label (e.g. "stackone-integration").</li>
          <li>Copy the generated API key — it will only be displayed once.</li>
        </ul>
      </div>
    </Step>

    <Step title="Note the admin email">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>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.</p>

        <ul>
          <li>Use the same email you used to sign in to Copper when generating the key.</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Available Scopes</h2>

  <p>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.</p>

  <ul>
    <li>**`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".</li>
    <li><strong>No scope required</strong> — 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.</li>
  </ul>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Enable the Leads feature (grants the `leads` scope)</h2>

  <p>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.</p>

  <Steps>
    <Step title="Open Lead Management settings">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in as the workspace Admin and open the Lead Management settings page.</p>

        <ul>
          <li>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).</li>
          <li>Or — click your avatar > <strong>Settings</strong> > <strong>Lead Management</strong> in the left nav.</li>
        </ul>
      </div>
    </Step>

    <Step title="Toggle Leads on (grants `leads`)">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Click the <strong>Enable Leads</strong> 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.</p>
      </div>
    </Step>

    <Step title="Verify">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Reload Copper — a <strong>"Leads"</strong> 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.</p>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Trial usage</h2>

  <p>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.</p>

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

<div data-whitelabel-hide>
  <h2>Linking the Account from the Hub</h2>

  <Steps>
    <Step title="Navigate to the Hub">
      Use one of the three <a href="/guides/accounts-section#linking-accounts">Linking Account Methods</a> to access the Hub.
    </Step>

    <Step title="Fill out the fields">
      Fill out the following fields using details from your provider:

      <ul>
        <li><strong>API Key</strong></li>
        <li><strong>User Email</strong></li>
      </ul>
    </Step>

    <Step title="Connect">
      <ul>
        <li>Click <strong>Connect</strong></li>
        <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
        <li>Once authorization is successful, you will see a confirmation popup</li>
      </ul>
    </Step>
  </Steps>

  <p>If the account linking is successful, you will see the newly linked account in your <a href="/guides/accounts-section">Accounts</a> page.</p>
</div>