Skip to content


Greenhouse is a popular applicant tracking system (ATS) and recruiting software used by companies to manage their hiring processes. It offers a range of features designed to streamline recruiting workflows, improve collaboration among hiring teams, and provide insights into recruitment metrics.

Generating API Key to set up Greenhouse connection

  1. Log in to your Greenhouse account as an administrator.
  2. Navigate to the Configure tab and select Dev Center from the dropdown menu.
  3. In the Dev Center, click on API Credential Management.
  4. Click on Create New API Key to generate a new API key.
  5. Make the following selections:
    • API Type: Harvest
    • Partner: If your integration is not listed, you can either keep it empty or choose the option for an unlisted vendor.
    • Description: Enter a descriptive name for your API key, such as "Hire2Retire Key".
  6. When finished, click Manage Permissions to generate the Harvest API key.
  7. Set the following permissions and save.

    In the Applications, select Get: Retrieve Application and Get: List Applications permission.

    Applications in Greenhouse

    Figure 1. Applications API

    In the Candidates, select Get: Retrieve Candidate and Get: List Candidates permission.

    Candidates in Greenhouse

    Figure 2. Candidates API

    In the Jobs, select Get: Retrieve Job permission.

    Jobs in Greenhouse

    Figure 3. Jobs API

  8. Click Create to generate an API key. Make sure to copy and securely store the generated API key since you won't be able to retrieve it again.

Create a Connection

Hire2Retire requires the following details to create a connection with your Greenhouse server:

  • API Key - An API key is a unique identifier that grants access to the Greenhouse API (Application Programming Interface). The API key serves as a form of authentication, allowing external applications or services to interact with Greenhouse programmatically.

    Connection page

    Figure 4. Greenhouse Connection Set Up page - Create Connection


Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.

  1. HR Data Definition
  2. Lifecycle Business Rules
  3. Employment Status
  4. HR to AD Profile Map
  5. Organizational Unit Assignment - Only defined in on-premise Active Directory
  6. Security Group Assignment
  7. Distribution List Assignment


Once your workflow has been setup, you can optionally setup notifications and archival for your workflow.

Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow