Greenhouse | API Key Authentication

In this article, we help you create an API key and link your Greenhouse account to Oyster.


  • You have completed Steps 1-3 of Connecting Greenhouse to Oyster
  • You have Admin access to your company’s account.
  • You are logged in to Greenhouse with your Admin credentials.


  1. Click the Configure (Settings) Icon on the upper right-hand corner of any page.
  1. Click Dev Center from the left nav.
  1. Click API Credential Management.
  1. Click the Create New API Key button.
  1. In th Create New Credential page, do the following:
    • Select Harvest for the API Type.
    • Type API key as the Description.
    • Click Manage Permissions.
  1. When your API key is successfully created, click the Copy button.
  2. Open a blank text file and paste the API key into it. Save the text file to your computer.

    You will not be able to access this API Key again, so do not proceed until it is saved somewhere safe!

  3. Only after you have pasted and saved the API key, then you can click the I have stored the API key button.
  1. Select your permissions.
    • Either click Select All or select the relevant permissions required for your customer.

      The minimum permissions you must select is the GET: List Users permission under Users.

  1. Return to the Greenhouse integration in your Oyster account.
  2. Paste the copied API key into the text field.
  3. Click Submit.

Greenhouse is now integrated with Oyster and appears on the My integrations tab.



Was this article helpful?

0 out of 0 found this helpful