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

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

<Warning>Admin privileges are required to create API keys in Kustomer.</Warning>

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

  <p>Create an API key to authenticate with the Kustomer API.</p>

  <Steps>
    <Step title="Navigate to API Key Settings">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in to your Kustomer instance at `https://<your-org>.kustomerapp.com`.</p>

        <ul>
          <li>Navigate to <strong>Settings > Security > API Keys</strong>.</li>
          <li>Click <strong>Add API Key</strong>.</li>
        </ul>
      </div>
    </Step>

    <Step title="Configure Roles">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Select the roles (permissions) needed for your integration.</p>

        <ul>
          <li>For read access: assign `org.permission.customer.read`, `org.permission.conversation.read`, `org.permission.message.read`, `org.permission.user.read`.</li>
          <li>For full access: assign `org.user.*` or `org.admin.*`.</li>
          <li>Roles cannot be changed after creation — the key must be deleted and recreated with new roles.</li>
        </ul>
      </div>
    </Step>

    <Step title="Copy the API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>After creation, copy the API key immediately. It is only shown once and cannot be retrieved again. Store it securely.</p>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Find Your Organization Name</h2>

  <p>Your Kustomer organization name is needed for the API base URL.</p>

  <Steps>
    <Step title="Locate from your browser URL">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>After logging in to Kustomer, look at the URL in your browser address bar. It follows the format `https://<org-name>.kustomerapp.com`.</p>

        <ul>
          <li><strong>Organization Name</strong> is the subdomain before `.kustomerapp.com` (e.g., `mycompany`).</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>Organization Name</strong></li>
        <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>