> ## Documentation Index
> Fetch the complete documentation index at: https://stackone-hub-claude-issue-384-20260409-1436.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Eploy

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

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

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

## Getting your Subdomain

<Steps>
  <Step title="Find the Subdomain">
    You can find the subdomain in the URL of your Eploy account by taking the portion that appears before `.eploy.net` and after `https://`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Subdomain Example" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image1.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=8c8f643c024681a48efcd8cd2dfa6545" width="1918" height="912" data-path="images/eploy/image1.png" />
    </Frame>
  </Step>
</Steps>

In this example, the value would be: stackoneapidemo

## Generating Client Id and Client Secret

<Steps>
  <Step title="Navigate to API Keys">
    In the top navigation bar go to `Admin` → `System / Security Settings` → `API Keys`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Create API Key" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image2.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=b6a0db295a425749e29a82031b7ffda2" width="962" height="781" data-path="images/eploy/image2.png" />
    </Frame>
  </Step>

  <Step title="Create a New API Key">
    On the top-right select `New` → `Rest API`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Create API Key" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image3.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=58bb9aa8622cae1a4daf966745528ca9" width="763" height="764" data-path="images/eploy/image3.png" />
    </Frame>
  </Step>

  <Step title="Name the API Key">
    Enter `title` for the API Key, for example: `StackOne`.

    Select an `API User` for your API Key to use and click `Save`.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Create API Key" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image4.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=449001f5c8bb0ac840e2e866f4127c7b" width="860" height="504" data-path="images/eploy/image4.png" />
    </Frame>
  </Step>

  <Step title="Record Client ID, Client Secret and Assign Permissions">
    Your `Client ID` and `Client Secret` will be generated and displayed to you. Copy them to a safe place.

    Assign API permissions based on the integration requirements by clicking on `Add` button.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Generated API Key" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image5.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=fd5561c8a696b0251b7053731b24dc7f" width="889" height="874" data-path="images/eploy/image5.png" />
    </Frame>

    Select and enable each of the API permissions below used in this integration, and click `Save` for each.

    <Accordion title="API Key Permissions">
      * **Actions**
        * Insert
        * View
        * Update
      * **Applications**
        * Insert
        * View
        * Update
      * **Candidates**
        * Insert
        * View
        * Update
      * **Companies**
        * Insert
        * View
        * Update
      * **Contacts**
        * Insert
        * View
        * Update
      * **Export**
        * View
        * Insert
      * **Files**
        * View
      * **Pay Rates**
        * View
      * **Pay Salaries**
        * View
      * **Placements**
        * Insert
        * View
        * Update
      * **Purchase Orders**
        * View
      * **Timesheets**
        * Insert
        * View
        * Update
      * **Users**
        * Insert
        * View
        * Update
      * **Vacancies**
        * Insert
        * View
        * Update
      * **Vacancy Templates**
        * View
      * **Workflows**
        * View
    </Accordion>

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Generated API Key" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image6.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=3d62e62ce0351452b334ad577f394334" width="888" height="868" data-path="images/eploy/image6.png" />
    </Frame>

    Click `Save`.
  </Step>
</Steps>

## Connecting with StackOne

<Steps>
  <Step title="Enter the Details">
    Upon reaching the Link Account page, enter the `Subdomain`, `Client ID`, and `Client Secret` gathered from the steps above.

    Enter `scopes` to optionally restrict this API key's access.

    Only the scopes assigned above during API key configuration will be allowed — see the full list <a href="https://support.eploy.co.uk/hc/en-gb/articles/14711773981853-Eploy-RESTful-API-Full-Developer-s-Guide#:~:text=A%20full%20list%20of%20Scopes%20are%20as%20follows">here</a>.

    <Frame>
      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Link Account" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image7.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=f2b7d8a2e1b1c9d3fb0606b5376dab82" width="1046" height="1342" data-path="images/eploy/image7.png" />

      <img className="rounded-md" style={{ margin:"0 auto",border:"1px solid #efefef" }} alt="Link Account" src="https://mintcdn.com/stackone-hub-claude-issue-384-20260409-1436/Y2yXNMilzKkUX5lw/images/eploy/image8.png?fit=max&auto=format&n=Y2yXNMilzKkUX5lw&q=85&s=1e6dd3bfc088b7a50652768e99406331" width="1062" height="1348" data-path="images/eploy/image8.png" />
    </Frame>

    Click `Connect`.
  </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://support.eploy.co.uk/hc/en-gb/categories/14740107974941-Eploy-RESTful-API">
  [https://support.eploy.co.uk/hc/en-gb/categories/14740107974941-Eploy-RESTful-API](https://support.eploy.co.uk/hc/en-gb/categories/14740107974941-Eploy-RESTful-API)
</Card>