Generate API key for Greenhouse Recruiting

Permissions_and_Product_Tier.png

Third-party partners can connect with Greenhouse Recruiting through one of several available APIs; this connection is often used to create integrations between Greenhouse Recruiting and other software platforms.  In order for a third-party to access your organization's Greenhouse Recruiting data via API, you will need to create an API key and provide it to the partner. In this article, we will cover how to create an API key. 

Note: Only users who have been granted the Developer permission Can manage ALL organization's API credentials can generate an API key.

To begin, click the Configure icon Configure.png in the upper right-hand corner. Navigate to Dev Center on the left-hand panel.

3.png

From the Dev Center page, click API Credential Management.

4.png

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

Create_New_API_Key.png

From the Create new credential dialog box, give your API key a name and select the appropriate API key type from the Type dropdown menu. The following types of API keys can be created:

  • Harvest
  • Job Board 
  • Partner (requires selecting a Client Application)

Note: The integration parter will provide you with guidance on what type of API key to create, as well as what endpoints you should grant the key access to (if applicable). 

mceclip0.png

When finished, click Create.

If you created a Job Board or Partner API key, copy the key and provide it to your contact at the third-party partner. The third-party partner will provide guidance on any additional steps required to enable the integration.

If you created a Harvest API key, you will be directed to the Manage API Key Permissions page to grant the API key access to specific endpoints. When finished granting access, click Update at the bottom of the page. Copy the API key and provide it to your contact at the third-party partner.

Note: Providing a partner with a Harvest API key gives them access to all data at the specified endpoints you selected on the Manage API Key Permissions page, and is comparable to granting the partner Site Admin permissions in your Greenhouse Recruiting account. If a partner requests a Harvest API key, be sure to review and confirm the endpoints the partner needs access to for their integration. For more information, review the following Help Center article: Manage Harvest API Key Permissions

5.png