​

Overview

To authenticate with Greenhouse (Assessment API), you need:

1. API Key - Your API Key provided or managed by your integration partner.
2. Assessment Base Url - The api base url from your integration partner.

This guide will walk you through obtaining the API Key.

​

Prerequisites:

• You must set up an account with Greenhouse.
• Details of the integration partner providing the assessment integration.

​

Step 1: Obtaining your Base Url

1. This is provided by your integration partner.

​

Step 2: Obtaining your API Key

1. Contact the integration partner (the organization providing the assessment integration) and request an API Key. Some platforms allow generating an API Key directly in their admin interface. Check their documentation for specific instructions.
2. Once you receive the API Key, click here to open a ticket with Greenhouse Support:

• Do not send your API Key in the initial ticket.
• If needed, Greenhouse Support will provide a SendSafely link for securely sharing the API Key.
• Wait for a confirmation email from Greenhouse Support. You may be required to verify your account before proceeding.
• Once Greenhouse Support has been notified that you’ve entered your API Key, they will send a confirmation email.

​

Step 3: Enter credentials in the Connect UI

Once you have your API Key and Base URL:

1. Open the form where you need to authenticate with Greenhouse (Assessment API).
2. Enter the API Key and Base URL in their respective fields.
3. Submit the form, and you should be successfully authenticated.

You are now connected to Greenhouse (Assessment API).