Create an API key in Greenhouse Recruiting

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

Product tier: Available for all subscription tiers

Integrations connect to Greenhouse Recruiting through our APIs. In order to provide access to your organization's Greenhouse Recruiting data, you may need to create an API key and provide it to the integration.

Create an API key

To create an API key, click the Configure Configure-icon.png icon on your navigation bar, then click Dev Center on the left.

Screenshot-of-Configure_Dev-Center.png

Click API Credential Management.

The_Dev_Center_page_shows_the_API_Credential_Management_button_highlighted_in_the_middle_in_a_marigold_emphasis_box.png

Click Create New API Key.

Screenshot of the create new api key.

Make the following selections:

  • API type: Choose between Candidate ingestion, Harvest, or Job board.
  • 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.
Note: The integration should provide guidance on which type of API key to create and which permissions you should grant to the API key.

When finished, click Manage permissions, or click Create to generate the API key and automatically assign it the appropriate permissions required by the integration.

After the key is created, click Copy. Paste the API key in a secure location to provide to the integration later.

Click I have stored the API Key.

Note: You can't access the full API key again after clicking I have stored the API Key. If you lose your API key and need to access it later, you must create a new API key, provide it to the integration, and then revoke access to the original key.

Next, confirm the permissions requested by the integration are assigned to your new API key. If any of the requested permissions are not assigned to the API key, assign them.

Note: If an integration requests a Harvest API key, confirm the exact permissions required. Be aware that providing permission to your data is similar to assigning a user access to the data in-app. Learn more at Manage Harvest API key permissions.

When finished, click Save

Provide the API key to your contact at the integration.