Overview

To authenticate Greenhouse, you will need to provide the following information:

• API Key

This guide will walk you through finding or creating those credentials within Greenhouse.

Instructions

Step 1: Get your API Key from Greenhouse

1. Log in and click the Configure (Settings) Icon on the upper right-hand corner of any page

   

2. Click Dev Center in the left menu

   

3. Select API Credential Management

   

4. Click the Create New API Key button
   ​

   

5. Select Harvest for the API Type, "Custom" under Partner, and enter a description for the API key. Then click Manage Permissions:

   

6. Click the Copy button, and paste the API key below. Next, click "I have stored the API key"
   
   ​Note that you will not be able to copy this API Key again, so please store it somewhere safe!

   

7. Select your permissions:

   • Click Select All or select the relevant permissions required for your use case

   • See below all of the permissions necessary for all data as part of this integration

   • To link your account, the minimum permissions you must select is the GET: List Users permission under Users

Step 2: Enter your API key in the linking flow

How to update permissions

1. Navigate back to the Dev Center and to API Credentials Management

   

2. Find the API Key used to link you Greenhouse integration

3. Click on the "Edit" icon on the row of your API Key

   

4. Update permissions and click save