> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/greenhouse.md).

# Greenhouse

Search Greenhouse candidates, applications and jobs, read a candidate's notes, and add one. Every list endpoint requires a Site Admin to have authorized the API credential.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| Greenhouse | Credentials    |

#### Greenhouse

Connect to Greenhouse to search candidates, applications and jobs, read the notes on a candidate, and add one. Create a Harvest V3 (OAuth) credential in Dev Center > API Credential Management and select the nine read and note scopes. The user who authorizes the credential must be a Site Admin: Greenhouse serves list endpoints only to Site Admins and returns an empty list, not an error, for anyone else.

**Set up in Greenhouse**

1. Prepare the Greenhouse account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client Secret:** Client Secret of the same Harvest V3 (OAuth) credential. Greenhouse shows it when the credential is created; if it was lost, rotate the secret from the same page. A rotated secret keeps the old one working for up to a week.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Greenhouse**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                                                                   |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Client ID     | Yes      | Enter the client id issued for the account or service you are connecting. [Provider instructions](https://harvestdocs.greenhouse.io/docs/authentication).                                                                                                                                                       |
| Client Secret | Yes      | Client Secret of the same Harvest V3 (OAuth) credential. Greenhouse shows it when the credential is created; if it was lost, rotate the secret from the same page. A rotated secret keeps the old one working for up to a week. [Provider instructions](https://harvestdocs.greenhouse.io/docs/authentication). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Greenhouse** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### List Candidates

Find candidates by email, tag, ids, or date range.

**Inputs**

| Field           | Type     | Required | Description                                                                                                                                                                                                                                                                                                                          |
| --------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Email           | string   | No       | Only the candidate with this email address.                                                                                                                                                                                                                                                                                          |
| Maximum results | integer  | No       | How many candidates to return at most. Minimum: 1. Default: 25.                                                                                                                                                                                                                                                                      |
| Tag             | string   | No       | Only candidates carrying this tag.                                                                                                                                                                                                                                                                                                   |
| Candidate ids   | string   | No       | Only these candidate ids, comma-separated (up to 50).                                                                                                                                                                                                                                                                                |
| Created from    | datetime | No       | Only candidates created at or after this time.                                                                                                                                                                                                                                                                                       |
| Created to      | datetime | No       | Only candidates created at or before this time.                                                                                                                                                                                                                                                                                      |
| Updated from    | datetime | No       | Only candidates updated at or after this time.                                                                                                                                                                                                                                                                                       |
| Updated to      | datetime | No       | Only candidates updated at or before this time.                                                                                                                                                                                                                                                                                      |
| Cursor          | string   | No       | Continue from a previous call's next cursor. Greenhouse's cursor is an opaque token copied from that response, not a value to compose by hand, and it must be sent on its own: a continued page keeps the original call's filters and limit, so changing them alongside a cursor has no effect. Leave this empty for the first page. |

**Outputs**

| Field       | Type          | Description                                       |
| ----------- | ------------- | ------------------------------------------------- |
| Candidates  | object\_array | Matching candidates.                              |
| Next cursor | string        | Pass this back as Cursor to continue, if present. |

#### Get Candidate

Fetch one candidate's full profile.

**Inputs**

| Field     | Type            | Required | Description                                                                                                                                                                                                                                                                                                |
| --------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Candidate | select (string) | Yes      | Which candidate to fetch. Pick a person from the list, which shows their name and primary email and can be searched and paged, or switch to text entry and paste the numeric candidate id from a Greenhouse profile URL such as app.greenhouse.io/people/12345. Options load from the selected connection. |

**Outputs**

| Field     | Type   | Description    |
| --------- | ------ | -------------- |
| Candidate | object | The candidate. |

#### List Applications

List applications by status, job, candidate, or stage to see the pipeline.

**Inputs**

| Field             | Type            | Required | Description                                                                                                                                                                                                                                                                                                                          |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status            | select (string) | No       | Only applications in this status. Available values: Active (in process), Rejected, Hired, Converted.                                                                                                                                                                                                                                 |
| Job               | select (string) | No       | Only applications to this job. Options load from the selected connection.                                                                                                                                                                                                                                                            |
| Candidate id      | integer         | No       | Only applications of this candidate.                                                                                                                                                                                                                                                                                                 |
| Maximum results   | integer         | No       | How many applications to return at most. Minimum: 1. Default: 25.                                                                                                                                                                                                                                                                    |
| Stage name        | string          | No       | Only applications in a stage with exactly this name. Case-sensitive, so 'Phone Screen' and 'phone screen' are not the same.                                                                                                                                                                                                          |
| Prospects only    | boolean         | No       | Only prospect applications (true) or only real applications (false).                                                                                                                                                                                                                                                                 |
| No activity since | datetime        | No       | Only applications with no activity at or after this time.                                                                                                                                                                                                                                                                            |
| Application ids   | string          | No       | Only these application ids, comma-separated (up to 50).                                                                                                                                                                                                                                                                              |
| Created from      | datetime        | No       | Only applications created at or after this time.                                                                                                                                                                                                                                                                                     |
| Created to        | datetime        | No       | Only applications created at or before this time.                                                                                                                                                                                                                                                                                    |
| Updated from      | datetime        | No       | Only applications updated at or after this time.                                                                                                                                                                                                                                                                                     |
| Updated to        | datetime        | No       | Only applications updated at or before this time.                                                                                                                                                                                                                                                                                    |
| Cursor            | string          | No       | Continue from a previous call's next cursor. Greenhouse's cursor is an opaque token copied from that response, not a value to compose by hand, and it must be sent on its own: a continued page keeps the original call's filters and limit, so changing them alongside a cursor has no effect. Leave this empty for the first page. |

**Outputs**

| Field        | Type          | Description                                       |
| ------------ | ------------- | ------------------------------------------------- |
| Applications | object\_array | Matching applications.                            |
| Next cursor  | string        | Pass this back as Cursor to continue, if present. |

#### Get Application

Fetch one application with its stage, source, and answers.

**Inputs**

| Field       | Type            | Required | Description                                                                                                                                                                                                                                                                                                                               |
| ----------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Application | select (string) | Yes      | Which application to fetch. Pick one from the list, which shows its stage and status and can be searched and paged, or switch to text entry and paste the numeric application id. Greenhouse's application list carries no candidate or job name, so options are labelled by stage and status. Options load from the selected connection. |

**Outputs**

| Field       | Type   | Description      |
| ----------- | ------ | ---------------- |
| Application | object | The application. |

#### List Jobs

List jobs by status, department, or office.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                                                                                                                                                                                                          |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Status          | select (string) | No       | Only jobs in this status. Available values: Open, Draft, Closed.                                                                                                                                                                                                                                                                     |
| Maximum results | integer         | No       | How many jobs to return at most. Minimum: 1. Default: 25.                                                                                                                                                                                                                                                                            |
| Department      | select (string) | No       | Only jobs in this department. Options load from the selected connection.                                                                                                                                                                                                                                                             |
| Office          | select (string) | No       | Only jobs in this office. Options load from the selected connection.                                                                                                                                                                                                                                                                 |
| Requisition id  | string          | No       | Only the job with this requisition id.                                                                                                                                                                                                                                                                                               |
| Confidential    | boolean         | No       | Only confidential jobs (true) or only non-confidential (false).                                                                                                                                                                                                                                                                      |
| Job ids         | string          | No       | Only these job ids, comma-separated (up to 50).                                                                                                                                                                                                                                                                                      |
| Created from    | datetime        | No       | Only jobs created at or after this time.                                                                                                                                                                                                                                                                                             |
| Created to      | datetime        | No       | Only jobs created at or before this time.                                                                                                                                                                                                                                                                                            |
| Updated from    | datetime        | No       | Only jobs updated at or after this time.                                                                                                                                                                                                                                                                                             |
| Updated to      | datetime        | No       | Only jobs updated at or before this time.                                                                                                                                                                                                                                                                                            |
| Cursor          | string          | No       | Continue from a previous call's next cursor. Greenhouse's cursor is an opaque token copied from that response, not a value to compose by hand, and it must be sent on its own: a continued page keeps the original call's filters and limit, so changing them alongside a cursor has no effect. Leave this empty for the first page. |

**Outputs**

| Field       | Type          | Description                                       |
| ----------- | ------------- | ------------------------------------------------- |
| Jobs        | object\_array | Matching jobs.                                    |
| Next cursor | string        | Pass this back as Cursor to continue, if present. |

#### List Job Stages

List the interview stages of a job in pipeline order.

**Inputs**

| Field              | Type            | Required | Description                                                                                                                                                                                                                                                                                                                          |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Job                | select (string) | Yes      | The job whose stages to list. Options load from the selected connection.                                                                                                                                                                                                                                                             |
| Maximum results    | integer         | No       | How many stages to return at most. Minimum: 1. Default: 25.                                                                                                                                                                                                                                                                          |
| Only active stages | boolean         | No       | Hide stages that are no longer active.                                                                                                                                                                                                                                                                                               |
| Cursor             | string          | No       | Continue from a previous call's next cursor. Greenhouse's cursor is an opaque token copied from that response, not a value to compose by hand, and it must be sent on its own: a continued page keeps the original call's filters and limit, so changing them alongside a cursor has no effect. Leave this empty for the first page. |

**Outputs**

| Field       | Type          | Description                                       |
| ----------- | ------------- | ------------------------------------------------- |
| Stages      | object\_array | Interview stages of the job.                      |
| Next cursor | string        | Pass this back as Cursor to continue, if present. |

#### List Users

Find Greenhouse users by email, for example to attribute a note.

**Inputs**

| Field               | Type    | Required | Description                                                                                                                                                                                                                                                                                                                          |
| ------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Primary email       | string  | No       | Only the user with this primary email.                                                                                                                                                                                                                                                                                               |
| Maximum results     | integer | No       | How many users to return at most. Minimum: 1. Default: 25.                                                                                                                                                                                                                                                                           |
| Include deactivated | boolean | No       | Also list deactivated users. Default: false.                                                                                                                                                                                                                                                                                         |
| Cursor              | string  | No       | Continue from a previous call's next cursor. Greenhouse's cursor is an opaque token copied from that response, not a value to compose by hand, and it must be sent on its own: a continued page keeps the original call's filters and limit, so changing them alongside a cursor has no effect. Leave this empty for the first page. |

**Outputs**

| Field       | Type          | Description                                       |
| ----------- | ------------- | ------------------------------------------------- |
| Users       | object\_array | Matching users.                                   |
| Next cursor | string        | Pass this back as Cursor to continue, if present. |

#### List Candidate Notes

Read the notes on a candidate's activity feed.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                                                                                                                                                                                                          |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Candidate id    | integer         | Yes      | The candidate whose notes to list.                                                                                                                                                                                                                                                                                                   |
| Maximum results | integer         | No       | How many notes to return at most. Minimum: 1. Default: 25.                                                                                                                                                                                                                                                                           |
| Type            | select (string) | No       | Only notes of this type. Available values: Note, Email, Activity, Interview, Follow up, Take home test, LinkedIn note, LinkedIn InMail, Availability request, Touchpoint, Form, Feedback.                                                                                                                                            |
| Visibility      | select (string) | No       | Only notes with this visibility: Public, Private, or Admin only. Available values: Public, Private, Admin only.                                                                                                                                                                                                                      |
| Cursor          | string          | No       | Continue from a previous call's next cursor. Greenhouse's cursor is an opaque token copied from that response, not a value to compose by hand, and it must be sent on its own: a continued page keeps the original call's filters and limit, so changing them alongside a cursor has no effect. Leave this empty for the first page. |

**Outputs**

| Field       | Type          | Description                                       |
| ----------- | ------------- | ------------------------------------------------- |
| Notes       | object\_array | Notes on the candidate.                           |
| Next cursor | string        | Pass this back as Cursor to continue, if present. |

#### Add Candidate Note

Log a note on a candidate's activity feed, for example an interview or call summary.

**Inputs**

| Field          | Type            | Required | Description                                                                                                                                                  |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Candidate id   | integer         | Yes      | The candidate to annotate.                                                                                                                                   |
| Note           | textarea        | Yes      | The note text.                                                                                                                                               |
| Subject        | string          | No       | Optional heading shown above the note.                                                                                                                       |
| Visibility     | select (string) | No       | Who can see the note. Public means anyone who can already open this candidate in Greenhouse. Available values: Public, Private, Admin only. Default: public. |
| Application id | integer         | No       | Attach the note to one of the candidate's applications.                                                                                                      |
| Author         | select (string) | No       | The Greenhouse user shown as the note's author. Options load from the selected connection.                                                                   |

**Outputs**

| Field            | Type    | Description                   |
| ---------------- | ------- | ----------------------------- |
| Note id          | integer | Id of the new note.           |
| Candidate id     | integer | The candidate.                |
| Application id   | integer | The application, if attached. |
| Note             | string  | The note text as stored.      |
| Subject          | string  | Subject as stored.            |
| Visibility       | string  | Visibility as returned.       |
| Visibility label | string  | Visibility as a label.        |
| Author id        | integer | Author user id.               |
| Created at       | string  | When the note was created.    |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/greenhouse.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
