Create a candidate ingestion API key for an integration

Permissions: Basic and above who can manage and configure webhooks

Product tier: Available for all subscription tiers

An integration can send candidates directly to your Greenhouse Recruiting account using ingestion API. You'll need to create an ingestion API key to share with the integration. Check out the integration documentation for more information on a specific integration.

Note: Some integrations create ingestion integrations with oAuth, which requires slightly different setup steps. Make sure to consult the integration article on our Support Center for details on a specific integration.

Create an ingestion API key

Click the Configure icon screenshot of configure icon on your navigation bar, then click Dev Center.


Click API Credential Management.


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


Make the following selections:

  • API type: Choose Candidate ingestion.
  • 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.

When finished, 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.

When finished, click Save

Provide the API key to your contact at the integration.