> ## 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.

# Employment Hero

> Follow these steps to connect Employment Hero via the StackOne Hub successfully.

<Warning>
  Ensure that your Employment Hero account has Admin privileges.
</Warning>

If you have been directed to StackOne to integrate with Employment Hero, the following steps will help you understand the process and any necessary actions to configure a successful integration.

## Find your Organization ID

Your Organization ID is a unique number located in your Employment Hero platform URL. You may need this ID when configuring your integration.

Look at the page URL in your browser's address bar. You will see a unique number which is your **organization's platform ID**.

For example, if your URL is `https://secure.employmenthero.com/app/organisations/12345/dashboard`, then your organization ID is `12345`.

## Generate Client ID and Secret key

<Steps>
  <Step title="Log in to your Employment Hero account">
    Log in to your Employment Hero account with Admin privileges to access the necessary settings for integration.
  </Step>

  <Step title="Navigate to Account > Developer Portal > API">
    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Navigate to Account > Developer Portal > API" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image1.png?fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=a7cf2546601f73dc4f5696ebc2f420cc" data-og-width="1914" width="1914" data-og-height="715" height="715" data-path="images/employmenthero/image1.png" data-optimize="true" data-opv="3" srcset="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image1.png?w=280&fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=8b0c9b2814b1bf7716265164a0c8734a 280w, https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image1.png?w=560&fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=185fcbed078672ce076508ba5b971356 560w, https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image1.png?w=840&fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=ec7f6494fb77139262cf6f2e6dc41456 840w, https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image1.png?w=1100&fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=bb44fa8ff9f846a7f206cd781e86dca5 1100w, https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image1.png?w=1650&fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=7abcb61cc6f70533441c0db256022e56 1650w, https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image1.png?w=2500&fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=05d81edee4781a7a619164f05be4de02 2500w" />
    </Frame>
  </Step>

  <Step title="Click Add Application">
    On the **API** tab, click the **Add Application** button.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Click Add Application" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image2.png?fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=aa863be8f3569db9c246450da579aad9" width="1652" height="375" data-path="images/employmenthero/image2.png" />
    </Frame>
  </Step>

  <Step title="Configure the App Details">
    Configure the app with the following details and then click the **Create** button

    * **Name**: e.g. StackOne
    * **Redirect URL**: `https://api.stackone.com/connect/oauth2/employmenthero/callback`
    * **Scopes**: Select the required admin and user scopes to enable data access via API. Below are the recommended scopes to select:
      * `custom_fields:list`
      * `employee_custom_fields:list`
      * `employees:list`
      * `timesheet_entries:list`
      * `leave_requests:list`
      * `policies:list`
      * `rostered_shifts:list`
      * `unavailabilities:list`
      * `bank_accounts:list`
      * `emergency_contacts:list`
      * `employment_histories:list`
      * `pay_details:list`
      * `teams:list`
      * `organisations:list`

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Configure the App Details" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image6.png?fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=2e780674d956b4b5965bc2f96c70ddd5" width="1189" height="6150" data-path="images/employmenthero/image6.png" />
    </Frame>

    Click the **Continue to Review** button to proceed to the next step.

    Review the details and ensure that you have selected the necessary scopes for your integration.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Configure the App Details" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image7.png?fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=047794995169dab0fcfccf3829bc10f2" width="1205" height="1189" data-path="images/employmenthero/image7.png" />
    </Frame>

    Click the **Create Application** button to generate your Client ID and Client Secret.
  </Step>

  <Step title="Copy your Client ID and Client Secret">
    Copy your Client ID and Client Secret and store them safely for use in a later step.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Copy your Client ID and Client Secret" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image8.png?fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=b72d6d1382b4612d0a0b249da9fff9d0" width="1205" height="852" data-path="images/employmenthero/image8.png" />
    </Frame>
  </Step>
</Steps>

## Connecting with StackOne

<Steps>
  <Step title="Enter Credentials">
    Upon reaching the Link Account page, enter the credentials from the previous steps, then click the **Connect** button to proceed.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Enter Credentials" src="https://mintcdn.com/stackone-hub-docs-confluence-api-token-update/Rs6NeAXs5I3UVlO6/images/employmenthero/image5.png?fit=max&auto=format&n=Rs6NeAXs5I3UVlO6&q=85&s=d3cc31ac72e67cd3677f643148cce317" width="509" height="670" data-path="images/employmenthero/image5.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!

## Useful Links

<Card title="API Reference" icon="link" href="https://developer.employmenthero.com/api-references/">
  [https://developer.employmenthero.com/api-references/](https://developer.employmenthero.com/api-references/)
</Card>
