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

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

<Warning>This guidance assumes you have Super Admin privileges for your Workable account.</Warning>

<section data-guide-section data-guide-scopes="">
  <h2>Generating Workable API Token</h2>

  <p>To connect Workable with StackOne, you'll need to generate an API Token with the appropriate permissions.</p>

  <Steps>
    <Step title="Open Settings">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in to your <a href="https://www.workable.com/signin" target="_blank" rel="noopener noreferrer">Workable account</a>.</p>

        <ul>
          <li>Click your initials in the top right corner to open the menu.</li>
          <li>Navigate to <strong>Settings > Integrations > Apps</strong>.</li>
        </ul>
      </div>
    </Step>

    <Step title="Generate API Token">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Scroll down to the API Access Tokens section.</p>

        <ul>
          <li>Click <strong>Generate API Token</strong>.</li>
          <li>Enter a <strong>Name</strong> for the token (e.g., StackOne).</li>
          <li>Set <strong>Expires in</strong> to your preferred duration (e.g., 1 year). Note internally for renewal.</li>
          <li>Select the <strong>Scopes</strong> based on your integration needs.</li>
        </ul>
      </div>
    </Step>

    <Step title="Select API Scopes">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Choose the appropriate scopes based on the data you need to access.</p>

        <ul>
          <li><strong>r\_jobs</strong> - Read access to jobs, stages, custom attributes, and events</li>
          <li><strong>r\_candidates</strong> - Read access to candidates and their activities</li>
          <li><strong>w\_candidates</strong> - Write access to create and update candidates</li>
          <li><strong>r\_employees</strong> - Read access to employee information and documents</li>
          <li><strong>w\_employees</strong> - Write access to create and update employees</li>
          <li><strong>r\_account</strong> - Read access to account settings, departments, and legal entities</li>
          <li><strong>w\_departments</strong> - Write access to manage departments</li>
          <li><strong>w\_members</strong> - Write access to manage account members</li>
          <li><strong>r\_timeoff</strong> - Read access to time off requests and balances</li>
          <li><strong>w\_timeoff</strong> - Write access to create time off requests</li>
          <li><strong>r\_offers</strong> - Read access to candidate offers</li>
          <li><strong>w\_offers</strong> - Write access to approve or reject offers</li>
          <li><strong>r\_requisitions</strong> - Read access to hiring requisitions</li>
          <li><strong>w\_requisitions</strong> - Write access to manage requisitions</li>
          <li><strong>w\_comments</strong> - Write access to add comments on candidates</li>
        </ul>
      </div>
    </Step>

    <Step title="Generate and Copy Token">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Click the <strong>Generate token</strong> button.</p>

        <ul>
          <li>Copy the generated API Token immediately.</li>
          <li>Store it securely as it will only be displayed once.</li>
          <li>Close the modal dialog.</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Getting Company Subdomain</h2>

  <p>You'll also need your Workable company subdomain to complete the connection.</p>

  <Steps>
    <Step title="Find Your Subdomain">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Navigate to <strong>Settings</strong> then click <strong>Company profile</strong>.</p>

        <ul>
          <li>Locate the <strong>Subdomain</strong> field.</li>
          <li>Copy the subdomain value.</li>
          <li>Example format: `your-company-name`</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 Token</strong></li>
        <li><strong>Company Subdomain</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>