> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/greenhouse-integration-setup.md).

# Greenhouse Integration Setup

### Getting Started

Use this guide to connect Greenhouse to your BalkanID tenant. You will need a Harvest API key from Greenhouse and access to the Integrations section in BalkanID.

#### Requirements:

Before you begin, collect the following value from Greenhouse:

* **Harvest API key**

{% hint style="info" %}
Greenhouse displays the API key only once, when it is created. Copy it before closing the dialog; if it is lost you will need to create a new credential.
{% endhint %}

### Configure Greenhouse within your BalkanID tenant

1. To create the Harvest API key, sign in to Greenhouse as a user who can manage API credentials.
2. Click the **Configure** icon on the navigation bar, then go to **Dev Center** > **API Credential Management**.
3. Click **Create New API Key**. Set **API Type** to **Harvest**, choose the partner or select a custom integration, add a description, and click **Manage Permissions**.
4. Enable the endpoint permissions listed under [Integration Scopes](#integration-scopes) below, then save the credential.
5. Copy the generated Harvest API key and store it securely.
6. In BalkanID, go to **Integrations** and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2Fvh0hvf8vz7LhE1tvx2CB%2Fgreenhouse-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Integrations</p></figcaption></figure></div>

7. Select **Greenhouse** from the application list, then click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FdOS5veUxnAK2Z6v7erAQ%2FScreenshot%202026-08-28%20at%202.41.32%E2%80%AFAM.png?alt=media&#x26;token=7846ed28-ba7e-410c-beea-5531cc9e2f17" alt="Greenhouse selected in the Install application step of Connect a new application"><figcaption><p>Connect a new application</p></figcaption></figure></div>

8. Under **Select Extraction Type**, keep **Direct Configuration** selected and paste your key into the **Harvest API key** field, then click **Next.**

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FsgPI5IuEW6CqzCMN6V82%2Fgreenhouse-direct-configuration.png?alt=media" alt="The Direct Configuration section showing the Harvest API key field"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

9. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="The Optional Configuration step of the integration wizard"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

10. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### Integration Scopes

Greenhouse API keys start with no permissions, and each endpoint is granted individually under **Manage Permissions**. Enable every endpoint below, or the sync will fail.

| Read Only Scopes                                                                                                                                           | Lifecycle Management Scopes |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| **Users (Read)** — retrieves the people who can sign in to Greenhouse, whether each is a Site Admin, and the jobs and future jobs they hold permissions on | N/A                         |
| **User Roles (Read)** — retrieves the role catalog used to describe what a user can do on a job                                                            | N/A                         |
| **Jobs (Read)** — retrieves the jobs that user permissions are granted against                                                                             | N/A                         |
| **Offices (Read)** — resolves the office a standing future-job grant is scoped to                                                                          | N/A                         |
| **Departments (Read)** — resolves the department a standing future-job grant is scoped to                                                                  | N/A                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/greenhouse-integration-setup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.