> ## Documentation Index
> Fetch the complete documentation index at: https://stackone-hub-docs-confluence-api-token-update.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Teamtailor

> Follow these steps to connect Teamtailor with StackOne Hub successfully.

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

If you've been directed to StackOne to integrate with Teamtailor, the following steps will help you understand the process and any necessary actions to configure successful integration.

## Generating API key and getting Company ID

<Steps>
  <Step title="Navigate to Settings">
    In your Teamtailor account, click on Settings.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Settings" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image1.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=9d55c88b27715d9dd24d5e56b0b26a5c" width="2880" height="796" data-path="images/teamtailor/image1.png" />
    </Frame>
  </Step>

  <Step title="Find API Keys">
    On the left-hand menu under the integrations header, find API keys.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="API Keys" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image2.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=e583edd989471dc3ab56dfc6bda917d5" width="254" height="231" data-path="images/teamtailor/image2.png" />
    </Frame>
  </Step>

  <Step title="Create a New API Key">
    Click the New API Key button at the top right of the page.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="New API Key" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image3.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=98b57bd2dc0310fa3d0ae1fa88c1892b" width="864" height="138" data-path="images/teamtailor/image3.png" />
    </Frame>
  </Step>

  <Step title="Set Name and Permissions">
    Enter a descriptive name, set the scope to `admin` and permissions, where only Read is required.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Set Permissions" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image4.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=943e7b25270865c3773c16f38a2dd6f2" width="1012" height="872" data-path="images/teamtailor/image4.png" />
    </Frame>
  </Step>

  <Step title="Copy API Key">
    Copy the API key to a safe place.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Copy API Key" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image5.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=5a6413fe0d2c8615bef666a1eaba67f1" width="859" height="208" data-path="images/teamtailor/image5.png" />
    </Frame>
  </Step>

  <Step title="Get Company ID">
    Make a note of the `company ID`, which is part of the URL as shown below:

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Company ID" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image6.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=bf59e89f9517516d7f5b5fd709a93e6c" width="622" height="129" data-path="images/teamtailor/image6.png" />
    </Frame>
  </Step>
</Steps>

## Get user credentials

You will also need to provide a user email and password. It is recommended that you set up a new account for integration purposes.

<Steps>
  <Step title="Create a New Employee">
    Find the employees tab and click the ➕ to create a new employee.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="New Employee" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image7.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=033096b1e0e2cb07cefb978694756a50" width="662" height="160" data-path="images/teamtailor/image7.png" />
    </Frame>
  </Step>

  <Step title="Fill Out Required Fields">
    Fill out the required fields and set the Role to Recruitment Admin. This will ensure the account has the correct permissions.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Set Role" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image8.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=a24b1a273df618fd5e1564841efa0716" width="729" height="996" data-path="images/teamtailor/image8.png" />
    </Frame>
  </Step>

  <Step title="Add Employee">
    Click Add employee.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Add Employee" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image9.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=4f8b375386655a1418c3c81818523ac8" width="710" height="197" data-path="images/teamtailor/image9.png" />
    </Frame>
  </Step>

  <Step title="Create Account">
    The email address you entered will receive an invitation. Click `Create account`, you may have to log out of your current account to create the password.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Create Account" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image10.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=e72d887e2b0999c861a797af225f2162" width="580" height="687" data-path="images/teamtailor/image10.png" />
    </Frame>
  </Step>

  <Step title="Find the Invitation Link">
    If you have not received an invitation, you can go to the `Employees` tab again and click on the user's `pencil` ✏️ icon to edit their profile. You will see a link to the invitation, and you can click through this to set up the account.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Invitation Link" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image11.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=9186acbdc3a05bb329c284065ef0c152" width="502" height="96" data-path="images/teamtailor/image11.png" />
    </Frame>
  </Step>

  <Step title="Get Account Email and Password">
    You should now have the account email address and password to proceed with the Hub.
  </Step>
</Steps>

⚠️ If your account uses SSO, you may have to create the account differently:

### Accounts with Single Sign-On (SSO)

Follow steps 2.1 to 2.2 inclusive to create the employee, you will then have to exclude the employee from SSO, under the heading `Exclude individual users from SSO login`, as detailed here:

<Steps>
  <Step title="Exclude from SSO">
    After the user has been excluded, ensure a password is set. You may have to edit the permissions of the user by accessing the Employees tab and clicking on the gear ⚙️ here.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Exclude from SSO" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image12.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=3b599468307ec75aca8231428a6b45f6" width="725" height="238" data-path="images/teamtailor/image12.png" />
    </Frame>
  </Step>

  <Step title="Set Role">
    You will see a page similar to step 2.2, where you can set the role to `Recruitment admin`.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Set Role" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image13.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=756b38a74eb319f128fab2e6a9e15d9a" width="353" height="111" data-path="images/teamtailor/image13.png" />
    </Frame>
  </Step>
</Steps>

## Input the collected inputs into the StackOne Hub

<Steps>
  <Step title="Link Account">
    Upon reaching the Link Account page, enter the gathered details and proceed by clicking the `Connect` button.

    <Frame>
      <img className="rounded-md" style={{ margin: '0 auto', border: '1px solid #efefef' }} alt="Link Account" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/0zRfAlVllz5bF-yn/images/teamtailor/image14.png?fit=max&auto=format&n=0zRfAlVllz5bF-yn&q=85&s=5bcebb26a634be683b0aa0019b3ac29c" width="538" height="702" data-path="images/teamtailor/image14.png" />
    </Frame>
  </Step>
</Steps>

<br />

Congratulations, you're all set! If you face any issues with the steps mentioned above,
please contact us by emailing [integrations@stackone.com](mailto:integrations@stackone.com). We're always here to assist you!

## Available data

This integration has the following [IAM Resources](https://docs.stackone.com/reference/iam_list_users) available from the provider:

<ul>
  <li>Users</li>
  <li>Roles</li>
  <li>Groups</li>
</ul>

## Useful Links

<Card title="API Reference" icon="link" href="https://support.teamtailor.com/en/articles/5963369-use-our-teamtailor-api">
  [https://support.teamtailor.com/en/articles/5963369-use-our-teamtailor-api](https://support.teamtailor.com/en/articles/5963369-use-our-teamtailor-api)
</Card>

<Card title="Support" icon="link" href="https://support.teamtailor.com">
  [https://support.teamtailor.com](https://support.teamtailor.com)
</Card>
