The answers provided to the questions in the job post for this application. Array contains the text value of the question and answer. Answers are always plaintext strings. Booleans will return Yes or No.

An array of attachments to be uploaded to this application. See Add Attachment for parameters.

The ID of the candidate who is applying for this job.

The ID of the user who will receive credit for this application.

The current stage that this application is in.

Contains a hash of the custom fields configured for this resource. The properties in this hash reflect the active custom fields as of the time this method is called.

The ID of the job stage this application will be created in. Only applicable when create Aplication from Candidate (without field `prospect`).

The ID of the job you want to create an application to for this candidate. Only applicable when create Aplication from Candidate (without field `prospect`).

An optional array of Job IDs to consider this prospect for. Only applicable when create Aplication from Prospect (with field `prospect` equal `true`).

An array containing the job that the candidate applied for.

This contains the same information as custom_fields but formatted in a different way that includes more information. This will tell you the type of custom field data to expect, the text name of custom field, and the value. The key of this hash is the custom field’s immutable field key, which will not change even if the name of the custom field is changed in Greenhouse.

The contents of the location question on a job post.

If true, this is a prospect application which means that the associated person is a prospect and has not yet applied for this job..

User ID of the prospect owner. Only applicable when create Aplication from Prospect (with field `prospect` equal `true`).

Prospect Pool ID. Only applicable when create Aplication from Prospect (with field `prospect` equal `true`).

Prospect Pool Stage ID. prospect_pool_id is required, and the prospect pool stage must belong to the given prospect pool. Only applicable when create Aplication from Prospect (with field `prospect` equal `true`).

The department that this prospect application is being considered for.

Department ID to consider this prospect for.

The office that this prospect application is being considered for.

Office ID to consider this prospect for. prospective_department_id is required in order to set a prospective office.

A string representing the type of referrer: 'id’, 'email’, or 'outside’

The id of the user who made the referral (not the referrer id)

The id of the source to be credited for this application

One of: active, rejected, hired, converted.

Applications

Use this field only for creating candidate with type "prospect"

Array of application IDs associated with this candidate. Can contain none, one, or several application IDs.

This is required field to create candidate with type "candidate"

The company at which the candidate currently works

The coordinator user who is responsible for this candidate.

This field is applicable for candidates with type "candidate"

Whether the candidate is private or not. One of: [“true”, “false”]

Contains the same information as custom_fields but formatted in a different way that includes more information. This will tell you the type of custom field data to expect, the text name of custom field, and the value. The key of this hash is the custom field’s immutable field key, which will not change even if the name of the custom field is changed in Greenhouse.

If the candidate is an internal applicant, this returns the Greenhouse user ID of the candidate.

Note: this field has been removed from Greenhouse and will always be null. For backwards compatibility, the field will remain in API payloads

The recruiter user who is responsible for this candidate.

Candidates

An arbitrary ID provided by an external source; does not map to another entity in Greenhouse.

The external_ids of this department’s children. Note the order of this array may not match the order of the child_ids array. If there are five children and none of them have parent ids, this array will contain five null indices.

The external_id of this department’s parent.

Departments

Interviews

The application that was used to fill this opening. This should only be set on a closed opening, null otherwise.

This is when the opening was closed; usually via the opening being filled. This should be null for opened openings.

These are the custom fields that are specific to openings. This index, along with keyed_custom_fields, may not be included if your organization does not have access to custom fields on openings.

This is the date and time this opening was created.

This is a text string used to identify the opening. This is defined by the users and may be null.

Job Openings

If false, this job post has been deleted.

The text of the job post as posted to the external job board.

The demographic question set associated with this job post

If true, this job post has been posted (or is to be posted) on an external job board.

Timestamp when this job post was first set to live.

If true, this job post has been posted (or is to be posted) on an internal job board.

The text of the job post if posted to the internal job board, if different than the external job board.

If true, this job post status is set to live.

An array of questions associated with this job post.

Job Posts

The job stage's active status. true - The job stage is active, false - The job stage was deleted

An array of interview steps associated with this job stage

Numeric field used for ordering, with the lowest values ordered first. For example, priority 0 indicates the first stage on a job

"200" Response schema

Job Stages

One of true, false. If the job is confidential or not.

Contains any custom job fields which have been defined by your organization.

An array containing the department which this job belongs to.

Lists the names and User IDs of the hiring managers, recruiters, coordinators and sourcers associated with this job. For recruiters and coordinators, there is a responsible boolean flag which indicates that the user is the responsible recruiter or coordinator for this job.

An array containing the offices this job is associated with.

Lists the openings associated with this job.

An arbitrary ID provided by an external source; does not map to another entity within Greenhouse.

Jobs

The ID of the associated application

Custom Fields

The offer’s unique identifier

Keyed Custom Fields

Date when this offer was resolved (e.g. when it was accepted, rejected).

Date when this offer was sent to the candidate.

Date when the candidate starts. This is the date value entered in the default Start Date field on candidate’s Offer Details. This is the first field on their Offer Details, above the custom fields.

One of: unresolved, accepted, rejected, deprecated.

Status

The version number of this offer. When an existing offer is updated, a new one is typically created with an incremented version.

The version number of this offer

Offers

The external_ids of this office’s children. Note the order of this array may not match the order of the child_ids array. If there are five children and none of them have parent ids, this array will contain five null indices.

The external_id of this office’s parent.

Offices

Prospect Pools

An array containing the users who have interviews with this candidate, including, if applicable, the ID of the scorecard they completed, and the interviewer’s response_status

The user who is the organizer for this interview

One of: scheduled, awaiting_feedback, complete

The URL used for video interviews, such as Zoom, Google Meets, or Microsoft Teams.

Scheduled Interviews

Scorecards

Users

Greenhouse Harvest

Retrieve the specific tracking link data for the supplied token.

Create a new prospect. A prospect can be on no jobs or many jobs and cannot be added to a job stage. When a prospect is ready to be added to a job stage, they can be converted to a candidate in Greenhouse.

Add Prospect

List Offices

Add Office

Retrieve Office

Edit Office

List all of an organization's candidate tags

Add a new candidate tag to this organization

Removes a candidate tag from this organization

List tags applied to candidate

Apply a tag to a given candidate

Remove a tag from a candidate

List the organization's roles that can be assigned to a user.

List User Roles

List the job permissions for a given user.

List Job Permissions

Remove a Job Permission

Creates a job permission with a specific user role for a given user.

Add a Job Permission

List the permissions that will be granted to the user when a job is created in a particular Department/Office combination.

List Future Job Permissions

Remove a Future Job Permission

Creates a future job permission with a specific user role for a given user.

Add a Future Job Permission

Lists an organization's sources, grouped by strategy.

List Sources

List all of an organization's scorecards.

List Scorecards

List all submitted scorecards for the requested application.

List Scorecards for Application

Retrieve Scorecard

List Scheduled Interviews

Create Scheduled Interview

Retrieve Scheduled Interview

Remove Scheduled Interview

Update Scheduled Interview

List Scheduled Interviews for Application

Merge two candidates into one, where the duplicate candidate will cease to exist after the merge is complete.

Merge two candidates into one

List all of an organization's rejection reasons.

List Rejection Reasons

Returns a list of prospect pools with their details.

List all of an organization's prospect pools

Returns a single prospect pool with its details.

Retrieve a specific prospect pool

This method adds new hiring team members to a job. If a user is designated as responsible for future candidates and a responsible user already exists, the new user will become the responsible user and the old user will no longer be responsible. This endpoint is transactional, if any items fail to add, the entire request will fail and no changes will be made.

Add Hiring Team Members

This method removes hiring team members with the designated user ids from the designated type. If a user id is provided that does not exist in the hiring team of that type, it will be ignored and no error will be raised. Disabled and inactive users can be removed with this endpoint, but you will be unable to re-add them.

Remove Hiring Team Member

Replaces the existing members of the hiring team for a job with the provided team members. If any type of team member is not included, their membership will not be changed. An empty list for any type will remove all users of that type. This method is transactional and will remove disabled and inactive users, who cannot be re-added.

Replace Hiring Team

Get the hiring team for a specific job

Anonymize the data associated with a candidate.

Anonymize Candidate

All offers made by an organization ordered by application_id.

List Offers

List the offers associated with an application. Greenhouse keeps offer history as updates are made over time.

List Offers for Application

Fetch the current offer for an application.

Retrieve Current Offer for Application

Update the current offer on the given application. The response will only tell you if the update succeeded.

Update Current Offer

Retrieve Offer

Delete an employment record by candidate and employment id.

Remove Employment From Candidate

Create a new employment record for a candidate

Creates a new job using a template job ID and other optional parameters.

Create a new job

List all of an organization's jobs

Delete an education record by candidate and education id.

Remove Education From Candidate

Add Education to a Candidate

List all of an organization's job stages.

List Job Stages

Retrieve the stages for the specified job id.

List Job Stages for Job

Retrieve Job Stage

Add E-mail Note to a Candidate

Add Note to a Candidate

Updates the specified job with the provided details.

Update a job

Retrieve Job

Add Candidate

Retrieves a list of candidates. Supports pagination.

List Candidates

List Job Posts

Retrieve Job Post

List all the corresponding job posts for a given Job ID.

List Job Posts for Job

List all the custom location options available for a given job post ID.

Retrieve Custom Locations for Job Post

Post an attachment to a candidate's profile by the candidate `id`.

Add Attachment to a Candidate

List Job Openings

Create one or more new openings for a job.

Create New Openings

Destroy Openings

Retrieve the information for a single opening.

Field Name	API Key	Type	Description
Query	query	object
Data	data	object
First Name	data.first_name	string	The prospect's first name
Last Name	data.last_name	string	The prospect's last name
Company	data.company	string	The prospect's company

Field Name	API Key	Type
Id	id	integer
First Name	first_name	string
Last Name	last_name	string
Company	company	string
Title	title	string

Greenhouse Harvest API Integration Profile

Add Prospect in Greenhouse Harvest API

Build every single integration your customers need with AI