How can we help you?

Manage Harvest API Key Permissions

Permissions_and_Product_Tier.png

Greenhouse Recruiting's Harvest API allows your team to grant your internal developers and third-party partners access to your jobs, candidates, interviews, and other data via API. An individual can access this data only with a Harvest API key. Managing permissions via the Harvest API key allows you to permit or deny access to each Harvest endpoint individually, so you can have more control over what data a developer or third-party partner can access from your Greenhouse Recruiting account.

Note: Harvest API keys created before January 18, 2017 have full permissions to all API endpoints that existed at that time, but any new API keys created after that date must explicitly be granted specific required endpoint permissions. For further instructions on authentication and the data available in the Harvest API, please visit our Developer Resource's site

In this article we will cover how to: 

 

Create a New Harvest API Key

Click the Configure icon Configure.png in the upper right-hand corner. Navigate to Dev Center on the left-hand panel.

Configure_-_Dev_Center.png

From the Dev Center page, click API Credential Management.

Dev_Center_-_API_Credential_Management.png

From the API Credential Management page, click Create New API key.

Create_API_Key.png

From the Create new credential dialog box, give your API key a name and select Harvest from the Type dropdown menu. When finished, click Create.

Note: Entering a description/name for the Harvest API key is optional, however we recommend indicate the available permissions or what the key is for to help distinguish between keys.

mceclip1.png

You will be directed to the Manage API Key Permissions page, where you can select the endpoints, or specify the endpoint methods, that the key will give access to. We recommend granting each key only the exact access it requires. You may need to work with your internal development team or integration partner to determine which endpoints you should select. When you have finished selecting the appropriate endpoints, click Update at the bottom of the page. 

Harvest_API_permissions.png

You have created a Harvest API key successfully! Provide the key to your internal development team or integration partner as appropriate. 

 

Update an Existing Harvest API Key

Note: Making changes to the permissions of an API Key that is in use may impact internal or third-party tools that rely on data called from the API. To avoid potential service disruptions, please check with your development team or integration partner before making changes to a key's permissions. For security, we also highly recommend sending API keys using a public key or other secure messaging service, rather than copying keys to plain text emails.

To update an existing Harvest API key, begin by clicking the Configure icon Configure.png in the upper right-hand corner. Navigate to Dev Center on the left-hand panel. 

Configure_-_Dev_Center.png

From the Dev Center page, click API Credential Management

Dev_Center_-_API_Credential_Management.png

From the API Credential Management page, locate the key you wish to edit. 

Edit Harvest API Key Name

To change the name of an existing Harvest API key, click the pencil icon to the right of the key name. 

Pasted_Image_5_27_20__3_06_PM.png

Enter the updated name, then click Save

mceclip4.png

Edit Harvest API Key Permissions

To edit the permissions granted to an existing Harvest API key, click Manage Permissions beneath the key. 

Pasted_Image_5_27_20__3_09_PM.png

On the Manage API Key Permissions page, add or remove permissions by checking or unchecking the appropriate checkboxes. When finished, click Update at the bottom of the page. 

Revoke Harvest API Key

To deactivate a Harvest API Key and revoke its access from all individuals with the key, click Revoke beneath the key. 

Pasted_Image_5_27_20__3_11_PM.png