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

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

<Warning>Account Admin privileges are required if your API key is disabled and needs to be enabled.</Warning>

<section data-guide-section data-guide-scopes="">
  <h2>Retrieve Your Freshservice Domain</h2>

  <p>Identify your Freshservice subdomain, which is used to construct API requests.</p>

  <Steps>
    <Step title="Find Your Domain">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Your Freshservice domain is the subdomain in your Freshservice URL. For example, if your Freshservice URL is `https://mycompany.freshservice.com`, then your domain is `mycompany`.</p>
      </div>
    </Step>

    <Step title="Enter the Domain">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Enter your Freshservice subdomain (e.g., `mycompany`) in the <strong>Domain</strong> field.</p>
      </div>
    </Step>
  </Steps>
</section>

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

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

  <Steps>
    <Step title="Access Your Profile Settings">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Log in to Freshservice and click your profile picture in the top-right corner. Select <strong>Profile Settings</strong> from the dropdown menu.</p>
      </div>
    </Step>

    <Step title="View Your API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>On the profile settings page, your API key is displayed on the right side below the <strong>Delegate Approvals</strong> section. If you need a new key, you can regenerate it from this page.</p>
      </div>
    </Step>

    <Step title="Copy the API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Copy the API key and paste it into the <strong>API Key</strong> field in StackOne. Keep this key secure as it provides access to your Freshservice account.</p>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Enable a Disabled API Key</h2>

  <p>If the API key is disabled, an Account Admin must enable it for the agent profile.</p>

  <Steps>
    <Step title="Navigate to Agent Settings">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in to Freshservice as an Account Admin and navigate to agent management.</p>

        <ul>
          <li>Click the <strong>Admin</strong> icon at the bottom of the left sidebar</li>
          <li>Under the <strong>User Management</strong> section, click <strong>Agents</strong></li>
        </ul>
      </div>
    </Step>

    <Step title="Enable API Key for the Agent">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Select the agent and enable their API key access.</p>

        <ul>
          <li>Click on the agent's name to open their profile</li>
          <li>Go to the <strong>Permissions</strong> tab</li>
          <li>Toggle the <strong>API Key</strong> option to enable it</li>
        </ul>
      </div>
    </Step>

    <Step title="Retrieve the API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Once enabled, the agent can view their API key in <strong>Profile Settings</strong> on the right side below the <strong>Delegate Approvals</strong> section.</p>
      </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>Domain</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>