This guide walks you through the steps to gather the necessary information and configure your Greenhouse Recruiting organization for the purpose of creating an integration.

## Prerequisites

Before you begin, ensure that you have:

- Access to the Greenhouse Recruiting web interface
- Access to a Greenhouse Recruiting account with permission to manage all of the organization's API credentials


## Required Permissions

| Harvest v3 Permission | Purpose |
|  --- | --- |
| `Users` | Read data about users, activate users, and deactivate users |


## Generating Credentials

1. Log in to Greenhouse.
2. Open **Configure > Dev Center > API Credential Management**.
3. Click **Create new API credentials**.
4. For **API type**, choose **Harvest V3 (OAuth)**.
5. Choose the appropriate partner or select a custom/unlisted integration, depending on your Greenhouse setup.
6. Enter a description that identifies the Synqly integration.
7. Save the credential.
8. Copy the **Client ID** and **Client Secret** and store them securely.
9. Open the credential's permissions or scopes settings and grant access according to the required permissions above.
10. Save the credential permissions.


## Optional User ID

Leave **User ID** blank unless Greenhouse must treat the API calls as a specific human user.

- **Leave blank (default):** almost always. The Harvest v3 integration service user can read users and enable or disable them if it has the `Users` permission.
- **Set it:** when Greenhouse must audit or authorize the calls as a specific person (compliance, “who disabled this user”, or the integration service user lacks access that a Site Admin has).
- **Effect:** API requests are attributed to that Greenhouse user. An invalid User ID fails Verify on **User ID**, not on URL.
- **How to get it:** open the user in Greenhouse and copy the numeric ID or the full URL (`https://app.greenhouse.io/account/users/12345`). Both are accepted.


## Configure the Integration

Create your integration by supplying the following configuration values.

| Integration Parameter | Description |
|  --- | --- |
| Client ID | This is the Client ID generated from the steps above. |
| Client Secret | This is the Client Secret generated from the steps above. |
| User ID | Optional. Leave blank to use the credential's integration service user. Set it only if API requests must be attributed to a specific Greenhouse user. |