> ## 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 BreatheHR with API Key – StackOne Hub

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

<Warning>Ensure you have Admin privileges for your BreatheHR account.</Warning>

<section data-guide-section data-guide-scopes="">
  <h2>Getting your API Key</h2>

  <p>To connect BreatheHR with StackOne, you'll need to generate an API key from your BreatheHR account.</p>

  <Steps>
    <Step title="Log in to BreatheHR">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Log in to your <a href="https://login.breathehr.com" target="_blank" rel="noopener noreferrer">BreatheHR dashboard</a>, select <strong>Configure</strong> from the left sidebar, then choose <strong>Settings</strong>.</p>
      </div>
    </Step>

    <Step title="Locate API Setup">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Inside the Settings page, locate the <strong>Integrations</strong> section and click <strong>API Setup</strong>.</p>
      </div>
    </Step>

    <Step title="Enable and Copy API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Enable the API keys if not already enabled.</p>

        <ul>
          <li>Copy the API key for your desired environment (Production or Sandbox)</li>
          <li>Store it securely for use later</li>
          <li>Note: Keep your API key confidential as it provides access to your HR data</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Selecting Your Environment</h2>

  <p>BreatheHR provides separate environments for Production and Sandbox testing.</p>

  <Steps>
    <Step title="Choose the Correct Environment">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>When connecting, select the environment that matches your API key.</p>

        <ul>
          <li>Select <strong>Production</strong> if using your production API key</li>
          <li>Select <strong>Sandbox</strong> if using your sandbox API key for testing</li>
          <li>Important: Ensure the selected environment matches the API key you copied</li>
        </ul>
      </div>
    </Step>
  </Steps>
</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>
      </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>