Use Greenhouse to read candidates, jobs, applications, users, and hiring-pipeline reference data. Webhook triggers can start workflows from recruiting events.
Usage Instructions
Read and manage candidates, applications, notes, attachments, and tags with Harvest v3 OAuth. Retrieve jobs, hiring teams, interviews, scorecards, offers, and configuration resources with cursor pagination. Existing Greenhouse webhooks remain available.
Actions
Greenhouse List Candidates
Lists one page of candidates with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
last_activity_at | json | No | Last activity at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
custom_field_option_id | number | No | Custom field option ID |
private | boolean | No | Candidate or custom-field privacy flag; for candidate listing, false excludes private candidates. |
email | string | No | |
tag | string | No | Tag |
Output
| Parameter | Type | Description |
|---|---|---|
candidates | array | candidates on this page |
Greenhouse Get Candidate
Retrieves one candidate by ID using the v3 list endpoint.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Create Candidate
Creates a candidate profile and optionally its first application.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
first_name | string | Yes | First name |
last_name | string | Yes | Last name |
preferred_name | string | No | Preferred name |
time_zone | string | No | Greenhouse time-zone identifier (for example, eastern time (us & canada)). |
company | string | No | Company |
title | string | No | Title |
can_email | boolean | No | Whether the candidate consents to email communication. |
phone_numbers | array | No | Phone numbers JSON array of objects with value, type. type: home, work, mobile, skype, other. |
addresses | array | No | Addresses JSON array of objects with value, type. type: home, work, other. |
email_addresses | array | No | Email addresses JSON array of objects with value, type. type: personal, work, other. |
website_addresses | array | No | Website addresses JSON array of objects with value, type. type: personal, company, portfolio, blog, other. |
social_media_addresses | array | No | Social media addresses JSON array of objects with value. |
tags | array | No | Tags JSON array of string values. |
linked_user_ids | array | No | Linked Greenhouse user IDs as a JSON array of integers. |
custom_fields | array | No | JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value. |
application | json | No | Optional first application as JSON: {job_id, initial_stage_id?, source_id?, recruiter_id?, coordinator_id?, referrer_id?, created_at?, custom_fields?}, or {prospect:true, job_ids?, prospect_pool_id?, prospect_pool_stage_id?, prospect_owner_id?, prospective_department_id?, prospective_office_id?, source_id?, recruiter_id?, coordinator_id?, referrer_id?, created_at?, custom_fields?}. |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Update Candidate
Updates selected candidate fields. Read the current candidate first: supplied arrays replace the entire existing collection. Send the complete desired array, or [] to remove all entries.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Greenhouse resource ID |
first_name | string | No | First name |
last_name | string | No | Last name |
preferred_name | string | No | Preferred name |
time_zone | string | No | Greenhouse time-zone identifier (for example, eastern time (us & canada)). |
company | string | No | Company |
title | string | No | Title |
is_private | boolean | No | Restrict candidate visibility to users with private-candidate access. |
can_email | boolean | No | Whether the candidate consents to email communication. |
phone_numbers | array | No | Phone numbers JSON array of objects with value, type. type: home, work, mobile, skype, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
addresses | array | No | Addresses JSON array of objects with value, type. type: home, work, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
email_addresses | array | No | Email addresses JSON array of objects with value, type. type: personal, work, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
website_addresses | array | No | Website addresses JSON array of objects with value, type. type: personal, company, portfolio, blog, other. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
social_media_addresses | array | No | Social media addresses JSON array of objects with value. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
tags | array | No | Tags JSON array of string values. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
linked_user_ids | array | No | Linked Greenhouse user IDs as a JSON array of integers. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
custom_fields | array | No | JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value. Read first and send the full desired collection; this replaces all existing entries. Use [] to clear it. |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Delete Candidate
Delete candidate using Greenhouse Harvest v3.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Applications
Lists one page of applications with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
candidate_ids | string | No | Candidate IDs Comma-separated values (maximum 50). |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
prospective_job_ids | string | No | Prospective job IDs Comma-separated values (maximum 50). |
job_post_ids | string | No | Job post IDs Comma-separated values (maximum 50). |
source_ids | string | No | Source IDs Comma-separated values (maximum 50). |
referrer_ids | string | No | Referrer IDs Comma-separated values (maximum 50). |
stage_ids | string | No | Stage IDs Comma-separated values (maximum 50). |
job_interview_stage_ids | string | No | Job interview stage IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
status | string | No | Status Allowed: rejected, hired, converted, active. |
stage_name | string | No | Stage name |
custom_field_option_id | number | No | Custom field option ID |
last_activity_at | json | No | Last activity at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
prospect | boolean | No | Filter by prospect status: true for prospect applications, false for candidate applications. Omit to include both. |
Output
| Parameter | Type | Description |
|---|---|---|
applications | array | applications on this page |
Greenhouse Get Application
Retrieves one application by ID using the v3 list endpoint.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Create Application
Creates a job application or prospect application for an existing candidate.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
source_id | number | No | Source ID |
recruiter_id | number | No | Recruiter ID |
coordinator_id | number | No | Coordinator ID |
referrer_id | number | No | Referrer ID |
created_at | string | No | Creation time in ISO 8601 format |
custom_fields | array | No | JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value. |
candidate_id | number | Yes | Candidate ID to create the application for. |
job_id | number | No | Job ID |
initial_stage_id | number | No | Initial stage ID |
prospect | boolean | No | Whether this is a prospect application. Set true to use prospect placement fields instead of job_id. |
job_ids | array | No | Job IDs for a prospect as a JSON array of integers. Requires prospect=true. |
prospect_pool_id | number | No | Prospect pool ID |
prospect_pool_stage_id | number | No | Prospect pool stage ID |
prospect_owner_id | number | No | Prospect owner ID |
prospective_department_id | number | No | Prospective department ID |
prospective_office_id | number | No | Prospective office ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Update Application
Update application using Greenhouse Harvest v3.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Greenhouse resource ID |
source_id | number | No | Source ID |
referrer_id | number | No | Referrer ID |
recruiter_id | number | No | Recruiter ID |
coordinator_id | number | No | Coordinator ID |
prospect_pool_id | number | No | Prospect pool ID |
prospect_stage_id | number | No | Prospect stage ID |
rejected_at | string | No | Rejected at (YYYY-MM-DD) |
created_at | string | No | Application creation date in YYYY-MM-DD format. |
custom_fields | array | No | JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value. |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Move Application
Moves or advances an application using its current stage as a guard; configured stage rules may send emails.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Greenhouse resource ID |
from_stage_id | number | Yes | Current application stage ID, required to guard against a stale move. Use stage_id from the application. |
to_stage_id | number | No | Target stage ID for a move within the current job. Use to_job_id when transferring to another job. |
to_job_id | number | No | Destination job ID when transferring the application to another job. |
email_from_user_id | number | No | User ID to send any automated stage-transition emails from. |
Output
No output fields.
Greenhouse Convert Prospect
Converts a prospect application into a new candidate application on a job already associated with the prospect.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Greenhouse resource ID |
job_id | number | Yes | Job ID already associated with the prospect or its pool. |
to_job_interview_stage_id | number | No | Target job interview stage ID; omit to use the job’s first stage. |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Reject Application
Rejects an application; optionally sends or schedules the configured rejection email.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Greenhouse resource ID |
rejection_reason_id | number | Yes | Rejection reason ID |
notes | string | No | Notes |
rejection_email | json | No | Optional JSON object {send_email_at, email_template_id, email_from_user_id}; supplying it sends or schedules a rejection email. |
custom_fields | array | No | JSON array of {name_key or custom_field_id, value}; use exactly one identifier per entry. Values follow the field type; null clears a value. JSON array of objects with name_key, custom_field_id, value. |
Output
No output fields.
Greenhouse Unreject Application
Restores a rejected application to its previous stage and clears its rejection reason and notes.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Greenhouse resource ID |
Output
No output fields.
Greenhouse Hire Application
Marks an application hired and closes its opening; provide opening_id when the job has multiple open openings.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | number | Yes | Greenhouse resource ID |
start_date | string | No | Start date (ISO 8601) |
opening_id | number | No | Opening ID; required when hiring into a job with multiple open openings. |
close_reason_id | number | No | Close reason ID |
Output
No output fields.
Greenhouse Delete Application
Delete application using Greenhouse Harvest v3.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Jobs
Lists one page of jobs with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
opened_at | json | No | Opened at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
closed_at | json | No | Closed at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
requisition_id | string | No | Requisition ID |
department_id | number | No | Department ID |
office_id | number | No | Office ID |
custom_field_option_id | number | No | Custom field option ID |
confidential | boolean | No | Confidential |
status | string | No | Status Allowed: open, draft, closed. |
Output
| Parameter | Type | Description |
|---|---|---|
jobs | array | jobs on this page |
Greenhouse Get Job
Retrieves one job by ID using the v3 list endpoint.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Job Interview Stages
Lists one page of job interview stages with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
active | boolean | No | Active |
Output
| Parameter | Type | Description |
|---|---|---|
job_interview_stages | array | job interview stages on this page |
Greenhouse List Application Stages
Lists one page of application stages with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
application_ids | string | No | Application IDs Comma-separated values (maximum 50). |
job_interview_stage_ids | string | No | Job interview stage IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
current | boolean | No | Current |
Output
| Parameter | Type | Description |
|---|---|---|
application_stages | array | application stages on this page |
Greenhouse List Job Hiring Managers
Lists one page of job hiring managers with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
user_ids | string | No | User IDs Comma-separated values (maximum 50). |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
Output
| Parameter | Type | Description |
|---|---|---|
job_hiring_managers | array | job hiring managers on this page |
Greenhouse List Job Owners
Lists one page of job owners with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
user_ids | string | No | User IDs Comma-separated values (maximum 50). |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
type | string | No | Type Allowed: sourcer, recruiter, coordinator. |
Output
| Parameter | Type | Description |
|---|---|---|
job_owners | array | job owners on this page |
Greenhouse List Openings
Lists one page of openings with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
application_ids | string | No | Application IDs Comma-separated values (maximum 50). |
close_reason_ids | string | No | Close reason IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
opened_at | json | No | Opened at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
closed_at | json | No | Closed at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
custom_field_option_id | number | No | Custom field option ID |
open | boolean | No | Open |
opening_id | string | No | Filter by the opening's identifier. |
Output
| Parameter | Type | Description |
|---|---|---|
openings | array | openings on this page |
Greenhouse List Interviews
Lists one page of interviews with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
application_ids | string | No | Application IDs Comma-separated values (maximum 50). |
job_interview_ids | string | No | Job interview IDs Comma-separated values (maximum 50). |
organizer_ids | string | No | Organizer IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
starts_at | json | No | Starts at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
ends_at | json | No | Ends at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
all_day_start_on | json | No | All day start on filter as JSON with gte, lte, gt, lt keys and YYYY-MM-DD dates, for example {"gte":"2026-01-01"}. |
all_day_end_on | json | No | All day end on filter as JSON with gte, lte, gt, lt keys and YYYY-MM-DD dates, for example {"gte":"2026-01-01"}. |
external_event_id | string | No | External event ID |
status | string | No | Status Allowed: to_be_scheduled, scheduled, awaiting_feedback, complete, skipped, collect_feedback, to_be_sent, sent, received. |
Output
| Parameter | Type | Description |
|---|---|---|
interviews | array | interviews on this page |
Greenhouse List Scorecards
Lists one page of scorecards with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
interview_kit_ids | string | No | Interview kit IDs Comma-separated values (maximum 50). |
submitter_ids | string | No | Submitter IDs Comma-separated values (maximum 50). |
application_ids | string | No | Application IDs Comma-separated values (maximum 50). |
interviewer_ids | string | No | Interviewer IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
interviewed_at | json | No | Interviewed at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
submitted_at | json | No | Submitted at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
status | string | No | Status Allowed: draft, complete. |
Output
| Parameter | Type | Description |
|---|---|---|
scorecards | array | scorecards on this page |
Greenhouse List Offers
Lists one page of offers with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
application_ids | string | No | Application IDs Comma-separated values (maximum 50). |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
candidate_ids | string | No | Candidate IDs Comma-separated values (maximum 50). |
opening_ids | string | No | Opening IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
current_only | boolean | No | Current only |
custom_field_option_id | number | No | Custom field option ID |
status | string | No | Status Allowed: Created, Accepted, Rejected, Deprecated. |
resolved_at | json | No | Resolved at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
sent_on | json | No | Sent on filter as JSON with gte, lte, gt, lt keys and YYYY-MM-DD dates, for example {"gte":"2026-01-01"}. |
starts_on | json | No | Starts on filter as JSON with gte, lte, gt, lt keys and YYYY-MM-DD dates, for example {"gte":"2026-01-01"}. |
Output
| Parameter | Type | Description |
|---|---|---|
offers | array | offers on this page |
Greenhouse List Notes
Lists one page of notes with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
candidate_ids | string | No | Candidate IDs Comma-separated values (maximum 50). |
user_ids | string | No | User IDs Comma-separated values (maximum 50). |
application_ids | string | No | Application IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
type | string | No | Type Comma-separated values (maximum 50). |
visibility | string | No | Visibility Allowed: admin_only_visible, privately_visible, publicly_visible. |
Output
| Parameter | Type | Description |
|---|---|---|
notes | array | notes on this page |
Greenhouse Create Note
Creates a candidate note or activity entry, or logs an email without sending it.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
candidate_id | number | Yes | Candidate ID whose activity feed receives the note. |
body | string | Yes | Body |
subject | string | No | Note subject; required when note_type is EMAIL. |
note_type | string | Yes | Note classification: NOTE, ACTIVITY, or EMAIL. EMAIL logs an email and requires subject, email_from, email_to, and email_cc. Allowed: EMAIL, ACTIVITY, NOTE. |
user_id | number | No | User ID |
email_from | array | No | JSON array of sender addresses, required only when note_type is EMAIL. JSON array of string values. |
email_to | array | No | JSON array of recipient addresses, required only when note_type is EMAIL. JSON array of string values. |
email_cc | array | No | JSON array of CC addresses (may be empty), required only when note_type is EMAIL. JSON array of string values. |
visibility | string | Yes | Visibility Allowed: admin_only, private, public. |
application_id | number | No | Application ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Attachments
Lists one page of attachments with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
application_ids | string | No | Application IDs Comma-separated values (maximum 50). |
candidate_ids | string | No | Candidate IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
type | string | No | Type Allowed: resume, cover_letter, take_home_test, offer_packet, offer_letter, signed_offer_letter, other, form_attachment, midfunnel_agreement, automated_agreement. |
Output
| Parameter | Type | Description |
|---|---|---|
attachments | array | attachments on this page |
Greenhouse Create Attachment
Attaches a file to an application. A new resume or cover letter reclassifies the previous attachment of that type as other.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
application_id | number | Yes | Application ID |
filename | string | Yes | Filename |
type | string | Yes | Type Allowed: resume, cover_letter, take_home_test, offer_packet, offer_letter, signed_offer_letter, other, form_attachment, midfunnel_agreement, automated_agreement. |
content | string | No | Base64-encoded attachment content. Supply exactly one of content or url. |
url | string | No | Public attachment URL for Greenhouse to fetch. Supply exactly one of url or content. |
visibility | string | No | Visibility Allowed: admin_only, private, public. |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Delete Attachment
Delete attachment using Greenhouse Harvest v3.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Candidate Tags
Lists one page of candidate tags with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
Output
| Parameter | Type | Description |
|---|---|---|
candidate_tags | array | candidate tags on this page |
Greenhouse Create Candidate Tag
Create candidate tag using Greenhouse Harvest v3.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Applied Candidate Tags
Lists one page of applied candidate tags with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
candidate_tag_ids | string | No | Candidate tag IDs Comma-separated values (maximum 50). |
candidate_ids | string | No | Candidate IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
Output
| Parameter | Type | Description |
|---|---|---|
applied_candidate_tags | array | applied candidate tags on this page |
Greenhouse Apply Candidate Tag
Apply candidate tag using Greenhouse Harvest v3.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
candidate_id | number | Yes | Candidate ID to tag. |
candidate_tag_id | number | Yes | Candidate tag ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse Remove Candidate Tag
Removes an applied tag by its applied_candidate_tags row ID, leaving the tag dictionary intact.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Candidate Educations
Lists one page of candidate educations with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
candidate_ids | string | No | Candidate IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
start_at | json | No | Start at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
end_at | json | No | End at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. |
latest | boolean | No | Latest |
Output
| Parameter | Type | Description |
|---|---|---|
candidate_educations | array | candidate educations on this page |
Greenhouse List Candidate Employments
Lists one page of candidate employments with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
candidate_ids | string | No | Candidate IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
latest | boolean | No | Latest |
Output
| Parameter | Type | Description |
|---|---|---|
candidate_employments | array | candidate employments on this page |
Greenhouse List Users
Lists one page of users with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
agency_ids | string | No | Agency IDs Comma-separated values (maximum 50). |
office_ids | string | No | Office IDs Comma-separated values (maximum 50). |
department_ids | string | No | Department IDs Comma-separated values (maximum 50). |
linked_candidate_ids | string | No | Linked candidate IDs Comma-separated values (maximum 50). |
interviewer_tag_ids | string | No | Interviewer tag IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
employee_ids | string | No | Employee IDs Comma-separated values (maximum 50). |
custom_field_option_id | number | No | Custom field option ID |
deactivated | boolean | No | Deactivated |
primary_email | string | No | Primary email |
external_office_id | string | No | External office ID |
external_department_id | string | No | External department ID |
show_service_accounts | boolean | No | Show service accounts |
Output
| Parameter | Type | Description |
|---|---|---|
users | array | users on this page |
Greenhouse Get User
Retrieves one user by ID using the v3 list endpoint.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Greenhouse resource ID |
Output
| Parameter | Type | Description |
|---|---|---|
message | string | Message returned by Harvest v3 |
application_stages | json | Application Stages records (id, created_at, updated_at, application_id, job_interview_stage_id, entered_at, exited_at, days_in_stage, current) |
count | number | Records returned on this page |
nextCursor | string | Opaque cursor from the next Link header; null at the end |
hasMore | boolean | Whether another page is available |
applications | json | Applications records (id, created_at, updated_at, agency_note_id, candidate_id, coordinator_id, job_id, job_post_id, recruiter_id, referrer_id, rejection_reason_id, source_id, stage_id, job_interview_stage_id, stage_name, status, needs_decision, prospect, rejected_at, last_activity_at, location_address, answers, prospective_job_ids, custom_fields) |
id | number | Id returned by Harvest v3 |
created_at | string | Created At returned by Harvest v3 |
updated_at | string | Updated At returned by Harvest v3 |
agency_note_id | number | Agency Note ID returned by Harvest v3 |
candidate_id | number | Candidate ID returned by Harvest v3 |
coordinator_id | number | Coordinator ID returned by Harvest v3 |
job_id | number | Job ID returned by Harvest v3 |
job_post_id | number | Job Post ID returned by Harvest v3 |
recruiter_id | number | Recruiter ID returned by Harvest v3 |
referrer_id | number | Referrer ID returned by Harvest v3 |
rejection_reason_id | number | Rejection Reason ID returned by Harvest v3 |
source_id | number | Source ID returned by Harvest v3 |
stage_id | number | Stage ID returned by Harvest v3 |
job_interview_stage_id | number | Job Interview Stage ID returned by Harvest v3 |
stage_name | string | Stage Name returned by Harvest v3 |
status | string | Status returned by Harvest v3 |
needs_decision | boolean | Needs Decision returned by Harvest v3 |
prospect | boolean | Prospect returned by Harvest v3 |
rejected_at | string | Rejected At returned by Harvest v3 |
last_activity_at | string | Last Activity At returned by Harvest v3 |
location_address | string | Location Address returned by Harvest v3 |
answers | json | Answers returned by Harvest v3 |
prospective_job_ids | json | Prospective Job IDs returned by Harvest v3 |
custom_fields | json | Custom Fields returned by Harvest v3 |
applied_candidate_tags | json | Applied Candidate Tags records (id, created_at, updated_at, candidate_tag_id, candidate_id) |
attachments | json | Attachments records (id, created_at, updated_at, application_id, candidate_id, type, filename, url) |
candidate_educations | json | Candidate Educations records (id, created_at, updated_at, candidate_id, school_name_custom_field_option_id, degree_custom_field_option_id, discipline_custom_field_option_id, start_at, end_at, latest, start_date_month, start_date_year, end_date_month, end_date_year) |
candidate_employments | json | Candidate Employments records (id, created_at, updated_at, candidate_id, company_name, title, start_date, end_date, latest) |
candidate_tags | json | Candidate Tags records (id, created_at, updated_at, name) |
candidates | json | Candidates records (id, created_at, updated_at, first_name, last_name, preferred_name, company, title, last_activity_at, private, can_email, time_zone, tags, linked_user_ids, phone_numbers, addresses, email_addresses, website_addresses, social_media_addresses, custom_fields) |
first_name | string | First Name returned by Harvest v3 |
last_name | string | Last Name returned by Harvest v3 |
preferred_name | string | Preferred Name returned by Harvest v3 |
company | string | Company returned by Harvest v3 |
title | string | Title returned by Harvest v3 |
private | boolean | Private returned by Harvest v3 |
can_email | boolean | Can Email returned by Harvest v3 |
time_zone | string | Time Zone returned by Harvest v3 |
tags | json | Tags returned by Harvest v3 |
linked_user_ids | json | Linked User IDs returned by Harvest v3 |
phone_numbers | json | Phone Numbers returned by Harvest v3 |
addresses | json | Addresses returned by Harvest v3 |
email_addresses | json | Email Addresses returned by Harvest v3 |
website_addresses | json | Website Addresses returned by Harvest v3 |
social_media_addresses | json | Social Media Addresses returned by Harvest v3 |
close_reasons | json | Close Reasons records (id, created_at, updated_at, name) |
custom_field_options | json | Custom Field Options records (id, created_at, updated_at, custom_field_id, name, external_id, sort_order, active) |
departments | json | Departments records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id) |
email_templates | json | Email Templates records (id, created_at, updated_at, email_type, subject, body, user_id, name, description, recipients, default, html_body, office_anywhere, from_type, cc_recruiter, cc_coordinator) |
interviews | json | Interviews records (id, created_at, updated_at, job_id, application_id, job_interview_id, starts_at, ends_at, location, status, organizer_id, scheduled_at, all_day_start_on, all_day_end_on, external_event_id, video_conferencing_url, availability_received_at) |
job_hiring_managers | json | Job Hiring Managers records (id, created_at, updated_at, user_id, job_id) |
job_interview_stages | json | Job Interview Stages records (id, created_at, updated_at, job_id, sort_order, name, active) |
job_owners | json | Job Owners records (id, created_at, updated_at, job_id, user_id, type, responsible) |
jobs | json | Jobs records (id, created_at, updated_at, name, requisition_id, notes, confidential, status, opened_at, closed_at, is_template, copied_from_id, department_id, external_department_id, office_ids, external_office_ids, custom_fields) |
name | string | Name returned by Harvest v3 |
requisition_id | string | Requisition ID returned by Harvest v3 |
notes | json | Notes returned by Harvest v3 |
confidential | boolean | Confidential returned by Harvest v3 |
opened_at | string | Opened At returned by Harvest v3 |
closed_at | string | Closed At returned by Harvest v3 |
is_template | boolean | Is Template returned by Harvest v3 |
copied_from_id | number | Copied From ID returned by Harvest v3 |
department_id | number | Department ID returned by Harvest v3 |
external_department_id | string | External Department ID returned by Harvest v3 |
office_ids | json | Office IDs returned by Harvest v3 |
external_office_ids | json | External Office IDs returned by Harvest v3 |
offers | json | Offers records (id, created_at, updated_at, version, application_id, job_id, candidate_id, opening_id, status, starts_on, sent_on, resolved_at, custom_fields) |
offices | json | Offices records (id, created_at, updated_at, name, parent_id, external_id, external_parent_id, location, primary_in_house_contact_user_id) |
openings | json | Openings records (id, created_at, updated_at, job_id, opened_at, closed_at, sort_order, opening_id, application_id, close_reason_id, target_start_on, open, custom_fields) |
prospect_pool_stages | json | Prospect Pool Stages records (id, created_at, updated_at, prospect_pool_id, name, sort_order) |
prospect_pools | json | Prospect Pools records (id, created_at, updated_at, name, active, description, department_ids, office_ids, job_ids) |
referrers | json | Referrers records (id, created_at, updated_at, user_id, name) |
rejection_reasons | json | Rejection Reasons records (id, created_at, updated_at, name, type) |
scorecards | json | Scorecards records (id, created_at, updated_at, interview_kit_id, interviewer_id, interviewed_at, notes, notes_with_tags, submitter_id, candidate_rating, private_notes, private_notes_with_tags, status, public_notes, public_notes_with_tags, application_id, submitted_at) |
sources | json | Sources records (id, created_at, updated_at, name, type) |
users | json | Users records (id, created_at, updated_at, first_name, last_name, primary_email, job_title, agency_id, name, deactivated, site_admin, employee_id, linked_candidate_ids, office_ids, department_ids, external_office_ids, external_department_ids, interviewer_tags, emails, custom_fields) |
primary_email | string | Primary Email returned by Harvest v3 |
job_title | string | Job Title returned by Harvest v3 |
agency_id | number | Agency ID returned by Harvest v3 |
deactivated | boolean | Deactivated returned by Harvest v3 |
site_admin | boolean | Site Admin returned by Harvest v3 |
employee_id | string | Employee ID returned by Harvest v3 |
linked_candidate_ids | json | Linked Candidate IDs returned by Harvest v3 |
department_ids | json | Department IDs returned by Harvest v3 |
external_department_ids | json | External Department IDs returned by Harvest v3 |
interviewer_tags | json | Interviewer Tags returned by Harvest v3 |
emails | json | Emails returned by Harvest v3 |
candidate_tag_id | number | Candidate Tag ID returned by Harvest v3 |
application_id | number | Application ID returned by Harvest v3 |
type | string | Type returned by Harvest v3 |
filename | string | Filename returned by Harvest v3 |
url | string | Url returned by Harvest v3 |
candidate | json | Created candidate profile with id, names, contact arrays, tags, privacy, custom fields, and timestamps |
application | json | Optional first application with id, candidate_id, job_id, stage, status, source, recruiter, and timestamps; null when not created |
body | string | Body returned by Harvest v3 |
subject | string | Subject returned by Harvest v3 |
user_id | number | User ID returned by Harvest v3 |
email_from | string | Email From returned by Harvest v3 |
email_to | string | Email To returned by Harvest v3 |
email_cc | json | Email Cc returned by Harvest v3 |
import_hash | string | Import Hash returned by Harvest v3 |
body_with_tags | string | Body With Tags returned by Harvest v3 |
visibility | string | Visibility returned by Harvest v3 |
email_attachment_file_names | string | Email Attachment File Names returned by Harvest v3 |
Greenhouse List Departments
Lists one page of departments with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
parent_id | number | No | Parent ID |
external_id | string | No | External ID |
Output
| Parameter | Type | Description |
|---|---|---|
departments | array | departments on this page |
Greenhouse List Offices
Lists one page of offices with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
parent_id | number | No | Parent ID |
external_id | string | No | External ID |
Output
| Parameter | Type | Description |
|---|---|---|
offices | array | offices on this page |
Greenhouse List Sources
Lists one page of sources with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
Output
| Parameter | Type | Description |
|---|---|---|
sources | array | sources on this page |
Greenhouse List Referrers
Lists one page of referrers with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
user_ids | string | No | User IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
Output
| Parameter | Type | Description |
|---|---|---|
referrers | array | referrers on this page |
Greenhouse List Rejection Reasons
Lists one page of rejection reasons with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
include_defaults | boolean | No | Include defaults |
Output
| Parameter | Type | Description |
|---|---|---|
rejection_reasons | array | rejection reasons on this page |
Greenhouse List Close Reasons
Lists one page of close reasons with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
Output
| Parameter | Type | Description |
|---|---|---|
close_reasons | array | close reasons on this page |
Greenhouse List Prospect Pools
Lists one page of prospect pools with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
department_ids | string | No | Department IDs Comma-separated values (maximum 50). |
office_ids | string | No | Office IDs Comma-separated values (maximum 50). |
job_ids | string | No | Job IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
active | boolean | No | Active |
Output
| Parameter | Type | Description |
|---|---|---|
prospect_pools | array | prospect pools on this page |
Greenhouse List Prospect Pool Stages
Lists one page of prospect pool stages with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
prospect_pool_ids | string | No | Prospect pool IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
Output
| Parameter | Type | Description |
|---|---|---|
prospect_pool_stages | array | prospect pool stages on this page |
Greenhouse List Custom Fields
Lists one page of custom fields with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
field_type | string | No | Field type Allowed: job, opening, standard, offer, compensation_frequency, candidate, referral_question, application, rejection_question, form, agency_question, user_attribute. |
active | boolean | No | Active |
name | string | No | Name |
name_key | string | No | Name key |
Output
| Parameter | Type | Description |
|---|---|---|
custom_fields | array | custom fields on this page |
Greenhouse List Custom Field Options
Lists one page of custom field options with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
custom_field_ids | string | No | Custom field IDs Comma-separated values (maximum 50). |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
active | boolean | No | Active |
custom_field_key | string | No | Custom field key |
Output
| Parameter | Type | Description |
|---|---|---|
custom_field_options | array | custom field options on this page |
Greenhouse List Email Templates
Lists one page of email templates with cursor pagination and documented filters.
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | No | Opaque nextCursor from the previous page. When set, all other filters and per_page are ignored. |
per_page | number | No | Page size from 1 to 500 (default 100). Each call retrieves one page. |
ids | string | No | Ids Comma-separated values (maximum 50). |
created_at | json | No | Created at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with updated_at. |
updated_at | json | No | Updated at filter as JSON with gte, lte, gt, lt keys and ISO 8601 values, for example {"gte":"2026-01-01T00:00:00Z"}. Cannot be combined with created_at. |
fields | string | No | Comma-separated response field names. Omit to return all documented fields. Comma-separated values (maximum 50). |
email_type | string | No | Email type |
from_type | string | No | From type Allowed: user_email, organization_email, my_email_address, inviter, organizer, not_applicable. |
Output
| Parameter | Type | Description |
|---|---|---|
email_templates | array | email templates on this page |
Triggers
A Trigger is a block that starts a workflow when an event happens in this service.
Greenhouse Candidate Hired
Trigger workflow when a candidate is hired
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type (hire_candidate) |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | object | payload output from the tool |
↳ application | object | application output from the tool |
↳ id | number | Application ID |
↳ status | string | Application status |
↳ prospect | boolean | Whether the applicant is a prospect |
↳ applied_at | string | When the application was submitted |
↳ url | string | Application URL in Greenhouse |
↳ current_stage | object | current_stage output from the tool |
↳ id | number | Current stage ID |
↳ name | string | Current stage name |
↳ candidate | object | candidate output from the tool |
↳ id | number | Candidate ID |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ title | string | Current title |
↳ company | string | Current company |
↳ email_addresses | json | Email addresses |
↳ phone_numbers | json | Phone numbers |
↳ recruiter | json | Assigned recruiter |
↳ coordinator | json | Assigned coordinator |
↳ jobs | json | Associated jobs (array) |
↳ source | object | source output from the tool |
↳ id | number | Source ID |
↳ name | string | Source name when provided by Greenhouse |
↳ public_name | string | Public-facing source name when provided by Greenhouse |
↳ offer | object | offer output from the tool |
↳ id | number | Offer ID |
↳ version | number | Offer version |
↳ starts_at | string | Offer start date |
↳ custom_fields | json | Offer custom fields |
↳ custom_fields | json | Application custom fields |
Greenhouse Candidate Rejected
Trigger workflow when a candidate is rejected
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type (reject_candidate) |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | object | payload output from the tool |
↳ application | object | application output from the tool |
↳ id | number | Application ID |
↳ status | string | Application status (rejected) |
↳ prospect | boolean | Whether the applicant is a prospect |
↳ applied_at | string | When the application was submitted |
↳ rejected_at | string | When the candidate was rejected |
↳ url | string | Application URL in Greenhouse |
↳ current_stage | object | current_stage output from the tool |
↳ id | number | Stage ID where rejected |
↳ name | string | Stage name where rejected |
↳ candidate | object | candidate output from the tool |
↳ id | number | Candidate ID |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ email_addresses | json | Email addresses |
↳ phone_numbers | json | Phone numbers |
↳ jobs | json | Associated jobs (array) |
↳ rejection_reason | json | Rejection reason object with id, name, and type fields |
↳ rejection_details | json | Rejection details with custom fields |
↳ custom_fields | json | Application custom fields |
Greenhouse Candidate Stage Change
Trigger workflow when a candidate changes interview stages
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type (candidate_stage_change) |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | object | payload output from the tool |
↳ application | object | application output from the tool |
↳ id | number | Application ID |
↳ status | string | Application status |
↳ prospect | boolean | Whether the applicant is a prospect |
↳ applied_at | string | When the application was submitted |
↳ url | string | Application URL in Greenhouse |
↳ current_stage | object | current_stage output from the tool |
↳ id | number | Current stage ID |
↳ name | string | Current stage name |
↳ interviews | json | Interviews in this stage |
↳ candidate | object | candidate output from the tool |
↳ id | number | Candidate ID |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ title | string | Current title |
↳ company | string | Current company |
↳ email_addresses | json | Email addresses |
↳ phone_numbers | json | Phone numbers |
↳ jobs | json | Associated jobs (array) |
↳ source | object | source output from the tool |
↳ id | number | Source ID |
↳ name | string | Source name when provided by Greenhouse |
↳ public_name | string | Public-facing source name when provided by Greenhouse |
↳ custom_fields | json | Application custom fields |
Greenhouse Job Created
Trigger workflow when a new job is created
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type (job_created) |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | object | payload output from the tool |
↳ job | object | job output from the tool |
↳ id | number | Job ID |
↳ name | string | Job title |
↳ requisition_id | string | Requisition ID |
↳ status | string | Job status (open, closed, draft) |
↳ confidential | boolean | Whether the job is confidential |
↳ created_at | string | When the job was created |
↳ opened_at | string | When the job was opened |
↳ closed_at | string | When the job was closed |
↳ departments | json | Associated departments |
↳ offices | json | Associated offices |
↳ hiring_team | json | Hiring team (managers, recruiters, etc.) |
↳ openings | json | Job openings |
↳ custom_fields | json | Custom field values |
Greenhouse Job Updated
Trigger workflow when a job is updated
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type (job_updated) |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | object | payload output from the tool |
↳ job | object | job output from the tool |
↳ id | number | Job ID |
↳ name | string | Job title |
↳ requisition_id | string | Requisition ID |
↳ status | string | Job status (open, closed, draft) |
↳ confidential | boolean | Whether the job is confidential |
↳ created_at | string | When the job was created |
↳ opened_at | string | When the job was opened |
↳ closed_at | string | When the job was closed |
↳ departments | json | Associated departments |
↳ offices | json | Associated offices |
↳ hiring_team | json | Hiring team (managers, recruiters, etc.) |
↳ openings | json | Job openings |
↳ custom_fields | json | Custom field values |
Greenhouse New Application
Trigger workflow when a new application is submitted
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type (new_candidate_application) |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | object | payload output from the tool |
↳ application | object | application output from the tool |
↳ id | number | Application ID |
↳ status | string | Application status |
↳ prospect | boolean | Whether the applicant is a prospect |
↳ applied_at | string | When the application was submitted |
↳ url | string | Application URL in Greenhouse |
↳ current_stage | object | current_stage output from the tool |
↳ id | number | Current stage ID |
↳ name | string | Current stage name |
↳ candidate | object | candidate output from the tool |
↳ id | number | Candidate ID |
↳ first_name | string | First name |
↳ last_name | string | Last name |
↳ title | string | Current title |
↳ company | string | Current company |
↳ created_at | string | When the candidate was created |
↳ email_addresses | json | Email addresses |
↳ phone_numbers | json | Phone numbers |
↳ tags | json | Candidate tags |
↳ jobs | json | Associated jobs (array) |
↳ source | object | source output from the tool |
↳ id | number | Source ID |
↳ name | string | Source name when provided by Greenhouse |
↳ public_name | string | Public-facing source name when provided by Greenhouse |
↳ answers | json | Application question answers |
↳ attachments | json | Application attachments |
↳ custom_fields | json | Application custom fields |
Greenhouse Offer Created
Trigger workflow when a new offer is created
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type (offer_created) |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | object | payload output from the tool |
↳ id | number | Offer ID |
↳ application_id | number | Associated application ID |
↳ job_id | number | Associated job ID |
↳ user_id | number | User who created the offer |
↳ version | number | Offer version number |
↳ sent_on | string | When the offer was sent |
↳ resolved_at | string | When the offer was resolved |
↳ start_date | string | Offer start date |
↳ notes | string | Offer notes |
↳ offer_status | string | Offer status |
↳ custom_fields | json | Custom field values |
Greenhouse Webhook (Endpoint Events)
Trigger on whichever event types you select for this URL in Greenhouse. Agent Serve does not filter deliveries for this trigger.
Configuration
| Parameter | Type | Required | Description |
|---|---|---|---|
secretKey | string | No | When set, requests must include a valid Signature header (HMAC-SHA256). If left empty, the endpoint does not verify signatures—only use on a private URL you fully control. |
Output
| Parameter | Type | Description |
|---|---|---|
action | string | The webhook event type |
applicationId | number | Application id when present (payload.application.id or flat payload.application_id on offers) |
candidateId | number | Candidate id when payload.application.candidate.id is present |
jobId | number | Job id from payload.job.id or flat payload.job_id when present |
payload | json | Full event payload |