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

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

<Warning>Administrator privileges within SmartRecruiters are required to generate an API Key.</Warning>

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

  <p>To connect SmartRecruiters with StackOne using an API Key, you need to generate a new API Key in the SmartRecruiters Credential Manager.</p>

  <Steps>
    <Step title="Access the Credential Manager">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in to your <a href="https://www.smartrecruiters.com/account/sign-in" target="_blank" rel="noopener noreferrer">SmartRecruiters account</a> as an Administrator.</p>

        <ul>
          <li>Click your name in the upper-right corner to open the dropdown menu</li>
          <li>Select <strong>Settings</strong> from the menu</li>
          <li>Under <strong>Administration</strong>, click <strong>Apps & Integrations</strong></li>
          <li>Select the <strong>Credentials</strong> tab</li>
        </ul>
      </div>
    </Step>

    <Step title="Create a New API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>In the <a href="https://www.smartrecruiters.com/settings/administration/app-management/custom-applications" target="_blank" rel="noopener noreferrer">Credential Manager</a>, create a new API Key.</p>

        <ul>
          <li>Click the <strong>New Credential</strong> button</li>
          <li>Select <strong>API Key</strong> from the options</li>
        </ul>
      </div>
    </Step>

    <Step title="Configure the API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Provide the required details for your API Key.</p>

        <ul>
          <li><strong>Credential name</strong>: Enter a descriptive name (e.g., StackOne Integration)</li>
          <li><strong>Description</strong>: Add a description to help identify the purpose of this API key</li>
          <li><strong>System Role</strong>: Select the appropriate system role that defines the level of access for this API key</li>
          <li><strong>Access Group</strong>: Choose the access group that determines which data and resources this API key can access</li>
          <li><strong>NOTE:</strong> To create or manage custom Access Groups, navigate to <a href="https://www.smartrecruiters.com/settings/permissions/access-groups" target="_blank" rel="noopener noreferrer">Access Groups Settings</a></li>
        </ul>
      </div>
    </Step>

    <Step title="Generate and Save the API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Complete the setup and save your API Key securely.</p>

        <ul>
          <li>Click <strong>Generate</strong> to create the API Key</li>
          <li>Copy the <strong>API Key</strong> value displayed in the pop-up</li>
          <li>Store the API Key securely for use later</li>
          <li>⚠️ The API Key is only shown once and cannot be retrieved later</li>
          <li>⚠️ API Keys provide full access to your organization's resources in SmartRecruiters</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>
