API keys are used by Greenhouse customers such as us to access Greenhouse’s REST API. These keys are unique identifiers that are used to authenticate with Greenhouse’s API.

To generate an API key from Greenhouse, follow these steps:

  1. Log in to the Greenhouse dashboard using your credentials.

  2. Click on your profile then select Account Settings in the drop-down menu.

    greenhouse-api-key-instruction-1.png

  3. Select Dev Center from the left sidebar.

    greenhouse-api-key-instruction-2.png

  4. Click on the API Credential Management link.

    greenhouse-api-key-instruction-3.png

  5. Click on the Create New API Key button.

    greenhouse-api-key-instruction-4.png

  6. Enter a name for your API key and select the options displayed above.

  7. Select the appropriate permissions for the API key

    Untitled

  8. Click on the Create button.

  9. The API Key will be generated and displayed on the next screen.

    greenhouseApiKeyInstruction5.png

  10. Copy and paste the key into our tool

It is important to keep your API key safe and secure, as it grants access to your Greenhouse data. If you suspect that your API key has been compromised, you should regenerate a new key as soon as possible.

That's it! With your API key, Compa can now make requests to the Greenhouse REST API and access your data.