Greenhouse Tool
Read Greenhouse recruiting/ATS data — candidates, jobs, applications, offers — via the Harvest API.
Tool ID
greenhouse-recruiting
Credential Required
Yes — an API-key credential (auth mode: basic). The credential's secret is a Greenhouse Harvest API key, generated in Greenhouse under Configure > Dev Center > API Credential Management (Harvest key). It is sent as the HTTP Basic username with an empty password — the token-as-username form Greenhouse expects. (If the credential also has a login, that is used as the Basic username with the key as the password instead.) All requests go to https://harvest.greenhouse.io/v1 — the base URL is fixed; no host input is needed.
Credential Properties
| Property | Type | Default | Description |
|---|---|---|---|
apiKey |
string | — | Required. API key / token used to authenticate — the Greenhouse Harvest API key (the credential's secret/password field is also honoured) |
A task-input apiKey is honoured as a fallback for older tasks, but the key should live in the credential vault.
Operations
1. list_candidates — List candidates
Lists candidates. Calls GET /candidates.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. One of: list_candidates, get_candidate, list_jobs, list_applications, list_offers |
query |
string | — | Optional query params as a JSON object string, e.g. {"per_page": 50, "page": 1} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
2. get_candidate — Get one candidate
Fetches a single candidate by id. Calls GET /candidates/{id}.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. |
id |
string | — | Required for this operation. Candidate id |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
3. list_jobs — List jobs
Lists job openings. Calls GET /jobs.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. |
query |
string | — | Optional query params as a JSON object string, e.g. {"per_page": 50, "page": 1} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
4. list_applications — List applications
Lists candidate applications. Calls GET /applications.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
5. list_offers — List offers
Lists offers. Calls GET /offers.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
operation |
string (enum) | — | Required. |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
Self-Contained JAR
The jar bundles all runtime dependencies; only intouch-tool-api is provided by the server.
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
completeoperationresultstatuswarning