# Integrating with Greenhouse

[Prerequisites](#prerequisites)

[Greenhouse Setup](#greenhouse-setup)\
[Step 1: Create an API key](#step-1-create-an-api-key)\
[Step 2: Assigning Relevant Permissions](#step-2-assigning-relevant-permissions)

Drivetrain uses API keys to integrate with Greenhouse, utilising the Harvest API type, which is designed to allow Greenhouse customers to push their data from Greenhouse. For more information about the Harvest API, refer to the Harvest API [documentation](https://developers.greenhouse.io/harvest.html?shell#introduction). This guide shows how to create an API key in Greenhouse and select the relevant permissions for the data you want to ingest into Drivetrain.

## Prerequisites <a href="#prerequisites" id="prerequisites"></a>

To connect Greenhouse to Drivetrain, you need:

1. An active Greenhouse Admin Account.
2. Admin Privileges in Drivetrain.

## Greenhouse Setup <a href="#greenhouse-setup" id="greenhouse-setup"></a>

### Step 1: Create an API key <a href="#step-1-create-an-api-key" id="step-1-create-an-api-key"></a>

1. Log in to your Greenhouse account, and click on the **Configure (Settings)** icon in the upper right-hand corner of any page.

<figure><img src="/files/Jc0fa8bWtfexiEVj64JY" alt=""><figcaption></figcaption></figure>

2. Click on **Dev Center** in the left panel.

<figure><img src="/files/uVIjT4OEHJiJg5M59ZVU" alt=""><figcaption></figcaption></figure>

3. Under Dev Center, Select **API Credential Management**

<figure><img src="/files/EJNyUHtJYHZu6V7IEzQQ" alt=""><figcaption></figcaption></figure>

4. Click **Create New API Key.**

<figure><img src="/files/8O89pR0s2N3LgyS4n8Dc" alt=""><figcaption></figcaption></figure>

5. Select the API type as **Harvest**, enter the description of the API key as “Drivetrain Integration API Key” and click **Manage Permissions**.

<figure><img src="/files/iSit0f2vCdWc24ZddkKV" alt=""><figcaption></figcaption></figure>

6. Click the **Copy** button, store the API key in a safe document, and then click **“I have stored the API key.”**.

<figure><img src="/files/KdVrvLYqFgkL6PUwMeiY" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
You won’t be able to copy the API key again, so make sure to store it in a safe document.
{% endhint %}

### Step 2: Assigning Relevant Permissions <a href="#step-2-assigning-relevant-permissions" id="step-2-assigning-relevant-permissions"></a>

1. Select the relevant permissions required for your solution

<figure><img src="/files/XqHAzut6fM1OzftGAhSQ" alt=""><figcaption></figcaption></figure>

2. Drivetrain accesses the following objects using the permissions defined in point 3:
   * Candidates
   * Applications
   * Jobs
   * Users
   * Interviews
   * Scorecards
   * Attachments
   * Interview Stages
   * Offers
   * Offices
   * Departments
   * Activities
   * Reject Reasons
   * Tags
3. Please find below the permissions required to access the specified objects:

| Object Name          | Permissions Required                                                                                                                                                 |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Candidates           | <p>GET: List Candidates<br>GET: Retrieve Candidates</p>                                                                                                              |
| Applications         | <p>GET: List Applications<br>GET: Retrieve Applications</p>                                                                                                          |
| Tags                 | <p>GET: List Candidate Tags<br>GET: List tags applied to candidate</p>                                                                                               |
| Users                | <p>GET: List Users<br>GET: Retrieve Users</p>                                                                                                                        |
| User Roles           | GET: List User Roles                                                                                                                                                 |
| EEOC                 | <p>GET: List EEOC<br>GET: Retrieve EEOC Data for Application</p>                                                                                                     |
| Scorecards           | <p>GET: List Scorecards<br>GET: List Scorecards for Application<br>GET: Retrieve Scorecard</p>                                                                       |
| Offers               | <p>GET: List Offers<br>GET: List Offers for Applications<br>GET: Retrieve Current Offer for Application<br>GET: Retrieve Offer</p>                                   |
| Scheduled Interviews | <p>GET: List Scheduled Interviews<br>GET: List Scheduled Interviews for Application<br>GET: Retrieve Scheduled Interview</p>                                         |
| Activity Feed        | GET: Retrieve Activity Feed                                                                                                                                          |
| Departments          | <p>GET: List Departments<br>GET: Retrieve Departments</p>                                                                                                            |
| Email Templates      | <p>GET: List Email Templates<br>GET: Retrieve Email Template</p>                                                                                                     |
| Custom Fields        | <p>GET: List Custom Fields<br>GET: Retrieve Custom Fields<br>GET: List Custom Field Options</p>                                                                      |
| Jobs                 | <p>GET: List Jobs<br>GET: Retrieve Job<br>GET: Hiring Team</p>                                                                                                       |
| Job Posts            | <p>GET: List Job Posts<br>GET: Retrieve Job Post<br>GET: List Job Posts for Job<br>GET: Retrieve Job Post for Job<br>GET: Retrieve Custom Locations for Job Post</p> |
| Job Stages           | <p>GET: List Job Stages<br>GET: List Job Stages for Job<br>GET: Retrieve Job Stage</p>                                                                               |
| Job Openings         | <p>GET: List Job Openings<br>GET: Single Opening for Job</p>                                                                                                         |
| Offices              | <p>GET: List Offices<br>GET: Retrieve Office</p>                                                                                                                     |
| Rejection Reasons    | GET: List Rejection Reasons                                                                                                                                          |
| Sources              | GET: List Sources                                                                                                                                                    |
| Close Reasons        | GET: List Close Reasons                                                                                                                                              |
| Education            | <p>GET: List Degrees<br>GET: List Disciplines<br>GET: Schools</p>                                                                                                    |
| Prospect Pool        | <p>GET: List Prospect Pools<br>GET: Retrieve Prospect Pool</p>                                                                                                       |
| Tracking Links       | GET: Tracking Link Data for Token                                                                                                                                    |
| Approvals            | <p>GET: List Approvals for Job<br>GET: Retrieve Approval Flow<br>GET: Pending Approvals for User</p>                                                                 |

4. The minimum permissions needed for this integration are under the **Users** section:
   1. GET: List Users
   2. GET: Retrieve Users

{% hint style="info" %}
That’s it. Share the API key with your Customer Success Manager.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://integrations.drivetrain.ai/integration-guide/integrate-with-drivetrain/hris-and-ats/integrating-with-greenhouse.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.