API Provider Setup

To authenticate a Greenhouse element instance you must use the Harvest API Key configured in Greenhouse.

See the latest setup instructions in the Greenhouse documentation.

Locate Your API Key

If you already created an API Key, follow the steps below to locate the Harvest API Key. If you have not created an API key, see Create an API Key.

1. Log in to your account at Greenhouse.
2. Click the Settings icon at the top of the page, or click the Configure tab.
3. Open the Dev Center: click Dev Center in the list on the left or the link on the Configure page.
4. Click API Credential Management.
5. In the sidebar, click Advanced Settings, and then click Legacy API Settings.
6. Record the Harvest API Key .

Create an API Key

If you have not created an API Key, you need one to authenticate with Greenhouse.

To create an API Key:

1. Log in to your account at Greenhouse.
2. Click the Settings icon at the top of the page, or click the Configure tab.
3. Open the Dev Center: click Dev Center in the list on the left or the link on the Configure page.
4. Click API Credential Management.
5. Click Create New API Key.
6. Enter a description, and then select Harvest from the Type list.
7. Click Create.

8. Select the permissions for the API key, and then click Update.

   Note: The minimum permissions required to work with the Greenhouse element are all Candidates, Jobs, and Job Posts.

9. Record the Harvest API Key .

Next authenticate an element instance with Greenhouse.