Permissions:

Product tier: Available for the Greenhouse Onboarding subscription tier

The Greenhouse Onboarding API allows you to query and modify your employee information and query company information. In order to access your organization's Greenhouse Onboarding data via API, you'll need to create an API key.

Note: Only users with Owner level permissions can generate or delete an API key.

Create an API key

To create a new API key, navigate to Settings, then select Data Flow > API Management from the left panel.

On the API Management page, click Create a new API Key.

Screenshot of the create a new api key button.

Enter a Name for your API key in the Create a new API Key window. Click Create.

Screenshot of the create button.

Copy the Access Key and Secret Key and store them in a safe location. When you're finished, click Close.

Note: This is the only time you can view your Secret Key. This information will be unavailable once you close the Create a new API Key window.

Screenshot of the close button.

You'll find your newly created API key on the API Management page for auditing purposes.

Screenshot of the API management page.

Edit an API key

You can edit the name of your API key at any time.

From the API Management page, click on the API key you'd like to edit.

In the Edit API Key window, enter a new Name for your API key. Click Save.

Screenshot-of-edit-API-key-name.png

Delete an API key

You can also delete your API key at any time.

From the API Management page, click on the API key you'd like to delete.

In the Edit API Key window, click Delete.

Screenshot-of-delete-API-key.png

Confirm the deletion by clicking Yes, delete it.

Screenshot-of-confirm-API-key-deletion.png