New260+ blocks and 240+ tools are now fully documented
DocumentationReferenceTool IntegrationsProject & Task Management
Tool

Greenhouse Tools

List candidates, jobs, and applications and fetch candidate details via the Greenhouse Harvest API

Greenhouse is an applicant tracking system (ATS) and recruiting platform. Use these tools in a workflow to read your hiring data through the Greenhouse Harvest API — list candidates, jobs, and applications, and fetch the full record for a single candidate by ID.

Overview

PropertyValue
Providergreenhouse
Categorytools
AuthAPI Key (sent as HTTP Basic Auth — the key is the username, password is empty)

Operations

OperationTool IDDescription
List candidatesgreenhouse_list_candidatesList candidates from Greenhouse, optionally filtered by job or email
Get candidategreenhouse_get_candidateGet a single candidate from Greenhouse by ID
List jobsgreenhouse_list_jobsList jobs from Greenhouse, optionally filtered by status
List applicationsgreenhouse_list_applicationsList applications from Greenhouse, optionally filtered by job or status

Configuration

greenhouse_list_candidates

ParameterTypeRequiredDescription
apiKeystringYesGreenhouse Harvest API key. Secret — visibility user-only. Sent as the Basic Auth username.
per_pagenumberNoNumber of results per page (1-500, default 100).
pagenumberNoPage number for pagination.
job_idstringNoFilter to candidates who applied to this job ID.
emailstringNoFilter to candidates with this email address.

greenhouse_get_candidate

ParameterTypeRequiredDescription
apiKeystringYesGreenhouse Harvest API key. Secret — visibility user-only. Sent as the Basic Auth username.
idstringYesThe candidate ID.

greenhouse_list_jobs

ParameterTypeRequiredDescription
apiKeystringYesGreenhouse Harvest API key. Secret — visibility user-only. Sent as the Basic Auth username.
per_pagenumberNoNumber of results per page (1-500, default 100).
pagenumberNoPage number for pagination.
statusstringNoFilter by status. One of: open, closed, draft.

greenhouse_list_applications

ParameterTypeRequiredDescription
apiKeystringYesGreenhouse Harvest API key. Secret — visibility user-only. Sent as the Basic Auth username.
per_pagenumberNoNumber of results per page (1-500, default 100).
pagenumberNoPage number for pagination.
job_idstringNoFilter applications by job ID.
statusstringNoFilter by status. One of: active, converted, hired, rejected.

Outputs

greenhouse_list_candidates

  • data (json) — Array of Greenhouse candidate objects.
  • metadata (json) — List metadata.
    • count (number) — Number of items returned.

greenhouse_get_candidate

  • data (json) — The Greenhouse candidate object.
  • metadata (json) — Candidate identifiers.
    • id (string) — Candidate ID.

greenhouse_list_jobs

  • data (json) — Array of Greenhouse job objects.
  • metadata (json) — List metadata.
    • count (number) — Number of items returned.

greenhouse_list_applications

  • data (json) — Array of Greenhouse application objects.
  • metadata (json) — List metadata.
    • count (number) — Number of items returned.

YAML Example

greenhouse_1:
  type: greenhouse
  name: "Greenhouse"
  inputs:
    operation: "greenhouse_list_candidates"
    email: "candidate@example.com"
    job_id: "654321"
    per_page: 100
    page: 1
    apiKey: "{{GREENHOUSE_API_KEY}}"
  connections:
    outgoing:
      - target: next-block-id

Tips

  • Auth setup — Greenhouse uses HTTP Basic Auth. Supply only the raw Harvest API key; the tool base64-encodes it as apiKey: (key as username, empty password) for you. Generate a Harvest key in Greenhouse under Configure → Dev Center → API Credentials, and grant it the candidate/job/application scopes you need.
  • List then fetch — Use greenhouse_list_candidates (filtered by email or job_id) to find candidate IDs, then pass an ID from {{greenhouse_1.data}} into a greenhouse_get_candidate block to retrieve the full record.
  • Pagination — All list operations accept per_page (1-500, default 100) and page. The metadata.count output tells you how many rows came back; if it equals per_page, request the next page to continue. Reference results downstream with {{greenhouse_1.data}} and {{greenhouse_1.metadata}}.
  • Status values mattergreenhouse_list_jobs expects open, closed, or draft, while greenhouse_list_applications expects active, converted, hired, or rejected. Using the wrong vocabulary for the operation returns no useful filter.