Create a Harvest API key for a partner integration

Permissions: Basic users and above who can manage ALL organization’s API credentials

Product tier: Available for all subscription tiers

The Harvest API is used when a partner needs to access various parts of your Greenhouse Recruiting data. To set up this integration, you’ll need to create a Harvest API key and send it to the partner.

Check out the partner documentation for additional information on a specific integration.

For the full Harvest API documentation, click here.

Create a Harvest API key for a partner

Note: To complete these steps, you must have the developer permission Can manage ALL organization's API Credentials.

A Site Admin with the user-specific permission Can edit another user's advanced permissions can update your account. Click here for more information on updating permissions.

Click on the Configure icon Configure icon and select Dev Center on the left side of the page.

Screenshot of Dev Center Navigation

Select API Credential Management in the Dev Center.

Screenshot of API credential management

Click Create New API Key to generate the API key for the partner.

Screenshot of create new API key button

Choose the Harvest API Type. If the partner's name is listed in the dropdown menu, select them from the list. You can also add an optional description to your API key so it is easier to identify on the list.

When you finish, click Manage Permissions.

Screenshot of manage permissions button

You’ll be prompted to copy the API key to provide it to the partner in the next step. Click Copy to save your API key to your clipboard.

Note: Make sure to store the API key in a secure location to provide to the partner in the next step.

Each key is unique, and for security purposes, you won’t be able to view it after it has been generated on this window.

If you lose the API key, you’ll need to generate a new one and provide it to the partner.

Screenshot of a copied API key

Click I have stored the API Key once you have copied and saved the key.

Screenshot of storage button

Select the checkboxes next to each permission box to associate it with the API key. Refer to the specific partner documentation for a list of the permissions to select for an integration.

Screenshot of permissions section

When you’re finished, click Save at the bottom of the page.

Finish setup

To finish setup, send the API key to the partner through a secure method. Make sure to communicate with the partner and use their process for sending secure information.

Once the partner adds your organization’s information to their system, the integration setup is complete.