​
Overview

To authenticate with Greenhouse (Harvest API), you need:
  1. API Key - Your Greenhouse (Harvest) API Key
This guide will walk you through creating the API Key within Greenhouse.

​
Prerequisites:

  • You must set up an account with Greenhouse.

​
Step 1: Finding Your Greenhouse API Key

  1. Log into your Greenhouse account and click the Configure ⚙️ icon on your navigation bar, then click Dev Center.
  1. Click API Credential Management.
  1. Click Create New API Key.
  1. Make the following selections:
    • API type: Harvest.
    • Partner: Select the name of the integration that requested the API Key. If the integration isn’t listed, select unlisted vendor. If you’re creating a custom integration, select custom.
    • Description: Give your API Key a descriptive name.
  2. When finished, click Manage permissions, or click Create to generate the API Key and automatically assign it the appropriate permissions required by the integration.
  3. After the key is created, click Copy. Paste the API Key in a secure location.
  4. Click I have stored the API Key.

​
Step 2: Enter credentials in the Connect UI

Once you have your API Key:
  1. Open the form where you need to authenticate with Greenhouse (Harvest API).
  2. Enter the API Key in the respective field.
  3. Submit the form, and you should be successfully authenticated.
You are now connected to Greenhouse (Harvest API).