NAV
shell ruby

Introduction

  _          _ _             
 | |__   ___| | | ___        
 | '_ \ / _ \ | |/ _ \       
 | | | |  __/ | | (_) |      
 |_| |_|\___|_|_|\___/     _
 __      _____  _ __| | __| |
 \ \ /\ / / _ \| '__| |/ _` |
  \ V  V / (_) | |  | | (_| |
   \_/\_/ \___/|_|  |_|\__,_|

With Harvest, you have access to most of your Greenhouse data!

The Harvest API was designed to allow our customers to export their data from Greenhouse. However, it can also be used to…

  1. Update candidate information.
  2. Add attachments to candidate profiles.
  3. Advance, move, and reject applications.

We have usage examples for cURL (and soon, Ruby)! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

This documentation is open source! Feel free to leave feedback as issues in the GitHub repo or fork it and contribute changes!

Authentication

To authorize, use this code:

require 'base64'
api_token = 'a7183e1b7e9ab09b8a5cfa87d1934c3c'
credential = Base64.strict_encode64(api_token + ':')
# => "YTcxODNlMWI3ZTlhYjA5YjhhNWNmYTg3ZDE5MzRjM2M6"

headers = {
  "Authorization" => "Basic " + credential
}
# Note the trailing colon after the username (API token):
$ curl https://harvest.greenhouse.io/v1/candidates/ -u a7183e1b7e9ab09b8a5cfa87d1934c3c:
...

> GET /v1/candidates/ HTTP/1.1
> Host: harvest.greenhouse.io
> Authorization: Basic YTcxODNlMWI3ZTlhYjA5YjhhNWNmYTg3ZDE5MzRjM2M6

...

Harvest uses Basic Auth over HTTPS for authentication. The username is your Greenhouse API token and the password should be blank. Unauthenticated requests will return an HTTP 401 response.

Harvest API keys can be obtained in Greenhouse. In order to create a Harvest API key, a user must be granted the “Can manage ALL organization’s API Credentials” in the “Developer permission” section. That user can then go Configure >> Dev Center >> API Credential Management. From there, you can create a Harvest API key and choose which endpoints it may access.

Important Note: Users with Harvest API keys may access all the data in the endpoint. Access to data in Harvest in binary: everything or nothing. Harvest API keys should be given to internal developers with this understanding and to third parties with caution. Each key should only be allowed to access the endpoints it absolutely needs.

Authorization header

Your Authorization header should look like this:

Authorization: Basic YTcxODNlMWI3ZTlhYjA5YjhhNWNmYTg3ZDE5MzRjM2M6

Most HTTP clients will automatically use a given username and password to generate the required Authorization header. However, you may need to explicity set this header. The header has the following format:

Authorization: Basic <base64("username:password")>

Since only a username needs to be provided in our case, you’ll need to append a : (colon) to your Greenhouse API token and then Base64 encode the resulting string.

Setting credentials with cURL

If you’re making test API requests with cURL you can use the -u flag to set the username and password (which is blank). cURL will automatically generate the Authorization header.

Setting permissions for API Keys

You can specify which API endpoints your API keys have access to from the Greenhouse Dev Center. This will allow you to permit or deny access to each endpoint individually. Any API keys created before January 18th, 2017 will have full permissions to all API endpoints that existed at that time, but any new API keys created after that point will need to be explicitly granted any required endpoint permissions.

To add or remove endpoint permissions on an API key, go to the Dev Center in Greenhouse, click “API Credential Management,” then click “Manage Permissions” next to your Harvest API Key. From there, check or uncheck permissions for any endpoints.

Throttling

Status: 200 OK
X-RateLimit-Limit: 50
X-RateLimit-Remaining: 49

API requests are limited to the amount specified in the returned X-RateLimit-Limit header (per 10 seconds). Exceeding that limit will cause Harvest to return an HTTP 429 response. Check the X-RateLimit-Limit and X-RateLimit-Remaining headers to see how many more requests you are allowed until throttling kicks in.

Pagination

Example paging header

Link: <https://harvest.greenhouse.io/v1/candidates?page=2&per_page=2>; rel="next",
<https://harvest.greenhouse.io/v1/candidates?page=474&per_page=2>; rel="last"

API methods that return a collection of results are always paginated. Paginated results will include a Link (see RFC-5988) response header with the following information.

Note that when this header is not set, there is only one page, the first page, of results.

As of February 2017, we are transitioning to a new method for paging while maintaining backwards compatibility. Currently, the new method only supports providing a next link and is used by the following endpoints:

Validation

{
  "message": "Validation error",
  "errors": [
    {
        "message": "Must be one of: candidate, prospect",
        "field": "type"
    }
  ]
}

Methods that take input will validate all parameters. Any parameter that fails validation will trigger an error response with status HTTP 422. The response body will be a JSON object that includes a message as well as a list of fields that failed validation.

General considerations

Unless otherwise specified, API methods generally conform to the following:

Errors

Error CodeMeaning
401Unauthorized – Invalid Harvest API key. Check to make sure you’ve passing it in via the Authorization header (Basic Auth)
403Forbidden – You do not have access to that record.
404Not Found – Resource not found
500Server Error – We had a problem with our server. Try again later or contact us: support@greenhouse.io

Activity Feed

The activity feed object

The activity feed is the list of activities on a candidate’s profile, including interviews, notes, and emails.

{
  "notes": [
    {
      "id": 12345,
      "created_at": "2014-03-26T20:11:40Z",
      "body": "Very mysterious.",
      "user": {
        "id": 512,
        "name": "Sayid Jarrah",
        "employee_id": null
      },
      "private": false,
      "visiblity": "public",
      "visibility": "public"
    }
  ],
  "emails": [
    {
      "id": 234675,
      "created_at": "2014-04-01T15:55:06Z",
      "subject": "Regarding your application",
      "body": "Hey John,  just wanted to touch base!",
      "to": "john.locke@example.com",
      "from": "boone.carlyle@example.com",
      "cc": null,
      "user": {
        "id": 214,
        "name": "Boone Carlyle",
        "employee_id": null
      }
    }
  ],
  "activities": [
    {
      "id": 6756789,
      "created_at": "2014-04-01T15:55:29Z",
      "subject": null,
      "body": "Reason: Lacking hustle\n\nThis candidate turned out to be problematic for us...",
      "user": {
        "id": 214,
        "name": "Boone Carlyle",
        "employee_id": 12345
      }
    },
    {
      "id": 6757869,
      "created_at": "2014-03-26T20:26:38Z",
      "subject": null,
      "body": "John Locke was moved into Recruiter Phone Screen for Accounting Manager on 03/27/2014 by Boone Carlyle",
      "user": null
    }
  ]
}

Noteworthy attributes

AttributeDescription
idThe internal Greenhouse ID of the activity feed note.
noteAn array of notes associated with this candidate.
emailAn array of emails sent to and from this candidate.
activityAn array of events associated with this candidate.
visibility*The visibility setting on the note. One of admin_only, public, or private.

* - Due to a legacy typo, the response includes the same value as visiblity. It is safe to ignore this value, but it is maintained for backward compatibility.

GET: Retrieve Activity Feed

curl 'https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "notes": [
    {
      "id": 12345,
      "created_at": "2014-03-26T20:11:40Z",
      "body": "Very mysterious.",
      "user": {
        "id": 512,
        "name": "Sayid Jarrah",
        "employee_id": null
      },
      "private": false,
      "visiblity": "public",
      "visibility": "public"
    }
  ],
  "emails": [
    {
      "id": 234675,
      "created_at": "2014-04-01T15:55:06Z",
      "subject": "Regarding your application",
      "body": "Hey John,  just wanted to touch base!",
      "to": "john.locke@example.com",
      "from": "boone.carlyle@example.com",
      "cc": null,
      "user": {
        "id": 214,
        "name": "Boone Carlyle",
        "employee_id": null
      }
    }
  ],
  "activities": [
    {
      "id": 6756789,
      "created_at": "2014-04-01T15:55:29Z",
      "subject": null,
      "body": "Reason: Lacking hustle\n\nThis candidate turned out to be problematic for us...",
      "user": {
        "id": 214,
        "name": "Boone Carlyle",
        "employee_id": 12345
      }
    },
    {
      "id": 6757869,
      "created_at": "2014-03-26T20:26:38Z",
      "subject": null,
      "body": "John Locke was moved into Recruiter Phone Screen for Accounting Manager on 03/27/2014 by Boone Carlyle",
      "user": null
    }
  ]
}

Retrieve a candidate’s activity feed.

HTTP Request

GET https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed

URL Parameters

ParameterDescription
idThe ID of the candidate whose activity feed you want to retrieve.


See noteworthy response attributes.

Applications

The application object

Applications associate candidates with jobs. There are 2 kinds of applications: candidates and prospects. Candidate applications always have exactly 1 job. Prospect applications can have 0 or more jobs.

{
  "id": 985314,
  "candidate_id": 978031,
  "prospect": false,
  "applied_at": "2016-03-26T20:11:39.000Z",
  "rejected_at": "2016-08-17T21:08:29.686Z",
  "last_activity_at": "2016-08-27T16:13:15.000Z",
  "source": {
    "id": 1871,
    "public_name": "Happy Hour"
  },
  "credited_to": {
    "id": 4080,
    "name": "Kate Austen",
    "employee_id": null
  },
  "rejection_reason": {
    "id": 8,
    "name": "Lacking skill(s)/qualification(s)",
    "type": {
      "id": 1,
      "name": "We rejected them"
    }
  },
  "rejection_details": null,
  "jobs": [
    {
      "id": 123,
      "name": "Accounting Manager"
    }
  ],
  "status": "rejected",
  "current_stage": {
    "id": 62828,
    "name": "Recruiter Phone Screen"
  },
  "answers": [
    {
      "question": "Why do you want to work for us?",
      "answer": "I heard you're awesome!"
    },
    {
      "question": "How did you hear about this job?",
      "answer": "From a former colleague."
    }
  ],
  "prospect_detail": {
      "prospect_pool": null,
      "prospect_stage": null,
      "prospect_owner": null
  },
  "custom_fields": {
    "bio": "This is a bio",
    "birthday": "1992-01-27"
  },
  "keyed_custom_fields": {
    "date_of_birth": {
      "name": "Birthday",
      "type": "date",
      "value": "1992-01-27"
    },
    "bio": {
      "name": "Bio",
      "type": "long_text",
      "value": "This is a bio"
    }
  }
}

Noteworthy attributes

AttributeDescription
idApplication ID
prospectIf true, this is a prospect application which means that the associated person is a prospect and has not yet applied for this job.
statusOne of: active, rejected, hired.
jobsAn array containing the job that the candidate applied for.
candidate_idThe ID of the candidate who is applying for this job.
current_stageThe current stage that this application is in.
credited_to.idThe ID of the user who will receive credit for this application.
answersThe 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.
custom_fieldsContains 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.
keyed_custom_fieldsThis 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.

GET: List Applications

curl -X GET 'https://harvest.greenhouse.io/v1/applications'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 69306314,
    "candidate_id": 57683957,
    "prospect": false,
    "applied_at": "2017-09-29T12:56:05.244Z",
    "rejected_at": null,
    "last_activity_at": "2017-09-29T13:00:28.038Z",
    "source": {
        "id": 2,
        "public_name": "Jobs page on your website"
    },
     "credited_to": {
      "id": 4080,
      "name": "Kate Austen"
    },
    "rejection_reason": null,
    "rejection_details": null,
    "jobs": [
        {
            "id": 107761,
            "name": "UX Designer - Boston"
        }
    ],
    "status": "active",
    "current_stage": {
        "id": 767358,
        "name": "Application Review"
    },
    "answers": [
        {
            "question": "How did you hear about this job?",
            "answer": "Online Research"
        },
        {
            "question": "Website",
            "answer": "mytestwebsite.com"
        }
    ],
    "prospect_detail": {
        "prospect_pool": null,
        "prospect_stage": null,
        "prospect_owner": null
    },
    "custom_fields": {
        "application_custom_test": "Option 1"
    },
    "keyed_custom_fields": {
        "application_custom_test": {
            "name": "Application Custom Test",
            "type": "single_select",
            "value": "Option 1"
        }
    }
},
{
    "id": 69306509,
    "candidate_id": 57683957,
    "prospect": true,
    "applied_at": "2017-09-29T13:00:04.058Z",
    "rejected_at": null,
    "last_activity_at": "2017-09-29T13:08:19.111Z",
    "source": {
        "id": 100674,
        "public_name": "Campus Job Fair"
    },
    "credited_to": {
        "id": 566819,
        "first_name": "Bob",
        "last_name": "Smith",
        "name": "Bob Smith",
        "employee_id": "ABC12345"
    },
    "rejection_reason": null,
    "rejection_details": null,
    "jobs": [
        {
            "id": 224587,
            "name": "Product Manager "
        },
        {
            "id": 109322,
            "name": "Web Developer "
        }
    ],
    "status": "active",
    "current_stage": null,
    "answers": [],
    "prospect_detail": {
        "prospect_pool": {
            "id": 227,
            "name": "Opted In: In-Person Event"
        },
        "prospect_stage": {
            "id": 826,
            "name": "In Discussion"
        },
        "prospect_owner": {
            "id": 92120,
            "name": "Greenhouse Admin"
        }
    },
    "custom_fields": {
        "application_custom_test": null
    },
    "keyed_custom_fields": {
        "application_custom_test": null
    }
  }  
]

List all of an organization’s applications.

HTTP Request

GET https://harvest.greenhouse.io/v1/applications

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only applications that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only applications that were created after this timestamp. Timestamp must be in in ISO-8601 format.
last_activity_afterReturn only applications where ‘last_activity_at’ is after this timestamp. Timestamp must be in in ISO-8601 format.
job_idIf supplied, only return applications that involve this job. Will return both candidates and prospects.


See noteworthy response attributes.

GET: Retrieve Application

curl -X GET 'https://harvest.greenhouse.io/v1/applications/{id}'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
  "id": 23239258,
  "candidate_id": 14834098,
  "prospect": false,
  "applied_at": "2015-12-28T20:53:12.801Z",
  "rejected_at": null,
  "last_activity_at": "2016-12-30T07:10:03.082Z",
  "source": {
    "id": 16,
    "public_name": "Referral"
  },
  "credited_to": {
    "id": 107050,
    "name": "Ivan Interviewer",
    "employee_id": null
  },
  "rejection_reason": null,
  "rejection_details": null,
  "jobs": [
    {
      "id": 87181,
      "name": "Product Manager"
    }
  ],
  "status": "hired",
  "current_stage": null,
  "answers": [
    {
      "question": "How many years experience do you have?",
      "answer": "5-7"
    },
    {
      "question": "Website",
      "answer": "mywebsite.com"
    }
  ],
  "prospect_detail": {
      "prospect_pool": null,
      "prospect_stage": null,
      "prospect_owner": null
  },
  "custom_fields": {
      "application_custom_test": "Option 1",
      "custom_boolean_test": true
  },
  "keyed_custom_fields": {
      "application_custom_test": {
          "name": "Application Custom Test",
          "type": "single_select",
          "value": "Option 1"
      },
      "custom_boolean_test": {
          "name": "Custom Boolean Test",
          "type": "boolean",
          "value": true
      }
   }
}

Retrieve an application by its id.

HTTP Request

GET https://harvest.greenhouse.io/v1/applications/{id}

URL parameters

ParameterDescription
idID of the application to retrieve


See noteworthy response attributes.

DELETE: Delete Application

curl -X DELETE 'https://harvest.greenhouse.io/v1/applications/{id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above returns a JSON response, structured like this:

{
  "message": "Application 29622362 has been deleted."
}

Delete an application by id. Note that only candidate applications can be deleted, you cannot delete a prospect application.

HTTP Request

DELETE https://harvest.greenhouse.io/v1/applications/{id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.


See noteworthy response attributes.

PATCH: Update Application

curl -X PATCH 'https://harvest.greenhouse.io/v1/applications/{id}"
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "source_id": 16,
  "referrer": {
    "type": "id",
    "value": 123
  }
}

The above returns a JSON response, structured like this:

{
    "id": 69306314,
    "candidate_id": 57683957,
    "prospect": false,
    "applied_at": "2017-09-29T12:56:05.244Z",
    "rejected_at": null,
    "last_activity_at": "2017-09-29T13:23:01.191Z",
    "source": {
        "id": 16,
        "public_name": "LinkedIn (Prospecting)"
    },
    "credited_to": {
        "id": 4080,
        "name": "Kate Austen",
        "employee_id": null
    },
    "rejection_reason": null,
    "rejection_details": null,
    "jobs": [
        {
            "id": 107761,
            "name": "UX Designer - Boston"
        }
    ],
    "status": "active",
    "current_stage": {
        "id": 767377,
        "name": "Take Home Test"
    },
    "answers": [
        {
            "question": "How did you hear about this job?",
            "answer": "Online Research"
        },
        {
            "question": "LinkedIn Profile",
            "answer": "linkedin.com/john.locke"
        }
    ],
    "prospect_detail": {
        "prospect_pool": null,
        "prospect_stage": null,
        "prospect_owner": null
    },
    "custom_fields": {
        "application_custom_test": "Option 1",
        "custom_boolean_test": null
    },
    "keyed_custom_fields": {
        "application_custom_test": {
            "name": "Application Custom Test",
            "type": "single_select",
            "value": "Option 1"
        },
        "custom_boolean_test": null
    }
}

Update this application. The response is populated with the application’s information which will reflect its new state. You can update applications whose status is active, rejected, or hired.

HTTP Request

PATCH https://harvest.greenhouse.io/v1/applications/{id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
source_idNointegerThe ID of the application’s source
referrerNoobjectAn object representing the referrer
referrer[type]NostringA string representing the type of referrer: 'id’, 'email’, or 'outside’
referrer[value]NostringThe id of the user who made the referral (not the referrer id)
custom_fields[]Nocustom_fieldArray of hashes containing new custom field values. Passing an empty array does nothing.

POST: Advance Application

curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/advance'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "from_stage_id": 1
}

The above returns a JSON response, structured like this:

{
  "id": 47669412,
  "candidate_id": 38445573,
  "prospect": false,
  "applied_at": "2017-01-25T22:46:08.601Z",
  "rejected_at": null,
  "last_activity_at": "2017-01-25T22:58:48.679Z",
  "source": {
    "id": 16,
    "public_name": "LinkedIn (Prospecting)"
  },
  "credited_to": null,
  "rejection_reason": null,
  "rejection_details": null,
  "jobs": [
    {
      "id": 211706,
      "name": "Community Manager - New York"
    }
  ],
  "status": "active",
  "current_stage": {
    "id": 1551141,
    "name": "Take Home Test"
 },
  "answers": [
    {
      "question": "How many years experience do you have?",
      "answer": "2-4"
    },
    {
      "question": "Can do you the travel required for this job?",
      "answer": "Yes"
    }
  ],
  "prospect_detail": {
     "prospect_pool": null,
     "prospect_stage": null,
     "prospect_owner": null
  },
  "custom_fields": {
    "current_title": "Community Manager",
    "requires_visa_sponsorship?": false
  },
  "keyed_custom_fields": {
    "current_title": {
      "name": "Current Title",
      "type": "short_text",
      "value": "Community Manager"
    },
    "requires_visa_sponsorship_": {
      "name": "Requires visa sponsorship?",
      "type": "boolean",
      "value": false
    }
  }
}

Move this application to the next stage. The response is populated with the application’s information which will reflect its new state. Note that only applications in the active state can be advanced.

HTTP Request

POST https://harvest.greenhouse.io/v1/applications/{id}/advance

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
from_stage_idYesintegerThe ID of the job stage this application is currently in.

POST: Move Application (Same Job)

curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/move'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "from_stage_id": 1,
  "to_stage_id": 2
}

The above returns a JSON response, structured like this:

{
  "id": 48206478,
  "candidate_id": 36952451,
  "prospect": false,
  "applied_at": "2017-02-01T14:26:02.282Z",
  "rejected_at": null,
  "last_activity_at": "2017-02-01T14:51:12.670Z",
  "source": {
    "id": 33,
    "public_name": "Glassdoor"
  },
  "credited_to": null,
  "rejection_reason": null,
  "rejection_details": null,
  "jobs": [
    {
      "id": 211706,
      "name": "Community Manager - New York"
    }
  ],
  "status": "active",
  "current_stage": {
    "id": 1551142,
    "name": "Offer"
  },
  "answers": [
    {
      "question": "How many years experience do you have?",
      "answer": "2-4"
    },
    {
      "question": "Can do you the travel required for this job?",
      "answer": "Yes"
    }
  ],
  "prospect_detail": {
    "prospect_pool": null,
    "prospect_stage": null,
    "prospect_owner": null
  },
  "custom_fields": {
    "current_title": "Community Manager",
    "requires_visa_sponsorship?": false
  },
  "keyed_custom_fields": {
    "current_title": {
      "name": "Current Title",
      "type": "short_text",
      "value": "Community Manager"
    },
    "requires_visa_sponsorship_": {
      "name": "Requires visa sponsorship?",
      "type": "boolean",
      "value": false
    }
  }
}

Move this application from one stage to another. An application can only be moved between stages on the same job. The response is populated with the application’s information which will reflect its new state. Note that only applications in the active state can be moved.

HTTP Request

POST https://harvest.greenhouse.io/v1/applications/{id}/move

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
from_stage_idYesintegerThe ID of the job stage this application is currently in.
to_stage_idYesintegerThe ID of the job stage this application should be moved to.


See noteworthy response attributes.

POST: Move Application (Different Job)

curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/transfer_to_job'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "new_job_id": 123456,
  "new_stage_id": 234567
}

The above returns a JSON response, structured like this:

{
  "id": 48206478,
  "candidate_id": 36952451,
  "prospect": false,
  "applied_at": "2017-02-01T14:26:02.282Z",
  "rejected_at": null,
  "last_activity_at": "2017-02-01T14:51:12.670Z",
  "source": {
    "id": 33,
    "public_name": "Glassdoor"
  },
  "credited_to": null,
  "rejection_reason": null,
  "rejection_details": null,
  "jobs": [
    {
      "id": 123456,
      "name": "Community Manager - New York"
    }
  ],
  "status": "active",
  "current_stage": {
    "id": 234567,
    "name": "Application Review"
  },
  "answers": [
    {
      "question": "How many years experience do you have?",
      "answer": "2-4"
    },
    {
      "question": "Can do you the travel required for this job?",
      "answer": "Yes"
    }
  ],
  "prospect_detail": {
    "prospect_pool": null,
    "prospect_stage": null,
    "prospect_owner": null
  },
  "custom_fields": {
    "current_title": "Community Manager",
    "requires_visa_sponsorship?": false
  },
  "keyed_custom_fields": {
    "current_title": {
      "name": "Current Title",
      "type": "short_text",
      "value": "Community Manager"
    },
    "requires_visa_sponsorship_": {
      "name": "Requires visa sponsorship?",
      "type": "boolean",
      "value": false
    }
  }
}

Move this application to any stage on a different job. If new_stage_id is omitted, the initial stage of the new job will be selected. Prospect applications can’t be moved in this way.

HTTP Request

POST https://harvest.greenhouse.io/v1/applications/{id}/transfer_to_job

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
new_job_idYesintegerThe ID of the job to which this application should be transferred
new_stage_idNointegerThe stage on the destination job this application should be placed in. If this is omitted, the application will be sent to the job’s initial stage


See noteworthy response attributes.

POST: Reject Application

curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/reject'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "rejection_reason_id": 815,
  "notes": "The prospect is not qualified for this position.",
  "rejection_email": {
    "send_email_at": "2014-03-26T20:11:39Z",
    "email_template_id": 42
  }
}

The above returns a JSON response, structured like this:

{
    "id": 69201605,
    "candidate_id": 57683957,
    "prospect": false,
    "applied_at": "2017-09-28T13:27:54.873Z",
    "rejected_at": "2017-09-29T12:58:48.924Z",
    "last_activity_at": "2017-09-29T13:23:01.191Z",
    "source": {
        "id": 16,
        "public_name": "LinkedIn (Prospecting)"
    },
    "credited_to": {
        "id": 566819,
        "first_name": "Bob",
        "last_name": "Smith",
        "name": "Bob Smith",
        "employee_id": "ABC12345"
    },
    "rejection_reason": {
        "id": 9504,
        "name": "Hired another candidate",
        "type": {
            "id": 1,
            "name": "We rejected them"
        }
    },
    "rejection_details": {},
    "jobs": [
        {
            "id": 185289,
            "name": "Product Specialist"
        }
    ],
    "status": "rejected",
    "current_stage": {
        "id": 1355395,
        "name": "Face to Face"
    },
    "answers": [],
    "prospect_detail": {
        "prospect_pool": null,
        "prospect_stage": null,
        "prospect_owner": null
    },
    "custom_fields": {
        "application_custom_test": null,
        "custom_boolean_test": null
    },
    "keyed_custom_fields": {
        "application_custom_test": null,
        "custom_boolean_test": null
    }
}

Reject this application. The response is populated with the application’s information which will reflect its new state. Note that only applications in the active state can be rejected.

HTTP Request

POST https://harvest.greenhouse.io/v1/applications/{id}/reject

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
rejection_reason_idNointegerThe ID of the reason why this application was rejected.
notesNostringNotes on why this application was rejected. These will be added to the activity feed.
rejection_emailNohashAn email will be sent to the candidate notifying them of this rejection.
rejection_email.send_email_atNostringThe rejection email will be delayed until this time.
rejection_email.email_template_idYes, if sending rejection_emailstringThe template the to use for the rejection email.

POST: Unreject Application

curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/unreject'\
  -H "On-Behalf-Of: {greenhouse user ID}"\
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

A successful response:

{
    "id": 69201605,
    "candidate_id": 57683957,
    "prospect": false,
    "applied_at": "2017-09-28T13:27:54.873Z",
    "rejected_at": null,
    "last_activity_at": "2017-09-29T13:34:58.354Z",
    "source": {
        "id": 16,
        "public_name": "LinkedIn (Prospecting)"
    },
    "credited_to": {
        "id": 566819,
        "first_name": "Bob",
        "last_name": "Smith",
        "name": "Bob Smith",
        "employee_id": null
    },
    "rejection_reason": null,
    "rejection_details": null,
    "jobs": [
        {
            "id": 185289,
            "name": "Product Specialist"
        }
    ],
    "status": "active",
    "current_stage": {
        "id": 1355398,
        "name": "Face to Face"
    },
    "answers": [],
    "prospect_detail": {
        "prospect_pool": null,
        "prospect_stage": null,
        "prospect_owner": null
    },
    "custom_fields": {
        "application_custom_test": null,
        "custom_boolean_test": null
    },
    "keyed_custom_fields": {
        "application_custom_test": null,
        "custom_boolean_test": null
    }
}

An unsuccessful response:

{
  "errors": [
    {
      "message": "Application must be 'rejected', is currently 'active'"
    }
  ]
}

Unreject this application. The response is populated with the application in its new state. Note that only applications in the rejected state can be unrejected.

HTTP Request

POST https://harvest.greenhouse.io/v1/applications/{id}/unreject

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

URL parameters

ParameterDescription
idID of the application to unreject

JSON Body Parameters

No JSON body parameters

Candidates

An organization’s candidates.

The candidate object

{
    "id": 53883394,
    "first_name": "John",
    "last_name": "Locke",
    "company": "The Tustin Box Company",
    "title": "Man of Mystery",
    "created_at": "2017-08-15T03:31:46.591Z",
    "updated_at": "2017-09-28T12:29:30.497Z",
    "last_activity": "2017-09-28T12:29:30.481Z",
    "is_private": false,
    "photo_url": "https://prod-heroku.s3.amazonaws.com/people/photos/053/883/394/original/corgi.jpg?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509193807&Signature=cg%2BhyNTvvNgTTzWtsMJJZvPRYH4%3D",
    "attachments": [
        {
            "filename": "John_Locke_Offer_Packet_09_27_2017.pdf",
            "url": "https://prod-heroku.s3.amazonaws.com/person_attachments/data/077/683/131/original/John_Locke_Offer_Packet_09_27_2017.pdf?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509193807&Signature=R5TbJPzD7TO5NgX8K8Y0yogPstY%3D",
            "type": "offer_packet"
        }
    ],
    "application_ids": [
        69102626,
        65153308
    ],
    "phone_numbers": [
        {
            "value": "555-555-5555",
            "type": "mobile"
        }
    ],
    "addresses": [
        {
            "value": "123 City Street\nNew York, Ny 10001",
            "type": "home"
        }
    ],
    "email_addresses": [
        {
            "value": "test@work.com",
            "type": "work"
        },
        {
            "value": "test@example.com",
            "type": "personal"
        }
    ],
    "website_addresses": [
        {
            "value": "mysite.com",
            "type": "personal"
        }
    ],
    "social_media_addresses": [
        {
            "value": "twitter.com/test"
        }
    ],
    "recruiter": {
        "id": 92120,
        "first_name": "Greenhouse",
        "last_name": "Admin",
        "name": "Greenhouse Admin",
        "employee_id": null
    },
    "coordinator": null,
    "tags": [
        "Python",
        "Ruby"
    ],
    "applications": [
        {
            "id": 69102626,
            "candidate_id": 53883394,
            "prospect": false,
            "applied_at": "2017-09-27T12:03:02.728Z",
            "rejected_at": "2017-09-27T12:11:40.877Z",
            "last_activity_at": "2017-09-28T12:29:30.481Z",
            "source": {
                "id": 16,
                "public_name": "LinkedIn (Prospecting)"
            },
            "credited_to": {
                "id": 165372,
                "first_name": "Joel",
                "last_name": "Job Admin",
                "name": "Joel Job Admin",
                "employee_id": null
            },
            "rejection_reason": {
                "id": 9504,
                "name": "Hired another candidate",
                "type": {
                    "id": 1,
                    "name": "We rejected them"
                }
            },
            "rejection_details": {},
            "jobs": [
                {
                    "id": 149995,
                    "name": "DevOps Engineer"
                }
            ],
            "status": "rejected",
            "current_stage": {
                "id": 1073533,
                "name": "Take Home Test"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        },
        {
            "id": 65153308,
            "candidate_id": 53883394,
            "prospect": false,
            "applied_at": "2017-08-15T03:31:46.637Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T12:29:30.481Z",
            "source": {
                "id": 12,
                "public_name": "Meetups"
            },
            "credited_to": {
                "id": 566819,
                "first_name": "Bob",
                "last_name": "Smith",
                "name": "Bob Smith",
                "employee_id": null
            },
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 299100,
                    "name": "Data Scientist - BK"
                }
            ],
            "status": "active",
            "current_stage": {
                "id": 2966800,
                "name": "Face to Face"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        }
    ],
    "educations": [
        {
            "id": 561227,
            "school_name": "University of Michigan - Ann Arbor",
            "degree": "Bachelor's Degree",
            "discipline": "Computer Science"
        }
    ],
    "employments": [],
    "custom_fields": {
        "desired_salary": "1000000000",
        "work_remotely": true,
        "graduation_year": "2018"
    },
    "keyed_custom_fields": {
        "desired_salary": {
            "name": "Desired Salary",
            "type": "short_text",
            "value": "1000000000"
        },
        "work_remotely": {
            "name": "Work Remotely",
            "type": "boolean",
            "value": true
        },
        "graduation_year_1": {
            "name": "Graduation Year",
            "type": "single_select",
            "value": "2018"
        }
    }
}

Noteworthy attributes

AttributeDescription
idThe candidate’s unique identifier
companyThe company at which the candidate currently works
titleThe candidate’s current title
is_privateWhether the candidate is private or not. One of: [“true”, “false”]
application_idsArray of application IDs associated with this candidate. Can contain none, one, or several application IDs.
phone_numbers[].typeOne of: [“home”, “work”, “mobile”, “skype”, “other”]
addresses[].typeOne of: [“home”, “work”, “other”]
email_addresses[].typeOne of: [“personal”, “work”, “other”]
website_addresses[].typeOne of: [“personal”, “company”, “portfolio”, “blog”, “other”]
recruiterThe recruiter user who is responsible for this candidate.
coordinatorThe coordinator user who is responsible for this candidate.
attachments[].typeOne of: [“admin_only”, “public”, “cover_letter”, “offer_packet”, “resume”, “take_home_test”]
attachments[].urlURLs expire in 30 days.
custom_fieldsContains 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.
keyed_custom_fieldsThis 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.

GET: List Candidates

curl 'https://harvest.greenhouse.io/v1/candidates'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
 {
    "id": 53883394,
    "first_name": "John",
    "last_name": "Locke",
    "company": "The Tustin Box Company",
    "title": "Man of Mystery",
    "created_at": "2017-08-15T03:31:46.591Z",
    "updated_at": "2017-09-28T12:29:30.497Z",
    "last_activity": "2017-09-28T12:29:30.481Z",
    "is_private": false,
    "photo_url": "https://prod-heroku.s3.amazonaws.com/people/photos/053/883/394/original/corgi.jpg?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509193807&Signature=cg%2BhyNTvvNgTTzWtsMJJZvPRYH4%3D",
    "attachments": [
        {
            "filename": "John_Locke_Offer_Packet_09_27_2017.pdf",
            "url": "https://prod-heroku.s3.amazonaws.com/person_attachments/data/077/683/131/original/John_Locke_Offer_Packet_09_27_2017.pdf?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509193807&Signature=R5TbJPzD7TO5NgX8K8Y0yogPstY%3D",
            "type": "offer_packet"
        }
    ],
    "application_ids": [
        69103370,
        65153308
    ],
    "phone_numbers": [
        {
            "value": "555-555-5555",
            "type": "mobile"
        }
    ],
    "addresses": [
        {
            "value": "123 City Street\nNew York, Ny 10001",
            "type": "home"
        }
    ],
    "email_addresses": [
        {
            "value": "test@work.com",
            "type": "work"
        }
    ],
    "website_addresses": [
        {
            "value": "mysite.com",
            "type": "personal"
        }
    ],
   "social_media_addresses": [],
    "recruiter": {
        "id": 92120,
        "first_name": "Greenhouse",
        "last_name": "Admin",
        "name": "Greenhouse Admin",
        "employee_id": null
    },
    "coordinator": null,
    "tags": [
        "Python",
        "Ruby"
    ],
    "applications": [
        {
            "id": 69103370,
            "candidate_id": 53883394,
            "prospect": true,
            "applied_at": "2017-09-27T12:21:37.234Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T12:29:30.481Z",
            "source": {
                "id": 16,
                "public_name": "LinkedIn (Prospecting)"
            },
            "credited_to": {
                "id": 92120,
                "first_name": "Greenhouse",
                "last_name": "Admin",
                "name": "Greenhouse Admin",
                "employee_id": null
            },
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 87752,
                    "name": "Full Stack Engineer"
                }
            ],
            "status": "active",
            "current_stage": null,
            "answers": [],
            "prospect_detail": {
                "prospect_pool": {
                    "id": 224,
                    "name": "Cold Outreach: Sourced"
                },
                "prospect_stage": {
                    "id": 817,
                    "name": "Contacted"
                },
                "prospect_owner": {
                    "id": 92120,
                    "name": "Greenhouse Admin"
                }
            }
        },
        {
            "id": 65153308,
            "candidate_id": 53883394,
            "prospect": false,
            "applied_at": "2017-08-15T03:31:46.637Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T12:29:30.481Z",
            "source": {
                "id": 12,
                "public_name": "Meetups"
            },
            "credited_to": {
                "id": 566819,
                "first_name": "Bob",
                "last_name": "Smith",
                "name": "Bob Smith",
                "employee_id": null
            },
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 299100,
                    "name": "Data Scientist - BK"
                }
            ],
            "status": "active",
            "current_stage": {
                "id": 2966800,
                "name": "Face to Face"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        }
    ],
    "educations": [
        {
            "id": 561227,
            "school_name": "University of Michigan - Ann Arbor",
            "degree": "Bachelor's Degree",
            "discipline": "Computer Science"
        }
    ],
    "employments": [],
    "custom_fields": {
        "desired_salary": "1000000000",
        "work_remotely": true,
        "graduation_year": "2018"
    },
    "keyed_custom_fields": {
        "desired_salary": {
            "name": "Desired Salary",
            "type": "short_text",
            "value": "1000000000"
        },
        "work_remotely": {
            "name": "Work Remotely",
            "type": "boolean",
            "value": true
        },
        "graduation_year_1": {
            "name": "Graduation Year",
            "type": "single_select",
            "value": "2018"
        }
     }
  } 
]

List all of an organization’s candidates.

HTTP Request

GET https://harvest.greenhouse.io/v1/candidates

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only candidates that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only candidates that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only candidates that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only candidates that were updated after this timestamp. Timestamp must be in in ISO-8601 format.
job_idIf supplied, only return candidates that have applied to this job. Will return both when a candidate has applied to a job and when they’re a prospect for a job.
emailIf supplied, only return candidates who have a matching e-mail address. If supplied with job_id, only return a candidate with a matching e-mail with an application on the job.


See noteworthy response attributes.

GET: Retrieve Candidate

curl 'https://harvest.greenhouse.io/v1/candidates/{id}'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
    "id": 53883394,
    "first_name": "John",
    "last_name": "Locke",
    "company": "The Tustin Box Company",
    "title": "Man of Mystery",
    "created_at": "2017-08-15T03:31:46.591Z",
    "updated_at": "2017-09-28T12:29:30.497Z",
    "last_activity": "2017-09-28T12:29:30.481Z",
    "is_private": false,
    "photo_url": "https://prod-heroku.s3.amazonaws.com/people/photos/053/883/394/original/corgi.jpg?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509193807&Signature=cg%2BhyNTvvNgTTzWtsMJJZvPRYH4%3D",
    "attachments": [
        {
            "filename": "John_Locke_Offer_Packet_09_27_2017.pdf",
            "url": "https://prod-heroku.s3.amazonaws.com/person_attachments/data/077/683/131/original/John_Locke_Offer_Packet_09_27_2017.pdf?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509193807&Signature=R5TbJPzD7TO5NgX8K8Y0yogPstY%3D",
            "type": "offer_packet"
        }
    ],
    "application_ids": [
        69102626,
        65153308
    ],
    "phone_numbers": [
        {
            "value": "555-555-5555",
            "type": "mobile"
        }
    ],
    "addresses": [],
    "email_addresses": [
        {
            "value": "test@work.com",
            "type": "work"
        },
        {
            "value": "test@example.com",
            "type": "personal"
        }
    ],
    "website_addresses": [
        {
            "value": "mysite.com",
            "type": "personal"
        }
    ],
    "social_media_addresses": [],
    "recruiter": {
        "id": 92120,
        "first_name": "Greenhouse",
        "last_name": "Admin",
        "name": "Greenhouse Admin",
        "employee_id": null
    },
    "coordinator": null,
    "tags": [
        "Python",
        "Ruby"
    ],
    "applications": [
        {
            "id": 69102626,
            "candidate_id": 53883394,
            "prospect": false,
            "applied_at": "2017-09-27T12:03:02.728Z",
            "rejected_at": "2017-09-27T12:11:40.877Z",
            "last_activity_at": "2017-09-28T12:29:30.481Z",
            "source": {
                "id": 16,
                "public_name": "LinkedIn (Prospecting)"
            },
            "credited_to": {
                "id": 165372,
                "first_name": "Joel",
                "last_name": "Job Admin",
                "name": "Joel Job Admin",
                "employee_id": null
            },
            "rejection_reason": {
                "id": 9504,
                "name": "Hired another candidate",
                "type": {
                    "id": 1,
                    "name": "We rejected them"
                }
            },
            "rejection_details": {},
            "jobs": [
                {
                    "id": 149995,
                    "name": "DevOps Engineer"
                }
            ],
            "status": "rejected",
            "current_stage": {
                "id": 1073533,
                "name": "Take Home Test"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        },
        {
            "id": 65153308,
            "candidate_id": 53883394,
            "prospect": false,
            "applied_at": "2017-08-15T03:31:46.637Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T12:29:30.481Z",
            "source": {
                "id": 12,
                "public_name": "Meetups"
            },
            "credited_to": {
                "id": 566819,
                "first_name": "Bob",
                "last_name": "Smith",
                "name": "Bob Smith",
                "employee_id": null
            },
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 299100,
                    "name": "Data Scientist - BK"
                }
            ],
            "status": "active",
            "current_stage": {
                "id": 2966800,
                "name": "Face to Face"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        }
    ],
    "educations": [
        {
            "id": 561227,
            "school_name": "University of Michigan - Ann Arbor",
            "degree": "Bachelor's Degree",
            "discipline": "Computer Science"
        }
    ],
    "employments": [],
    "custom_fields": {
        "desired_salary": "1000000000",
        "work_remotely": true,
        "graduation_year": "2018"
    },
    "keyed_custom_fields": {
        "desired_salary": {
            "name": "Desired Salary",
            "type": "short_text",
            "value": "1000000000"
        },
        "work_remotely": {
            "name": "Work Remotely",
            "type": "boolean",
            "value": true
        },
        "graduation_year_1": {
            "name": "Graduation Year",
            "type": "single_select",
            "value": "2018"
        }
    }
}

Retrieve a candidate by its id.

HTTP Request

GET https://harvest.greenhouse.io/v1/candidates/{id}

URL Parameters

ParameterDescription
idThe ID of the candidate to retrieve


See noteworthy response attributes.

DELETE: Delete Candidate

curl -X DELETE 'https://harvest.greenhouse.io/v1/candidates/{id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above returns a JSON response, structured like this:

{
  "message": "Person 29622362 has been deleted."
}

Delete a candidate by id.

HTTP Request

DELETE https://harvest.greenhouse.io/v1/candidates/{id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.


See noteworthy response attributes.

PATCH: Edit Candidate

curl -X PATCH 'https://harvest.greenhouse.io/v1/candidates/{id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "first_name": "New",
  "last_name": "Name",
  "company": "The Tustin Box Company",
  "title": "Man of Mystery",
  "is_private": true,
  "phone_numbers": [
    {
      "value": "555-1212",
      "type": "mobile"
    }
  ],
  "addresses": [
    {
      "value": "123 Fake St.",
      "type": "home"
    }
  ],
  "email_addresses": [
    {
      "value": "john.locke+work@example.com",
      "type": "work"
    },
    {
      "value": "john.locke@example.com",
      "type": "personal"
    }
  ],
  "website_addresses": [
    {
      "value": "johnlocke.example.com",
      "type": "personal"
    }
  ],
  "social_media_addresses": [
    {
      "value": "linkedin.example.com/john.locke"
    },
    {
      "value": "@johnlocke"
    }
  ],
  "tags": [
    "Walkabout",
    "Orientation"
  ],
  "custom_fields": [
    {
        "id": 1234,
        "value": "Some new value"
    },
    {
        "name_key": "single_select_field_name",
        "value": 12345
   },
   {
        "id": 5678,
        "delete_value": "true"
   }
  ]
}

The above returns a JSON response, structured like this:

[
  {
      "id": 53883394,
      "first_name": "New",
      "last_name": "Name",
      "company": "The Tustin Box Company",
      "title": "Man of Mystery",
      "created_at": "2017-08-15T03:31:46.591Z",
      "updated_at": "2017-09-28T12:54:34.257Z",
      "last_activity": "2017-09-28T12:54:34.243Z",
      "is_private": true,
      "photo_url": "https://prod-heroku.s3.amazonaws.com/people/photos/053/883/394/original/corgi.jpg?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509195274&Signature=NHilozZgXPHOI9uvpKTnf3A50Gc%3D",
      "attachments": [
          {
              "filename": "John_Locke_Offer_Packet_09_28_2017.pdf",
              "url": "https://prod-heroku.s3.amazonaws.com/person_attachments/data/077/815/020/original/John_Locke_Offer_Packet_09_28_2017.pdf?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509195274&Signature=Vb7z8GlHJXvwqhvx%2BTrIZ32zaVo%3D",
              "type": "offer_packet"
          }
      ],
      "application_ids": [
          65153308
      ],
      "phone_numbers": [
          {
              "value": "555-1212",
              "type": "mobile"
          }
      ],
      "addresses": [
          {
              "value": "123 Fake Street",
              "type": "home"
          }
      ],
      "email_addresses": [
          {
              "value": "john.locke+work@example.com",
              "type": "work"
          },
          {
              "value": "john.locke@example.com",
              "type": "personal"
          }
      ],
      "website_addresses": [
          {
              "value": "johnlocke.example.com",
              "type": "personal"
          }
      ],
       "social_media_addresses": [
          {
            "value": "linkedin.example.com/john.locke"
          },
          {
            "value": "@johnlocke"
          }
      ],
      "recruiter": {
          "id": 92120,
          "first_name": "Greenhouse",
          "last_name": "Admin",
          "name": "Greenhouse Admin",
          "employee_id": null
      },
      "coordinator": null,
      "tags": [
          "Walkabout",
          "Orientation"
      ],
      "applications": [
          {
              "id": 65153308,
              "candidate_id": 53883394,
              "prospect": false,
              "applied_at": "2017-08-15T03:31:46.637Z",
              "rejected_at": null,
              "last_activity_at": "2017-09-28T12:54:34.243Z",
              "source": {
                  "id": 12,
                  "public_name": "Meetups"
              },
              "credited_to": {
                  "id": 566819,
                  "first_name": "Bob",
                  "last_name": "Smith",
                  "name": "Bob Smith",
                  "employee_id": "ABC12345"
              },
              "rejection_reason": null,
              "rejection_details": null,
              "jobs": [
                  {
                      "id": 299100,
                      "name": "Data Scientist - BK"
                  }
              ],
              "status": "active",
              "current_stage": {
                  "id": 2966800,
                  "name": "Face to Face"
              },
              "answers": [],
              "prospect_detail": {
                  "prospect_pool": null,
                  "prospect_stage": null,
                  "prospect_owner": null
              }
          }
      ],
      "educations": [],
      "employments": [],
      "custom_fields": {
        "current_salary": "$23k",
        "desired_salary": "$42k"
      },
      "keyed_custom_fields": {
        "current_salary": {
          "name": "Current salary",
          "type": "short_text",
          "value": "$23k"
        },
        "desired_salary": {
          "name": "Desired salary",
          "type": "short_text",
          "value": "$42k"
        }
     }
  }     
]

Update or patch a single candidate by its id.

HTTP Request

PATCH https://harvest.greenhouse.io/v1/candidates/{id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
first_nameNostringThe candidate’s first name
last_nameNostringThe candidate’s last name
companyNostringThe candidate’s company
titleNostringThe candidate’s title
is_privateWhether the candidate is private or not. One of: [“true”, “false”]
phone_numbers[]Nophone_numberArray of phone numbers. Passing an empty array will clear all.
addresses[]NoaddressArray of addresses. Passing an empty array will clear all.
email_addresses[]Noemail_addressArray of email addresses. Passing an empty array will clear all.
website_addresses[]Nowebsite_addressArray of website addresses. Passing an empty array will clear all.
social_media_addresses[]Nosocial_media_addressArray of social media addresses. Passing an empty array will clear all.
tags[]NostringArray of tags as strings. Passing an empty array will clear all.
custom_fields[]Nocustom_fieldArray of hashes containing new custom field values. Passing an empty array does nothing.

Custom Field Parameters

The custom field parameter structure is different in the PATCH method then in GET methods and responses. Certain type of custom fields require different elements to be included, while deleting a field requires a specific argument. What follows is the description of each item in a custom field element and what is required depending on the type.

ParameterRequired forDescription
idallThe custom field id for this particular custom field. One of this or name_key is required.
name_keyallThe field key for this custom field. This can be found in Greenhouse while editing custom options as “Immutable Field Key” This or id is required for all custom field elements.
valueallThe value field contains the new custom field value. In most cases this will be a string or a number. In the case of single-select or multi-select custom fields, this will be a custom field option id or an array of custom field option ids, respectively. In the case of single-select fields, this can also be a string that matches an existing option value name exactly.
unitcurrencyThis contains the currency unit for a currency custom field. It is only required when updating a currency custom field. This should accept any 3-character currency code from the ISO-4217 standard.
delete_valuen/aWhen this element is included with a value of “true” (note, string true, not boolean true) the custom field value will be removed from Greenhouse. Note that updating a custom field value to nil or a blank string will not work, as validations require these to be non-blank values.


See noteworthy response attributes.

POST: Add Candidate Application

curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/applications'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "job_id": 266926,
  "source_id": 7,
  "initial_stage_id": 2708728,
  "referrer": {
    "type": "id",
    "value": 770
  },
  "attachments": [{
    "filename": "resume.pdf",
    "type": "resume",
    "content": "MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6...",
    "content_type": "application/pdf"
}

The above command returns a JSON response, structured like this:

{
  "id": 38776620,
  "candidate_id": 15803530,
  "prospect": false,
  "applied_at": "2016-11-08T19:50:49.746Z",
  "rejected_at": null,
  "last_activity_at": "2016-11-04T19:46:40.377Z",
  "source": {
    "id": 7,
    "public_name": "Indeed"
  },
  "credited_to": {
        "id": 770,
        "first_name": "Moon",
        "last_name": "Colorado",
        "name": "Moon Colorado",
        "employee_id": null
    },
  "rejection_reason": null,
  "rejection_details": null,
  "jobs": [
    {
      "id": 266926,
      "name": "Construction Project Manager"
    }
  ],
  "status": "active",
  "current_stage": {
    "id": 1945557,
    "name": "Application Review"
  },
  "answers": [],
  "custom_fields": {
    "birthday": "1992-01-27",
    "bio": "This is my bio"
  },
  "prospect_detail": {
    "prospect_pool": null,
    "prospect_stage": null,
    "prospect_owner": null
  }
}

Create a new application for this candidate or prospect. If a prospect, this will add a new candidate application to the given job on their profile, this will not convert their existing prospect application into a candidate application.

HTTP Request

POST https://harvest.greenhouse.io/v1/candidates/{id}/applications

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
job_idYesintegerThe ID of the job you want to create an application to for this candidate
source_idNointegerThe id of the source to be credited for this application
initial_stage_idNointegerThe ID of the job stage this application will be created in.
referrerNoobjectAn object representing the referrer
referrer[type]NostringA string representing the type of referrer: ‘id’, 'email’, or 'outside’
referrer[value]NostringThe id of the user who made the referral (not the referrer id)
attachmentsNoarrayAn array of attachments to be uploaded to this application. See Add Attachment for parameters.

POST: Add Attachment

curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/attachments'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "filename" : "resume.pdf",
  "type" : "resume",
  "content" : "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs...",
  "content_type" : "application/pdf"
}

The above command returns a JSON response, structured like this:

{
  "filename": "resume.pdf",
  "url": "https://prod-heroku.s3.amazonaws.com/...",
  "type": "resume",
  "content_type": "application/pdf"
}

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

HTTP Request

POST https://harvest.greenhouse.io/v1/candidates/{id}/attachments

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
filenameYesstringName of the file
typeYesstringOne of: [“resume”, “cover_letter”, “admin_only”]
contentNostringBase64 encoded content of the attachment (if you are providing content, you do not need to provide url)
urlNostringUrl of the attachment (if you are providing the url, you do not need to provide the content)
content_typeNo*stringThe content-type of the document you are sending. When using a URL, this generally isn’t needed, as the responding server will deliver a content type. This should be included for encoded content. Accepted content types are:
  • “application/atom+xml”
  • “application/javascript”
  • “application/json”
  • “application/msgpack”
  • “application/pdf”
  • “application/rss+xml”
  • “application/vnd.ms-excel”
  • “application/vnd.openxmlformats-
    officedocument.spreadsheetml.sheet”
  • “application/vnd.openxmlformats-
    officedocument.wordprocessingml.document”
  • “application/xml”
  • “application/x-www-form-urlencoded”
  • “application/x-yaml”
  • “application/zip”
  • “multipart/form-data”
  • “image/bmp”
  • “image/gif”
  • “image/jpeg”
  • “image/png”
  • “image/tiff”
  • “text/calendar”
  • “text/css”
  • “text/csv”
  • “text/html”
  • “text/javascript”
  • “text/plain”
  • “text/vcard”
  • “video/mpeg”

* - content_type is not required for purposes of backward compatibility. It is strongly recommended that you always include content type for document uploads.

POST: Add Candidate

curl -X POST 'https://harvest.greenhouse.io/v1/candidates'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "first_name": "John",
  "last_name": "Locke",
  "company": "The Tustin Box Company",
  "title": "Man of Mystery",
  "is_private": false,
  "phone_numbers": [
    {
      "value": "555-1212",
      "type": "mobile"
    }
  ],
  "addresses": [
    {
      "value": "123 Fake St.",
      "type": "home"
    }
  ],
  "email_addresses": [
    {
      "value": "john.locke+work@example.com",
      "type": "work"
    },
    {
      "value": "john.locke@example.com",
      "type": "personal"
    }
  ],
  "website_addresses": [
    {
      "value": "johnlocke.example.com",
      "type": "personal"
    }
  ],
  "social_media_addresses": [
    {
      "value": "linkedin.example.com/john.locke"
    },
    {
      "value": "@johnlocke"
    }
  ],
  "tags": [
    "Walkabout",
    "Orientation"
  ],
  "applications": [
    {
      "job_id": 215725
    },
     {
      "job_id": 185289
    }
  ]
}

The above returns a JSON response, structured like this:

{
    "id": 57683957,
    "first_name": "John",
    "last_name": "Locke",
    "company": "The Tustin Box Company",
    "title": "Man of Mystery",
    "created_at": "2017-09-28T13:27:54.735Z",
    "updated_at": "2017-09-28T13:27:55.229Z",
    "last_activity": "2017-09-28T13:27:55.213Z",
    "is_private": false,
    "photo_url": null,
    "attachments": [],
    "application_ids": [
        69201605,
        69201604
    ],
    "phone_numbers": [
        {
            "value": "555-1212",
            "type": "mobile"
        }
    ],
    "addresses": [
        {
            "value": "123 Fake St.",
            "type": "home"
        }
    ],
    "email_addresses": [
        {
            "value": "john.locke@example.com",
            "type": "personal"
        },
        {
            "value": "john.locke+work@example.com",
            "type": "work"
        }
    ],
    "website_addresses": [
        {
            "value": "johnlocke.example.com",
            "type": "personal"
        }
    ],
    "social_media_addresses": [
        {
            "value": "@johnlocke"
        },
        {
            "value": "linkedin.example.com/john.locke"
        }
    ],
    "recruiter": null,
    "coordinator": null,
    "tags": [
        "Orientation",
        "Walkabout"
    ],
    "applications": [
        {
            "id": 69201605,
            "candidate_id": 57683957,
            "prospect": false,
            "applied_at": "2017-09-28T13:27:54.873Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T13:27:55.213Z",
            "source": null,
            "credited_to": null,
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 185289,
                    "name": "Product Specialist"
                }
            ],
            "status": "active",
            "current_stage": {
                "id": 1355395,
                "name": "Application Review"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        },
        {
            "id": 69201604,
            "candidate_id": 57683957,
            "prospect": false,
            "applied_at": "2017-09-28T13:27:54.812Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T13:27:55.213Z",
            "source": null,
            "credited_to": null,
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 215725,
                    "name": "Operations Manger "
                }
            ],
            "status": "active",
            "current_stage": {
                "id": 1579673,
                "name": "Application Review"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        }
    ],
    "educations": [],
    "employments": [],
    "custom_fields": {
        "desired_salary": null,
        "work_remotely": null,
        "graduation_year": null
    },
    "keyed_custom_fields": {
        "desired_salary": null,
        "work_remotely": null,
        "graduation_year_1": null
    }
}

Create a new candidate.

HTTP Request

POST https://harvest.greenhouse.io/v1/candidates

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
first_nameYesstringThe candidate’s first name
last_nameYesstringThe candidate’s last name
companyNostringThe candidate’s company
titleNostringThe candidate’s title
phone_numbers[]Nophone_numberArray of phone numbers. Passing an empty array will clear all.
addresses[]NoaddressArray of addresses. Passing an empty array will clear all.
email_addresses[]Noemail_addressArray of email addresses. Passing an empty array will clear all.
website_addresses[]Nowebsite_addressArray of website addresses. Passing an empty array will clear all.
social_media_addresses[]Nosocial_media_addressArray of social media addresses. Passing an empty array will clear all.
tags[]NostringArray of tags as strings. Passing an empty array will clear all.
custom_fields[]Nocustom_fieldArray of hashes containing new custom field values. Passing an empty array does nothing.
recruiterNoObjectAn object representing the candidate’s recruiter
recruiter[id]NoIntegerThe ID of the recruiter - either id or email must be present.
recruiter[email]NoStringThe email of the recruiter - either id or email must be present.
coordinatorNoObjectAn object representing the candidate’s coordinator
coordinator[id]NoIntegerThe ID of the coordinator - either id or email must be present.
coordinator[email]NoStringThe email of the coordinator - either id or email must be present.
custom_fieldsNoArrayArray of custom field value objects - See “Custom Field Parameters” under Edit candidate for parameters.
activity_feed_notesNoArrayAn array of activity feed objects. See Add Note for parameters.
applicationsYesArrayAn array of application objects. At least one required. See Add Application for parameters.


See noteworthy response attributes.

POST: Add Note

curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/notes'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "user_id": "158108",
  "body": "John Locke was moved into Recruiter Phone Screen for Accounting Manager on 03/27/2014 by Boone Carlyle",
  "visibility": "admin_only"
}

The above command returns a JSON response, structured like this:

{
  "id": 226809052,
  "created_at": "2015-07-17T16:29:31Z",
  "body": "John Locke was moved into Recruiter Phone Screen for Accounting Manager on 03/27/2014 by Boone Carlyle",
  "user": {
     "id": 214,
        "first_name": "Boone",
        "last_name": "Carlyle",
        "name": "Boone Carlyle",
        "employee_id": null
  },
  "private": false,
  "visiblity": "admin_only",
  "visibility": "admin_only"
}

Create a candidate note.

HTTP Request

POST https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/notes

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
user_idYesintegerThe ID of the user creating the note
bodyYesstringNote body
visibility*YesstringOne of: "admin_only", "private", "public"

* - Due to a legacy typo, the response includes the same value as visiblity. It is safe to ignore this value, but it is maintained for backward compatibility.

POST: Add Prospect

curl -X POST 'https://harvest.greenhouse.io/v1/prospects'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "first_name": "John",
  "last_name": "Locke",
  "company": "The Tustin Box Company",
  "title": "Man of Mystery",
  "is_private": false,
  "phone_numbers": [
    {
      "value": "555-1212",
      "type": "mobile"
    }
  ],
  "addresses": [
    {
      "value": "123 Fake St.",
      "type": "home"
    }
  ],
  "email_addresses": [
    {
      "value": "john.locke+work@example.com",
      "type": "work"
    },
    {
      "value": "john.locke@example.com",
      "type": "personal"
    }
  ],
  "website_addresses": [
    {
      "value": "johnlocke.example.com",
      "type": "personal"
    }
  ],
  "social_media_addresses": [
    {
      "value": "linkedin.example.com/john.locke"
    },
    {
      "value": "@johnlocke"
    }
  ],
  "tags": [
    "Walkabout",
    "Orientation"
  ],
  "application": {
    "job_ids": [123, 456, 789],
    "source_id": 1234,
    "referrer": {
      "type": "id",
      "value": 770
    },
    "custom_fields": [],
    "attachments": []
  }
}

The above returns a JSON response, structured like this:

{
  "id": 29843268,
  "first_name": "John",
  "last_name": "Locke",
  "company": "The Tustin Box Company",
  "title": "Man of Mystery",
  "is_private": false,
  "created_at": "2016-12-21T19:45:01.467Z",
  "updated_at": "2016-12-21T19:45:01.907Z",
  "last_activity": "2016-12-21T19:45:01.867Z",
  "photo_url": null,
  "attachments": [],
  "application_ids": [
    38776657
  ],
  "phone_numbers": [
    {
      "value": "555-1212",
      "type": "mobile"
    }
  ],
  "addresses": [
    {
      "value": "123 Fake St.",
      "type": "home"
    }
  ],
  "email_addresses": [
    {
      "value": "john.locke@example.com",
      "type": "personal"
    },
    {
      "value": "john.locke+work@example.com",
      "type": "work"
    }
  ],
  "website_addresses": [
    {
      "value": "johnlocke.example.com",
      "type": "personal"
    }
  ],
  "social_media_addresses": [
    {
      "value": "@johnlocke"
    },
    {
      "value": "linkedin.example.com/john.locke"
    }
  ],
  "recruiter": null,
  "coordinator": null,
  "tags": [
    "Orientation",
    "Walkabout"
  ],
  "applications": [
    {
      "id": 38776657,
      "candidate_id": 29843268,
      "prospect": true,
      "applied_at": "2016-12-21T19:45:01.757Z",
      "rejected_at": null,
      "last_activity_at": "2016-12-21T19:45:01.867Z",
      "source": null,
      "credited_to": null,
      "rejection_reason": null,
      "rejection_details": null,
      "jobs": [],
      "status": "active",
      "current_stage": null,
      "answers": [],
      "custom_fields": {
        "test": "A test value"
      },
      "keyed_custom_fields": {
         "test": {
            "name": "Test",
            "type": "long_text",
            "value": "A test value"
          }
        }
     }
  ],
  "educations": [],
  "custom_fields": {
    "current_salary": "$123,000",
    "desired_salary": "$150,000"
  },
  "keyed_custom_fields": {
    "current_salary": {
      "name": "Current salary",
      "type": "short_text",
      "value": "$123,000"
    },
    "desired_salary": {
      "name": "Desired salary",
      "type": "short_text",
      "value": "$150,000"
    }
  }
}

Create a new prospect. The difference between a prospect and a candidate is that a prospect can be on no jobs or many jobs. A prospect application 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. Alternatively, you can add a candidate application to a prospect’s profile by using the Add Candidate Application endpoint. The organization must be able to create prospects to set this field.

HTTP Request

POST https://harvest.greenhouse.io/v1/prospects

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
first_nameYesstringThe prospect’s first name
last_nameYesstringThe prospect’s last name
companyNostringThe prospect’s company
titleNostringThe prospect’s title
phone_numbers[]Nophone_numberArray of phone numbers. Passing an empty array will clear all.
addresses[]NoaddressArray of addresses. Passing an empty array will clear all.
email_addresses[]Noemail_addressArray of email addresses. Passing an empty array will clear all.
website_addresses[]Nowebsite_addressArray of website addresses. Passing an empty array will clear all.
social_media_addresses[]Nosocial_media_addressArray of social media addresses. Passing an empty array will clear all.
tags[]NostringArray of tags as strings. Passing an empty array will clear all.
custom_fields[]Nocustom_fieldArray of hashes containing new custom field values. Passing an empty array does nothing.
recruiterNoObjectAn object representing the prospect’s recruiter
recruiter[id]NoIntegerThe ID of the recruiter - either id or email must be present.
recruiter[email]NoStringThe email of the recruiter - either id or email must be present.
coordinatorNoObjectAn object representing the prospect’s coordinator
coordinator[id]NoIntegerThe ID of the coordinator - either id or email must be present.
coordinator[email]NoStringThe email of the coordinator - either id or email must be present.
custom_fieldsNoArrayArray of custom field value objects - See “Custom Field Parameters” under Edit candidate for parameters.
activity_feed_notesNoArrayAn array of activity feed objects. See Add Note for parameters.
applicationNoHashAs opposed to candidate, a prospect is a single application object that contains multiple job ids. A prospect in Greenhouse can be attached to zero or many jobs. If the request does not contain an application object, the person will be created as a jobless prospect. The source_id, referrer, custom_fields, and attachments parameters in this object match the format of the Add Application endpoint.
application[job_ids]NoArrayThis element is unique to the prospects endpoint. This contains an array of job ids to which the prospect will be assigned. Note that even if the application object is included, this may still be blank or omitted and the request will create a jobless prospect. A normal use case for this would be creating a jobless prospect but still wanting to attach their resume or identify their source.


See noteworthy response attributes.

PUT: Anonymize Candidate

curl -X PUT 'https://harvest.greenhouse.io/v1/candidates/{id}/anonymize?fields={field_names}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns a JSON response, structured like this:

{
    "id": 53883394,
    "first_name": "Anonymized",
    "last_name": "53883394",
    "company": null,
    "title": null,
    "created_at": "2017-08-15T03:31:46.591Z",
    "updated_at": "2017-09-28T13:36:04.725Z",
    "last_activity": "2017-09-28T13:31:37.929Z",
    "is_private": false,
    "photo_url": "https://prod-heroku.s3.amazonaws.com/people/photos/053/883/394/original/corgi.jpg?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509197765&Signature=pr0qNjZvTvLCV2td9hebhEa7P3Y%3D",
    "attachments": [
        {
            "filename": "John_Locke_Offer_Packet_09_28_2017.pdf",
            "url": "https://prod-heroku.s3.amazonaws.com/person_attachments/data/077/815/020/original/John_Locke_Offer_Packet_09_28_2017.pdf?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509197765&Signature=rV%2FW668FnnG4EFGLJbHrnY%2B7Mvs%3D",
            "type": "offer_packet"
        }
    ],
    "application_ids": [
        69201279
    ],
    "phone_numbers": [],
    "addresses": [
        {
            "value": "123 City Street\nNew York, Ny 10001",
            "type": "home"
        }
    ],
    "email_addresses": [],
    "website_addresses": [
        {
            "value": "mysite.com",
            "type": "personal"
        }
    ],
    "social_media_addresses": [],
    "recruiter": {
        "id": 92120,
        "first_name": "Greenhouse",
        "last_name": "Admin",
        "name": "Greenhouse Admin",
        "employee_id": null
    },
    "coordinator": null,
    "tags": [
        "Python",
        "Ruby"
    ],
    "applications": [
        {
            "id": 69201279,
            "candidate_id": 53883394,
            "prospect": false,
            "applied_at": "2017-09-28T13:21:22.749Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T13:31:37.929Z",
            "source": {
                "id": 7,
                "public_name": "Indeed"
            },
            "credited_to": {
                "id": 566993,
                "first_name": "Jane",
                "last_name": "Smith",
                "name": "Jane Smith",
                "employee_id": null
            },
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 213967,
                    "name": "Head of Product"
                }
            ],
            "status": "active",
            "current_stage": {
                "id": 1567309,
                "name": "Application Review"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        }
    ],
    "educations": [
        {
            "id": 561227,
            "school_name": "University of Michigan - Ann Arbor",
            "degree": "Bachelor's Degree",
            "discipline": "Computer Science"
        }
    ],
    "employments": [],
    "custom_fields": {
        "desired_salary": null,
        "work_remotely": null,
        "graduation_year": null
    },
    "keyed_custom_fields": {
        "desired_salary": null,
        "work_remotely": null,
        "graduation_year_1": null
    }
}

Anonymize the data associated with a candidate.

HTTP Request

PUT https://harvest.greenhouse.io/v1/candidates/{id}/anonymize?fields={field_names}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

Querystring Parameters

ParameterRequiredTypeDescription
fieldsYescomma-delimited stringThe set of field names that should be anonymized on the candidate from the following list: full_name, current_company, current_title, tags, phone_numbers, emails, social_media_links, websites, addresses, location, custom_candidate_fields, source, recruiter, coordinator, attachments, application_questions, referral_questions, notes, rejection_notes, email_addresses, activity_items, innotes, inmails, rejection_reason, scorecards_and_interviews, offers, credited_to, headline, all_offer_versions, and follow_up_reminders.

PUT: Merge Candidates

curl -X PUT 'https://harvest.greenhouse.io/v1/candidates/merge'
-d '{ "primary_candidate_id": 73821, "duplicate_candidate_id": 839283 }'
-H "Content-Type: application/json"
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns a JSON response, structured like this:

{
    "id": 55961742,
    "first_name": "Justin",
    "last_name": "Locke",
    "company": "The Tustin Box Company",
    "title": "Man of Mystery",
    "created_at": "2017-09-07T22:54:06.629Z",
    "updated_at": "2017-09-28T13:41:43.655Z",
    "last_activity": "2017-09-28T13:41:43.631Z",
    "is_private": false,
    "photo_url": null,
    "attachments": [
        {
            "filename": "Justin Locke resume.pdf",
            "url": "https://prod-heroku.s3.amazonaws.com/person_attachments/data/048/999/636/original/Byron%20Sonnett%20resume.pdf?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509198103&Signature=Zc%2BenNvJyxH4FatQBRFz8248GUM%3D",
            "type": "resume"
        },
         {
            "filename": "Justin Locke cover leter.pdf",
            "url": "https://prod-heroku.s3.amazonaws.com/person_attachments/data/048/999/636/original/Byron%20Sonnett%20resume.pdf?AWSAccessKeyId=AKIAIK36UTOKQ5F2YNMQ&Expires=1509198103&Signature=Zc%2BenNvJyxH4FatQBRFz8248GUM%3D",
            "type": "cover_letter"
        }
    ],
    "application_ids": [
        67398864
    ],
    "phone_numbers": [
        {
            "value": "222-555-4608",
            "type": "home"
        }
    ],
    "addresses": [],
    "email_addresses": [
        {
            "value": "justin.locke@example.com",
            "type": "personal"
        }
    ],
    "website_addresses": [
        {
            "value": "example.com",
            "type": "other"
        }
    ],
    "social_media_addresses": [],
    "recruiter": null,
    "coordinator": null,
    "tags": [
        "Comp Sci"
    ],
    "applications": [
        {
            "id": 67398864,
            "candidate_id": 55961742,
            "prospect": false,
            "applied_at": "2017-09-07T23:00:25.746Z",
            "rejected_at": null,
            "last_activity_at": "2017-09-28T13:41:43.631Z",
            "source": {
                "id": 7,
                "public_name": "Indeed"
            },
            "credited_to": {
                "id": 92121,
                "first_name": "Jane",
                "last_name": "Smith",
                "name": "Jane Smith",
                "employee_id": "456"
            },
            "rejection_reason": null,
            "rejection_details": null,
            "jobs": [
                {
                    "id": 213967,
                    "name": "Product Manager"
                }
            ],
            "status": "active",
            "current_stage": {
                "id": 1567309,
                "name": "Application Review"
            },
            "answers": [],
            "prospect_detail": {
                "prospect_pool": null,
                "prospect_stage": null,
                "prospect_owner": null
            }
        }
    ],
    "educations": [
        {
            "id": 561227,
            "school_name": "University of Michigan - Ann Arbor",
            "degree": "Bachelor's Degree",
            "discipline": "Computer Science"
        }
    ],
    "employments": [],
      "custom_fields": {
        "desired_salary": "120K",
        "work_remotely": true,
        "graduation_year": "2018"
    },
    "keyed_custom_fields": {
        "desired_salary": {
            "name": "Desired Salary",
            "type": "short_text",
            "value": "120K"
        },
        "work_remotely": {
            "name": "Work Remotely",
            "type": "boolean",
            "value": true
        },
        "graduation_year_1": {
            "name": "Graduation Year",
            "type": "single_select",
            "value": "2018"
        }
    }
}

Merge two candidates into one.

HTTP Request

PUT https://harvest.greenhouse.io/v1/candidates/merge

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
primary_candidate_idYesintegerThe id of the first candidate that will be merged. This candidate will also be the result of the merge.
duplicate_candidate_idYesintegerThe id of the second candidate that will be merged. This candidate will cease to exist after the merge is complete.

Custom Fields

An organization’s custom_fields.

The custom field object

{
  "id": 123456,
  "name": "Custom Field Name",
  "field_type": "job",
  "priority": 1,
  "value_type": "single_select",
  "private": true,
  "required": false,
  "require_approval": true,
  "trigger_new_version": false,
  "name_key": "custom_field_name",
  "custom_field_options": [
    {
      "id": 123,
      "name": "Name One",
      "priority": 1
    },
    {
      "id": 234,
      "name": "Name Two",
      "priority": 2
    }
  ]
}

Noteworthy attributes

AttributeDescription
idThe custom field’s unique identifier
nameThe field’s name in Greenhouse
field_typeOne of job, candidate, application, offer, rejection_question, referral_question. This is also included in the URL as an argument, which will return only custom fields that match the given type.
priorityNumeric field used for ordering in Greenhouse.
value_typeOne of short_text, long_text, yes_no, single_select, multi_select, currency, currency_range, number, number_range, date, url, or user
privateBoolean value to say if this field is private in Greenhouse.
requiredThe object this field exists on can not be saved if this value is not set.
require_approvalOnly applicable to job custom fields, changes to this fields requires an approval flow in Greenhouse to be re-done.
trigger_new_versionOnly applicable to offer custom fields, changes to this field creates a new offer version.
name_keyListed as “immutable field key” in Greenhouse, this value is based of the name of the field when it is created and does not change as the field’s name is later updated.
custom_field_optionsFor single_select and multi_select field_types, this is the list of options for that select.
custom_field_options.priorityNumeric value used for ordering the custom field options.

GET: List Custom Fields

curl 'https://harvest.greenhouse.io/v1/custom_fields/{field_type}'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 123456,
    "name": "Custom Field Name",
    "field_type": "job",
    "priority": 1,
    "value_type": "single_select",
    "private": true,
    "required": false,
    "require_approval": true,
    "trigger_new_version": false,
    "name_key": "custom_field_name",
    "custom_field_options": [
      {
        "id": 123,
        "name": "Name One",
        "priority": 1
      },
      {
        "id": 234,
        "name": "Name Two",
        "priority": 2
      }
    ]
  }
]

HTTP Request

GET https://harvest.greenhouse.io/v1/custom_fields/{field_type}

Querystring parameters

ParameterDescription
field_typeReturns only custom fields of this type. For example, if “offer” is included in the URL as the field_type, the endpoint will only return custom fields with the “offer” field type.


See noteworthy response attributes.

This endpoint supports pagination. See the Pagination section for more detail.

GET: Retrieve Custom Field

curl 'https://harvest.greenhouse.io/v1/custom_field/{id}'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 123456,
  "name": "Custom Field Name",
  "field_type": "job",
  "priority": 1,
  "value_type": "single_select",
  "private": true,
  "required": false,
  "require_approval": true,
  "trigger_new_version": false,
  "name_key": "custom_field_name",
  "custom_field_options": [
    {
      "id": 123,
      "name": "Name One",
      "priority": 1
    },
    {
      "id": 234,
      "name": "Name Two",
      "priority": 2
    }
  ]
}

HTTP Request

GET https://harvest.greenhouse.io/v1/custom_field/{id}

URL Parameters

ParameterDescription
idThe ID of the custom field to retrieve


See noteworthy response attributes.

The custom field options object

Refers to the options available for single-select and multi-select custom fields.

{
  "id": 123456,
  "name": "Option A",
  "prioirty": 0
}

Noteworthy attributes

AttributeDescription
priorityNumeric field used for ordering in Greenhouse.

GET: List Custom Field Options

curl 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 123456,
    "name": "Option A",
    "prioirty": 0
  },
  {
    "id": 123457,
    "name": "Option B",
    "prioirty": 1
  },
  {
    "id": 123458,
    "name": "Option C",
    "prioirty": 2
  }
]

Given a single select or multi select custom field, return all its options.

HTTP Request

GET https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options

Querystring parameters

ParameterDescription
typeOne of all, active, or inactive. Inactive returns only custom field options that have been deleted. Active is the default and returns all custom field options currently active. All returns both active and inactive. If this isn’t included, active fields will be returned.


This endpoint supports pagination. See the Pagination section for more detail.

POST: Create Custom Field Options

curl -X POST 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options'
  -H "On-Behalf-Of: {greenhouse user ID}"
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "options": [
    {"name": "Option A", "priority": 5},
    {"name": "Option B", "priority": 6},
    {"name": "Option C", "priority": 7}
  ]
}

The above returns a success message on success with a 201 response.

{
  "message": "success"
}

Add additional options to a single select or multi select custom field.

HTTP Request

POST https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
optionsYesarrayAn array of one or many new custom field options.
nameYesstringThe name of the new custom field option. If a new field is added with the same name as an existing custom field option in this custom field, it will be ignored. No error will be raised in this case.
priorityYesintegerThis is used to order the custom fields in Greenhouse.


**This returns a 201 on success. It does not return the objects created.

PATCH: Update Custom Field Options

curl -X PATCH 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options'
  -H "On-Behalf-Of: {greenhouse user ID}"
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "options": [
    {"id": 123, "name": "Option A", "priority": 5},
    {"id": 234, "name": "Option B", "priority": 6},
    {"id": 345, "name": "Option C", "priority": 7}
  ]
}

The above request returns a JSON success message.

{
  "message": "success"
}

Update the names or priorities of existing options in a single select or multi select custom field.

HTTP Request

PATCH https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
optionsYesarrayAn array of one or many new custom field options.
idYesintegerThe ID of the custom field option that will be updated.
nameNostringIf included, the custom field option with this ID will be updated to this name. This can not duplicate the name of any other option in this field or any option in this request.
priorityNointegerIf included, The custom field option with this ID will be updated with this value.


DELETE: Remove Custom Field Options

curl -X DELETE 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options'
  -H "On-Behalf-Of: {greenhouse user ID}"
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "option_ids": [1, 2, 3, 4]
}

The above request is idempotent. It will return a message with a 200 response and a message stating how many of the IDs were deleted and how many were not found.

{
  "message": "3 option(s) deleted. 1 option(s) not found."
}

Destroy custom field options

HTTP Request

DELETE https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
option_idsYesarrayAn array of the custom field option ids to be removed.


* Note this does not return a list of option_ids that were not found. It only returns a number of options that were not processed. If you were to run the same exact command twice in a row, the only difference would be that on the second run, the message would inform you that an ID was not found.

Departments

The department object

An organization’s departments.

With render_as=list (default)

{
    "id": 1,
    "name": "Technology",
    "parent_id": 5,
    "child_ids": [11, 12]
}

With render_as=tree

{
    "id": 1,
    "name": "Technology",
    "children": [
      {
        "id": 11,
        "name": "Design",
        "children": []
      },
      {
        "id": 12,
        "name": "Engineering",
        "children": []
      }
    ]
}

Noteworthy attributes

AttributeDescription
idThe department’s unique identifier
nameThe department’s name

GET: List Departments

List all of an organization’s departments.

curl 'https://harvest.greenhouse.io/v1/departments' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

With render_as=list (default)

[
  {
    "id": 1,
    "name": "Technology",
    "parent_id": 5,
    "child_ids": [11, 12]
  },
  {
    "id": 2,
    "name": "Administration",
    "parent_id": null,
    "child_ids": []
  }
]

With render_as=tree

[
  {
    "id": 1,
    "name": "Technology",
    "children": [
      {
        "id": 11,
        "name": "Design",
        "children": []
      },
      {
        "id": 12,
        "name": "Engineering",
        "children": []
      }
    ]
  },
  {
    "id": 2,
    "name": "Administration",
    "children": []
  }
]

HTTP Request

GET https://harvest.greenhouse.io/v1/departments

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
render_asThis parameter defines how to represent the list of departments. The default value is ‘list’, which returns a flat list of departments. If this is set to 'tree’, departments are represented in a tree-like structure where they may include sub-departments as children.


See noteworthy response attributes.

GET: Retrieve Department

curl 'https://harvest.greenhouse.io/v1/departments/{id}' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

With render_as=list (default)

{
    "id": 1,
    "name": "Technology",
    "parent_id": 5,
    "child_ids": [11, 12]
}

With render_as=tree

{
    "id": 1,
    "name": "Technology",
    "children": [
      {
        "id": 11,
        "name": "Design",
        "children": []
      },
      {
        "id": 12,
        "name": "Engineering",
        "children": []
      }
    ]
}

Retrieve a department by its id.

HTTP Request

GET https://harvest.greenhouse.io/v1/departments/{id}

URL Parameters

ParameterDescription
idThe ID of the department to retrieve

Querystring parameters

ParameterDescription
render_asThis parameter defines how to represent the list of departments. The default value is 'list’, which returns a flat list of departments. If this is set to 'tree’, departments are represented in a tree-like structure where they may include sub-departments as children.


See noteworthy response attributes.

POST: Add Department

curl -X POST 'https://harvest.greenhouse.io/v1/departments
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "name": "A New Department",
  "parent_id": 12345
}

The above command returns a JSON response, structured like this:

{
  "id": 3,
  "name": "A New Department",
  "parent_id": 12345,
  "child_ids": []
}

Create a new department

HTTP Request

POST https://harvest.greenhouse.io/v1/departments

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes. Must be a user who can create departments.

JSON Body Parameters

ParameterRequiredTypeDescription
nameyesstringThe name of your new department. Must be less than 255 characters and unique within your organization.
parent_id*nonumberThe department id for the new department to be nested under. If this isn’t included, the department will be created at the top level.

* - The tiered department feature is available only for customers with Standard or Premium Greenhouse Recruiting. Use of this field will return an error for Basic Greenhouse Recruiting customers.

EEOC

The EEOC object

Every application may have zero or one EEOC object.

{
  "application_id": 286,
  "candidate_id": 406,
  "race": {
    "id": 7,
    "description": "Two or More Races"
  },
  "gender": {
    "id": 1,
    "description": "Male"
  },
  "veteran_status": {
    "id": 3,
    "message": "I don't wish to answer"
  },
  "disability_status": {
    "id": 1,
    "description": "Yes, I have a disability (or previously had a disability)"
  },
  "submitted_at": "2017-01-29T15:09:46.806Z"
}

Noteworthy attributes

AttributeDescription
application_idApplication ID
candidate_idThe ID of the candidate who is applying for the job associated with this application.
raceSee the EEOC Reference below
genderSee the EEOC Reference below
veteran_statusSee the EEOC Reference below
disability_statusSee the EEOC Reference below
submitted_atThe timestamp in ISO-8601 at which the EEOC data was submitted.

EEOC Reference

Race

iddescription
1American Indian or Alaskan Native
2Asian
3Black or African American
4Hispanic or Latino
5White
6Native Hawaiian or Other Pacific Islander
7Two or More Races
8Decline To Self Identify

Gender

iddescription
1Male
2Female
3Decline To Self Identify

Veteran Status

iddescription
1I am not a protected veteran
2I identify as one or more of the classifications of a protected veteran
3I don’t wish to answer

Disability Status

iddescription
1Yes, I have a disability (or previously had a disability)
2No, I don’t have a disability
3I don’t wish to answer

GET: List EEOC

curl 'https://harvest.greenhouse.io/v1/eeoc'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[{
  "application_id": 286,
  "candidate_id": 406,
  "race": {
    "id": 7,
    "description": "Two or More Races"
  },
  "gender": {
    "id": 1,
    "description": "Male"
  },
  "veteran_status": {
    "id": 3,
    "message": "I don't wish to answer"
  },
  "disability_status": {
    "id": 1,
    "description": "Yes, I have a disability (or previously had a disability)"
  },
  "submitted_at": "2017-01-29T15:09:46.806Z"
},
{
  "application_id": 287,
  "candidate_id": 342,
  "race": {
    "id": 7,
    "description": "Two or More Races"
  },
  "gender": {
    "id": 2,
    "description": "Female"
  },
  "veteran_status": null,
  "disability_status": {
    "id": 1,
    "description": "Yes, I have a disability (or previously had a disability)"
  },
  "submitted_at": "2017-01-30T17:10:32.432Z"
}]

List all of an organization’s EEOC data.

HTTP Request

GET https://harvest.greenhouse.io/v1/eeoc

Query string parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
submitted_beforeReturn only EEOC data submitted before this timestamp. Timestamp must be in ISO-8601 format.
submitted_afterReturn only EEOC data submitted after this timestamp. Timestamp must be in ISO-8601 format.

This endpoint supports pagination. See the Pagination section for more detail.

GET: Retrieve EEOC Data for Application

curl 'https://harvest.greenhouse.io/v1/applications/{id}/eeoc'
  -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "application_id": 286,
  "candidate_id": 406,
  "race": {
    "id": 7,
    "description": "Two or More Races"
  },
  "gender": {
    "id": 1,
    "description": "Male"
  },
  "veteran_status": {
    "id": 3,
    "message": "I don't wish to answer"
  },
  "disability_status": {
    "id": 1,
    "description": "Yes, I have a disability (or previously had a disability)"
  },
  "submitted_at": "2017-01-29T15:09:46.806Z"
}

Retrieve an application’s EEOC data by an application ID.

HTTP Request

GET https://harvest.greenhouse.io/v1/applications/{id}/eeoc

URL Parameters

ParameterDescription
idID of the application whose EEOC data you want to retrieve.

Email Templates

An organization’s email templates.

The email template object

{
  "id": 230,
  "name": "Default Scorecard Due",
  "description": null,
  "default": true,
  "type": "scorecard_reminder",
  "from": null,
  "cc": [],
  "body": "Just a friendly reminder to please submit feedback for your interview with  earlier today.",
  "html_body": null,
  "user": null
}

Noteworthy attributes

AttributeDescription
idThe email template’s unique identifier
typeOne of: new_candidate, weekly_status, daily_recruiting, stage_transition, new_scorecard, new_referral, agency_candidate_status, agency_candidate_stage, take_home_test_email, candidate_auto_reply, candidate_rejection, scorecard_reminder, interviewer_invite, candidate_email, team_email, none, extending_offer, new_agency_submission, non_admin_welcome, job_admin_welcome, site_admin_welcome, prospect_referral_receipt, candidate_referral_receipt, candidate_availability_request, candidate_availability_confirmation
userThe user this template belongs to. If null, this is an ‘organization wide’ template available to everyone.
bodyThe plain text body of the e-mail (may be null).
html_bodyThe body of the e-mail with html styling code (may be null).

GET: List Email Templates

List all of an organization’s email templates.

curl 'https://harvest.greenhouse.io/v1/email_templates/' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 230,
    "name": "Default Scorecard Due",
    "description": null,
    "default": true,
    "type": "scorecard_reminder",
    "from": null,
    "cc": [],
    "body": "Just a friendly reminder to please submit feedback for your interview with  earlier today.",
    "html_body": null,
    "user": null
  },
  {
    "id": 1978,
    "name": "Candidate On-site Confirmation",
    "description": "",
    "default": false,
    "type": "none",
    "from": "ben.linus@example.com",
    "cc": ["coordinator@example.com"],
    "body": "Hi , it's go time!",
    "html_body": "<p><b>Hi </b>,</p> <p><i>it's go time!</i></p>",
    "user": {
      "id": 442,
      "name": "Ben Linus"
    }
  }
]

HTTP Request

GET https://harvest.greenhouse.io/v1/email_templates

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only email templates that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only email templates that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only email templates that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only email templates that were updated after this timestamp. Timestamp must be in in ISO-8601 format.


See noteworthy response attributes.

GET: Retrieve Email Template

curl 'https://harvest.greenhouse.io/v1/email_templates/{id}' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 230,
  "name": "Default Scorecard Due",
  "description": null,
  "default": true,
  "type": "scorecard_reminder",
  "from": null,
  "cc": [],
  "body": "Just a friendly reminder to please submit feedback for your interview with  earlier today.",
  "html_body": null,
  "user": null
}

Retrieve an email template by its id.

HTTP Request

GET https://harvest.greenhouse.io/v1/email_templates/{id}

URL Parameters

ParameterDescription
idThe ID of the email template to retrieve


See noteworthy response attributes.

Job Openings

This endpoint is used to managing openings on jobs.

The job opening object

{
    "id": 123,
    "opening_id": "OPENED-1",
    "status": "open",
    "opened_at": "2015-11-19T19:53:32.565Z",
    "closed_at": null,
    "application_id": null,
    "close_reason": null
},
{
    "id": 123,
    "opening_id": "CLOSED-1",
    "status": "closed",
    "opened_at": "2015-11-19T19:53:32.565Z",
    "closed_at": "2015-12-14T19:53:32.565Z",
    "application_id": 65565,
    "close_reason": {
      "id": 678,
      "name": "Hired - Backfill"
    }
}

Noteworthy Attributes

AttributeDescription
idThe opening’s unique identifier
opening_idThis is a text string used to identify the opening. This is defined by the users and may be null.
statusEither “open” or “closed”
opened_atThis is the date and time this opening was created.
closed_atThis is when the opening was closed; usually via the opening being filled. This should be null for opened openings.
application_idThe application that was used to fill this opening. This should only be set on a closed opening, null otherwise.

GET: List Job Openings

curl 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 123,
    "opening_id": "OPENED-1",
    "status": "open",
    "opened_at": "2015-11-19T19:53:32.565Z",
    "closed_at": null,
    "application_id": null,
    "close_reason": null
  },
  {
    "id": 123,
    "opening_id": "CLOSED-1",
    "status": "closed",
    "opened_at": "2015-11-19T19:53:32.565Z",
    "closed_at": "2015-12-14T19:53:32.565Z",
    "application_id": 65565,
    "close_reason": {
      "id": 678,
      "name": "Hired - Backfill"
    }
  }
]

List all of a job’s openings

HTTP Request

GET https://harvest.greenhouse.io/v1/jobs/{job_id}/openings

URL Paramters

ParameterDescription
job_idThe ID of the job for which you want to retrieve openings.

Querystring Parameters

ParameterDescription
statusMay contain either “opened” or “closed”; when set will return only open or closed openings, respectively. Returns all openings if this isn’t set or set to an unrecognized value.

This endpoint supports pagination. See the Pagination section for more detail.

See noteworthy response attributes.

GET: Single Opening For Job

curl 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
    "id": 123,
    "opening_id": "OPENED-1",
    "status": "open",
    "opened_at": "2015-11-19T19:53:32.565Z",
    "closed_at": null,
    "application_id": null,
    "close_reason": null
}

Retrieve the information for a single opening.

HTTP Request

GET https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{id}

URL Parameters

ParameterDescription
job_idThe ID of the job for which you want to retrieve openings.
idThe ID of the opening you want to retrieve. Note: this is NOT the opening_id which is mutable and defined by Greenhouse users, but the id of an opening, which is unique to that opening and not mutable.

See noteworthy response attributes.

POST: Create New Openings

curl -X POST 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
    "openings": [
      {"opening_id": "abc-123"},
      {"opening_id": null}
    ]
}

HTTP Request

POST https://harvest.greenhouse.io/v1/jobs/{job_id}/openings

URL Parameters

ParameterDescription
job_idThe ID of the job on which to add new openings.

JSON Body Parameters

ParameterRequiredTypeDescription
openingsyesArrayThis an array of opening IDs, which contain one element.
openings.opening_idyesArrayThis is a string that contains an opening_id. One new opening will be created for each hash element in the array. Opening ID is not required to have a string value and may be null. Greenhouse has an internal limit of 100 open openings. If you attempt to create more than 100 openings in a single request, or if this request would create more than 100 open openings, the request will fail.

Note: Adding new openings may re-trigger approvals. For approvals to start recruiting, this will reset approvals only if the job is in draft mode. If the job is open for hiring, these approvals will not reset. For official job approvals, this will reset approvals only if the job is open.

The above returns a JSON response, structured like this:

{
    "id": 123456,
    "opening_id": "abc-123",
    "open_date": "2017-10-02T19:53:32.565Z"
},
{
    "id": 123457,
    "opening_id": null,
    "open_date": "2017-10-02T19:53:32.565Z"
}

DELETE: Destroy Openings

curl -X DELETE 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
    "ids": [123, 456, 789]
}

HTTP Request

DELETE https://harvest.greenhouse.io/v1/jobs/{job_id}/openings

JSON Body Parameters

ParameterRequiredTypeDescription
idsyesArrayAn array of opening ids to delete. Important to note that these are not opening_id from the other endpoints, but the unique id identifier.

Note: Closed/Filled openings can’t be destroyed. This request is idempotent and will return the number of items destroyed, the number of closed items that couldn’t be destroyed, and the number of IDs that could not be found. If you were to run the same request twice, the destroyed ID count would decrease and the invalid ID count would increase.

The above returns a JSON response, structured like this

{
    "success": "2 opening(s) destroyed. 1 opening(s) were closed and not destroyed. 0 id(s) were not found."
}

Job Posts

Describes the online job posts for an organization’s jobs (as seen on the Job Board).

The job post object

{
  "id": 123,
  "title": "Button Pusher",
  "location": {
    "name": "The Island"
  },
  "internal": true,
  "external": false,
  "live": true,
  "job_id": 1234,
  "content": "<p>Do you want to save the world? &nbsp;If so, apply today!</p>",
  "internal_content": "<p>Do you want to save the world? &nbsp;If so, apply today!</p>",
  "updated_at": "2014-04-01T17:56:19Z",
  "questions": [
    {
      "required": true,
      "private": false,
      "label": "First Name",
      "type": "short_text",
      "values": []
    },
    {
      "required": true,
      "private": false,
      "label": "Last Name",
      "type": "short_text",
      "values": []
    },
    {
      "required": true,
      "private": false,
      "label": "Email",
      "type": "short_text",
      "values": []
    },
    {
      "required": false,
      "private": false,
      "label": "Phone",
      "type": "short_text",
      "values": []
    },
    {
      "required": true,
      "private": false,
      "label": "Resume",
      "type": "attachment",
      "values": []
    },
    {
      "required": false,
      "private": false,
      "label": "Cover Letter",
      "type": "attachment",
      "values": []
    },
    {
      "required": false,
      "private": false,
      "label": "Location",
      "type": "short_text",
      "values": []
    },
    {
      "required": false,
      "private": false,
      "label": "Have you ever won the lottery?",
      "type": "boolean",
      "values": [
        {
          "value": 0,
          "label": "No"
        },
        {
          "value": 1,
          "label": "Yes"
        }
      ]
    },
    {
      "required": false,
      "private": true,
      "label": "Do you know what 'the numbers' are?",
      "type": "multi_select",
      "values": [
        {
          "value": 862,
          "label": "Yes"
        },
        {
          "value": 863,
          "label": "No"
        },
        {
          "value": 864,
          "label": "Maybe"
        }
      ]
    },
    {
      "required": true,
      "private": false,
      "label": "LinkedIn Profile",
      "type": "short_text",
      "values": []
    },
    {
      "required": true,
      "private": false,
      "label": "How did you hear about this job?",
      "type": "short_text",
      "values": []
    }
  ]
}

Noteworthy attributes

AttributeDescription
idJob post ID
internalIf true, this job post has been posted (or is to be posted) on an internal job board.
externalIf true, this job post has been posted (or is to be posted) on an external job board.
job_idThe ID of the job that this job post is for.
contentThe text of the job post as posted to the external job board.
internal_contentThe text of the job post if posted to the internal job board, if different than the external job board.
questionsAn array of questions associated with this job post.

GET: List Job Posts

curl 'https://harvest.greenhouse.io/v1/job_posts' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 123,
    "title": "Button Pusher",
    "location": {
      "name": "The Island"
    },
    "internal": true,
    "external": false,
    "live": true,
    "job_id": 1234,
    "content": "<p>Do you want to save the world? &nbsp;If so, apply today!</p>",
    "internal_content": "<p>Do you want to save the world? &nbsp;If so, apply today!</p>",
    "updated_at": "2014-04-01T17:56:19Z",
    "questions": [
      {
        "required": true,
        "private": false,
        "label": "First Name",
        "type": "short_text",
        "values": []
      },
      {  }
    ]
  },
]

List all of an organization’s job posts.

HTTP Request

GET https://harvest.greenhouse.io/v1/job_posts

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only job posts that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only job posts that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only job posts that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only job posts that were updated after this timestamp. Timestamp must be in in ISO-8601 format.
liveIf true, return only live job posts.


See noteworthy response attributes.

GET: List Job Posts for Job

curl 'https://harvest.greenhouse.io/v1/jobs/{id}/job_posts'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 129547,
    "live": true,
    "title": "Test job one",
    "location": {
      "name": "Material Plane"
    },
    "internal": false,
    "external": true,
    "job_id": 146218,
    "content": "job post content",
    "updated_at": "2016-09-19T14:04:25.297Z",
    "internal_content": "",
    "created_at": "2015-11-22T05:49:35.145Z",
    "questions": [
      {
        "required": true,
        "private": false,
        "label": "First Name",
        "type": "short_text",
        "values": []
      },
      {
        "required": true,
        "private": false,
        "label": "Last Name",
        "type": "short_text",
        "values": []
      }
    ]
  },
  {
    "id": 129548,
    "live": true,
    "title": "Test job two",
    "location": {
      "name": "Material Plane"
    },
    "internal": false,
    "external": true,
    "job_id": 146218,
    "content": "job post content two",
    "updated_at": "2016-09-19T14:04:25.297Z",
    "internal_content": "",
    "created_at": "2015-11-22T05:49:35.145Z",
    "questions": [
      {
        "required": true,
        "private": false,
        "label": "First Name",
        "type": "short_text",
        "values": []
      },
      {
        "required": true,
        "private": false,
        "label": "Last Name",
        "type": "short_text",
        "values": []
      }
    ]
  }
]

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

HTTP Request

GET https://harvest.greenhouse.io/v1/jobs/{id}/job_posts

URL parameters

ParameterDescription
idThe ID of the job whose job posts you want to retrieve


See noteworthy response attributes.

GET: Retrieve Job Post for Job

curl 'https://harvest.greenhouse.io/v1/jobs/{id}/job_post'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 123,
  "title": "Button Pusher",
  "location": {
    "name": "The Island"
  },
  "internal": true,
  "external": false,
  "live": true,
  "job_id": 1234,
  "content": "<p>Do you want to save the world? &nbsp;If so, apply today!</p>",
  "internal_content": null,
  "updated_at": "2014-04-01T17:56:19Z",
  "questions": [
    {
      "required": true,
      "private": false,
      "label": "First Name",
      "type": "short_text",
      "values": []
    },
    {  }
  ]
}

Retrieve the corresponding job post for a given Job ID.

HTTP Request

GET https://harvest.greenhouse.io/v1/jobs/{id}/job_post

URL parameters

ParameterDescription
idThe ID of the job whose job post you want to retrieve

Querystring parameters

ParameterDescription
contentIf present, will return the text of the job post as posted to the external job board.
questionsIf present, will return an array of questions associated with this job post.


See noteworthy response attributes.

PATCH: Update Job Post’s Status

curl -X PATCH 'https://harvest.greenhouse.io/v1/job_posts/{id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "status": "live"
}

The above returns a JSON response on success:

{
  "success": true
}

Update the live/offline status for a single job post by its id.

HTTP Request

PATCH https://harvest.greenhouse.io/v1/job_posts/{id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
statusyesstringOne of ‘live’ or 'offline’

Job Stages

An organization’s job stages.

The job stage object

{
  "id": 72200,
  "name": "Face to Face",
  "interviews": [
    {
      "id": 6001,
      "name": "Cultural Fit Interview",
      "interview_kit": {
        "id": 9123,
        "content": "<h5>Purpose</h5><span>Determine whether or not the candidate would be a strong fit.</span>",
        "questions": [
          {
            "id": 11052,
            "question": "Is this person really a good fit?"
          }
        ]
      }
    },
    {
      "id": 6002,
      "name": "Executive Interview",
      "interview_kit": {
        "id": 9124,
        "content": "<h5>Purpose</h5><span>See if they can work with the boss.</span>",
        "questions": [
          {
            "id": 11053,
            "question": "What's their favorite color?"
          },
          {
            "id": 11054,
            "question": "Do they really want to work here?"
          }
        ]
      }
    }
  ]
}

Noteworthy attributes

AttributeDescription
idThe job stage’s unique identifier
interviewsAn array of interviews associated with this job stage.

GET: List Job Stages

curl 'https://harvest.greenhouse.io/v1/job_stages' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 6001,
    "name": "Cultural Fit Interview",
    "created_at": "2015-11-22T05:31:37.263Z",
    "updated_at": "2015-11-22T05:31:37.263Z",
    "job_id": 12345,
    "interviews": [
      {
        "id": 7890,
        "name": "Cultural Fit Interview",
        "interview_kit": {
          "id": 9124,
          "content": "<h5>Purpose</h5><span>Determine whether or not the candidate would be a strong fit.</span>",
          "questions": [
              {
                "id": 11052,
                "question": "Is this person really a good fit?"
              }
            ]        
          }
        }
      ]
    },
  {
    "id": 6002,
    "name": "Executive Interview",
    "created_at": "2015-11-22T05:31:37.263Z",
    "updated_at": "2015-11-22T05:31:37.263Z",
    "job_id": 34567,
    "interviews": [
      {
        "id": 7345,
        "name": "Executive Interview",
        "interview_kit": {
          "id": 9125,
          "content": "<h5>Purpose</h5><span>Determine whether or not the candidate would be a strong fit.</span>",
          "questions": [
              {
                "id": 11053,
                "question": "What's their favorite color?"
              },
              {
                "id": 11054,
                "question": "Do they really want to work here?"
              }
            ]        
          }
        }
      ]
    }
  ]

List all of an organization’s job stages.

HTTP Request

GET https://harvest.greenhouse.io/v1/job_stages

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.


See noteworthy response attributes.

GET: List Job Stages for Job

curl 'https://harvest.greenhouse.io/v1/jobs/{id}/stages' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 72200,
    "name": "Face to Face",
    "created_at": "2015-11-22T05:31:37.263Z",
    "updated_at": "2015-11-22T05:31:37.263Z",
    "job_id": 146218,
    "interviews": [
      {
        "id": 6001,
        "name": "Cultural Fit Interview",
        "interview_kit": {
          "id": 9128,
          "content": "<h5>Purpose</h5><span>Determine whether or not the candidate would be a strong fit.</span>",
          "questions": [
            {
              "id": 11052,
              "question": "Is this person really a good fit?"
            }
          ]
        }
      },
      {
        "id": 6002,
        "name": "Executive Interview",
        "created_at": "2015-11-22T05:31:37.263Z",
        "updated_at": "2015-11-22T05:31:37.263Z",
        "job_id": 146219,
        "interview_kit": {
          "id": 9129,
          "content": "<h5>Purpose</h5><span>See if they can work with the boss.</span>",
          "questions": [
            {
              "id": 11053,
              "question": "What's their favorite color?"
            },
            {
              "id": 11054,
              "question": "Do they really want to work here?"
            }
          ]
        }
      }
    ]
  },
  {
    "id": 72199,
    "name": "Offer",
    "created_at": "2015-11-22T05:31:37.263Z",
    "updated_at": "2015-11-22T05:31:37.263Z",
    "job_id": 146220,
    "interviews": []
  },
  {
    "id": 72194,
    "name": "Application Review",
    "created_at": "2015-11-22T05:31:37.263Z",
    "updated_at": "2015-11-22T05:31:37.263Z",
    "job_id": 146221,
    "interviews": [
      {
        "id": 8004,
        "name": "Application Review",
        "interview_kit": {
          "id": 9130,
          "content": null,
          "questions": []
        }
      }
    ]
  }
]

Retrieve the stages for the specified job id.

HTTP Request

GET https://harvest.greenhouse.io/v1/jobs/{id}/stages

URL Parameters

ParameterDescription
idThe ID of the job whose job stages you want to retrieve.

Querystring parameters

ParameterDescription
created_beforeReturn only job stages that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only job stages that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only job stages that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only job stages that were updated after this timestamp. Timestamp must be in in ISO-8601 format.


See noteworthy response attributes.

GET: Retrieve Job Stage

curl 'https://harvest.greenhouse.io/v1/job_stages/{id}' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 6001,
  "name": "Cultural Fit Interview",
  "created_at": "2015-11-22T05:31:37.263Z",
  "updated_at": "2015-11-22T05:31:37.263Z",
  "job_id": 12345,
  "interviews": [
    {
      "id": 7890,
      "name": "Cultural Fit Interview",
      "interview_kit": {
        "id": 9127,
        "content": "<h5>Purpose</h5><span>Determine whether or not the candidate would be a strong fit.</span>",
        "questions": [
            {
              "id": 11052,
              "question": "Is this person really a good fit?"
            }
          ]        
        }
      }
    ]
  }

Retreieve a job stage by its id.

HTTP Request

GET https://harvest.greenhouse.io/v1/job_stages/{id}

URL Parameters

ParameterDescription
idThe ID of the job stage to retrieve


See noteworthy response attributes.

Jobs

The job object

An organization’s jobs.

{
  "id": 6404,
  "name": "Archaeologist",
  "requisition_id": "abc123",
  "notes": "<p>Resistance to electro-magnetic radiation a plus!</p>",
  "confidential": false,
  "status": "closed",
  "created_at": "2013-12-10T14:42:58Z",
  "opened_at": "2013-12-11T14:42:58Z",
  "closed_at": "2013-12-12T14:42:58Z",
  "departments": [
    {
      "id": 562,
      "name": "Exploration"
    }
  ],
  "offices": [
    {
      "id": 175,
      "name": "San Francisco",
      "location": {
        "name": "San Francisco, CA"
      }
    }
  ],
  "custom_fields": {
    "employment_type": "Full-Time",
    "maximum_budget": "$81.5k",
    "salary_range": {
      "min_value": 70000,
      "max_value": 90000,
      "unit": "USD"
    }
  },
  "keyed_custom_fields": {
    "employment_type": {
      "name": "Time type",
      "type": "single_select",
      "value": "Full-Time"
    },
    "budget": {
      "name": "Maximum Budget",
      "type": "short_text",
      "value": "Full-Time"
    },
    "salary_range": {
      "name": "Salary Range",
      "type": "currency_range",
      "value": {
        "min_value": 70000,
        "max_value": 90000,
        "unit": "USD"
      }
    }
  },
  "hiring_team": {
    "hiring_managers": [
      {
        "id": 84275,
        "name": "Kaylee Prime"
      },
      {
        "id": 169779,
        "name": "Hank Hollandaise"
      }
    ],
    "recruiters": [
      {
        "id": 81111,
        "name": "Samuel Skateboard",
        "responsible": false
      },
      {
        "id": 153448,
        "name": "Stegosaurus Heels",
        "responsible": true
      }
    ],
    "coordinators": [
      {
        "id": 122635,
        "name": "Teddy Pizzazz",
        "responsible": true
      },
      {
        "id": 177046,
        "name": "Mirandella Lager",
        "responsible": false
      }
    ],
    "sourcers": [
      {
        "id": 122635,
        "name": "Teddy Pizzazz"
      }
    ]
  },
  "openings": [
    {
      "id": 123,
      "opening_id": "3-1",
      "status": "open",
      "opened_at": "2015-11-20T23:14:14.736Z",
      "closed_at": "2017-11-20T23:14:14.736Z",
      "application_id": 45678,
      "close_reason": {
        "id": 678,
        "name": "Hired - Backfill"
      }
    },
    {
      "id": 124,
      "opening_id": "3-2",
      "status": "open",
      "opened_at": "2015-11-20T23:14:14.739Z",
      "closed_at": null,
      "application_id": null,
      "close_reason": null
    },
    {
      "id": 125,
      "opening_id": null,
      "status": "open",
      "opened_at": "2016-02-03T20:00:00.000Z",
      "closed_at": null,
      "application_id": null
    },
    {
      "id": 126,
      "opening_id": "2-4",
      "status": "closed",
      "opened_at": "2016-02-03T16:38:46.985Z",
      "closed_at": "2016-02-03T16:39:09.811Z",
      "application_id": 1232
    }
  ]
}

Noteworthy attributes

AttributeDescription
idThe job’s unique identifier
requisition_idAn arbitrary ID provided by an external source; does not map to another entity within Greenhouse.
statusOne of open, closed, draft.
confidentialOne of true, false. If the job is confidential or not.
departmentsAn array containing the department which this job belongs to.
officesAn array containing the offices this job is associated with.
hiring_teamLists 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.
custom_fieldsContains any custom job fields which have been defined by your organization.
keyed_custom_fieldsThis 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.
openingsLists the openings associated with this job.
openings[].opening_idCustom identifier set by an organization. Can be null.
openings[].statusOne of: ["open", "closed"]
openings[].opened_atTimestamp when the opening was created.
openings[].closed_atTimestamp when the opening was closed. An opening is closed when it is filled or removed.
openings[].application_idIf the opening is closed and a candidate was hired to fill the opening, this is the ID of the candidate’s application. Otherwise, null.
openings[].close_reasonIf the opening is closed, it may or may not have a reason for the closure. This contains the id and name of the close reason.

GET: List Jobs

curl 'https://harvest.greenhouse.io/v1/jobs'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 144371,
    "name": "Good Cop",
    "requisition_id": "1",
    "notes": null,
    "confidential": true,
    "status": "open",
    "created_at": "2015-11-19T19:53:32.662Z",
    "opened_at": "2015-11-19T19:53:32.662Z",
    "closed_at": null,
    "departments": [
      {
        "id": 13585,
        "name": "Rule Enforcement"
      }
    ],
    "offices": [
      {
        "id": 8787,
        "name": "New York City",
        "location": {
          "name": "New York, NY, United States"
        }
      }
    ],
    "hiring_team": {
      "hiring_managers": [
        {
          "id": 158108,
          "name": "Sam McsSamson"
        }
      ],
      "recruiters": [
        {
          "id": 158101,
          "name": "Major Tom",
          "responsible": true
        }
      ],
      "coordinators": [
        {
          "id": 158109,
          "name": "Roger Cord",
          "responsible": true
        }
      ],
      "sourcers": [
        {
          "id": 158102,
          "name": "Lara Sourcerer"
        }
      ]
    },
    "custom_fields": {
      "bonus": 1000,
      "employment_type": "Full-time",
      "options": "2000",
      "salary": "54111"
    },
    "keyed_custom_fields": {
      "bonus": {
        "name": "Bonus",
        "type": "number",
        "value": 1000
      },
      "time_type": {
        "name": "Employment Type",
        "type": "single_select",
        "value": "Full-time"
      },
      "stock_options": {
        "name": "Options",
        "type": "short_text",
        "value": "2000"
      },
      "salary": {
        "name": "Salary",
        "type": "short_text",
        "value": "54111"
      }
    },
    "openings": [
      {
        "id": 123,
        "opening_id": "1-1",
        "status": "closed",
        "opened_at": "2015-11-19T19:53:32.564Z",
        "closed_at": "2016-01-26T23:59:07.592Z",
        "application_id": 24709881,
        "close_reason": {
          "id": 678,
          "name": "Hire - Backfill"
        }
      },
      {
        "id": 124,
        "opening_id": "1-2",
        "status": "open",
        "opened_at": "2015-11-19T19:53:32.565Z",
        "closed_at": null,
        "application_id": null,
        "close_reason": null
      }
    ]
  }
]

List all of an organization’s jobs.

HTTP Request

GET https://harvest.greenhouse.io/v1/jobs

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only jobs that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only jobs that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only jobs that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only jobs that were updated after this timestamp. Timestamp must be in in ISO-8601 format.


See noteworthy response attributes.

GET: Retrieve Job

curl 'https://harvest.greenhouse.io/v1/jobs/{id}'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
  "id": 144371,
  "name": "Good Cop",
  "requisition_id": "1",
  "notes": null,
  "confidential": false,
  "status": "open",
  "created_at": "2015-11-19T19:53:32.662Z",
  "opened_at": "2015-11-19T19:53:32.662Z",
  "closed_at": null,
  "departments": [
    {
      "id": 13585,
      "name": "Rule Enforcement"
    }
  ],
  "offices": [
    {
      "id": 8787,
      "name": "New York City",
      "location": {
        "name": "New York, NY, United States"
      }
    }
  ],
  "hiring_team": {
    "hiring_managers": [
      {
        "id": 158108,
        "name": "Sam McsSamson"
      }
    ],
    "recruiters": [
      {
        "id": 158101,
        "name": "Major Tom",
        "responsible": true
      }
    ],
    "coordinators": [
      {
        "id": 158109,
        "name": "Roger Cord",
        "responsible": true
      }
    ],
    "sourcers": [
      {
        "id": 158102,
        "name": "Lara Sourcerer"
      }
    ]
  },
  "custom_fields": {
    "bonus": "1000",
    "employment_type": "Full-time",
    "options": "2000",
    "salary": "54111"
  },
  "keyed_custom_fields": {
    "bonus": {
      "name": "Bonus",
      "type": "number",
      "value": 1000
    },
    "time_type": {
      "name": "Employment Type",
      "type": "single_select",
      "value": "Full-time"
    },
    "stock_options": {
      "name": "Options",
      "type": "short_text",
      "value": "2000"
    },
    "salary": {
      "name": "Salary",
      "type": "short_text",
      "value": "54111"
    }
  },
  "openings": [
    {
      "id": 123,
      "opening_id": "1-1",
      "status": "closed",
      "opened_at": "2015-11-19T19:53:32.564Z",
      "closed_at": "2016-01-26T23:59:07.592Z",
      "application_id": 24709881,
      "close_reason": {
        "id": 678,
        "name": "Hire - Backfill"
       }
    },
    {
      "id": 124,
      "opening_id": "1-2",
      "status": "open",
      "opened_at": "2015-11-19T19:53:32.565Z",
      "closed_at": null,
      "application_id": null,
      "close_reason": null
    }
  ]
}

HTTP Request

GET https://harvest.greenhouse.io/v1/jobs/{id}

URL Parameters

ParameterDescription
idThe ID of the job to retrieve


See noteworthy response attributes.

PATCH: Update Job

curl -X PATCH 'https://harvest.greenhouse.io/v1/jobs/{id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
   "id": 144371,
   "name": "New job name",
   "requisition_id": "1",
   "notes": "Here are some notes",
   "team_and_responsibilities": "Info",
   "how_to_sell_this_job": "the snacks",
   "office_ids": [1556],
   "department_id": 74,
   "custom_fields": [
    {
        "id": 1234,
        "value": "Some new value"
    },
    {
        "name_key": "salary_range",
        "min_value": 100000,
        "max_value": 150000,
        "unit": "USD"
   },
   {
        "id": 5678,
        "delete_value": "true"
   }
  ]
}

HTTP Request

PATCH https://harvest.greenhouse.io/v1/jobs/{id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

URL Parameters

ParameterDescription
idThe ID of the job to retrieve

JSON Body Parameters

ParameterRequiredTypeDescription
nameNostringThe job’s name
notesNostringNotes on the hiring plan
anywhereNobooleanBoolean value indicating where the job can be done anywhere
requisition_id*NostringThe id of the requisition corresponding to this job posting, if applicable
team_and_responsibilitiesNostringA description of the team the candidate would join and their responsibilities
how_to_sell_this_jobNostringA description for the recruiter of the desirable aspects of the job
custom_fieldsNocustom_fieldArray of hashes containing new custom field values. Passing an empty array does nothing.
office_idsNoArrayReplace the current offices for this job with new offices. If your organization requires at least one office, trying to set this to blank will return an error.
department_id*NonumberReplace the current department for this job with a different department.

Custom Field Parameters

The custom field parameter structure is different in the PATCH method then in GET methods and responses. Certain type of custom fields require different elements to be included, while deleting a field requires a specific argument. What follows is the description of each item in a custom field element and what is required depending on the type.

ParameterRequired forDescription
idallThe custom field id for this particular custom field. One of this or name_key is required.
name_keyallThe field key for this custom field. This can be found in Greenhouse while editing custom options as “Immutable Field Key” This or id is required for all custom field elements.
valueallThe value field contains the new custom field value. In most cases this will be a string or a number. In the case of single-select or multi-select custom fields, this will be a custom field option id or an array of custom field option ids, respectively. Value is only not used for range type custom fields.
min_valuenumber_range, currency rangeThis contains the minimum value that is allowable for this custom field. Must be less than max_value
max_valuenumber_range, currency_rangeThis contains the maximum value that is allowable for this custom field. Must be greater than min_value
unitcurrency, currency_rangeThis contains the currency unit for a currency custom field. It is only required when updating a currency custom field. This should accept any 3-character currency code from the ISO-4217 standard.
delete_valuen/aWhen this element is included with a value of “true” (note, string true, not boolean true) the custom field value will be removed from Greenhouse. Note that updating a custom field value to nil or a blank string will not work, as validations require these to be non-blank values.

The above returns a JSON response, structured like this:

{
  "id": 112746,
  "name": "new name",
  "requisition_id": 2,
  "notes": "Looking for the best!",
  "confidential": false,
  "status": "open",
  "created_at": "2015-09-10T19:01:46.078Z",
  "opened_at": "2015-09-10T19:01:46.078Z",
  "closed_at": null,
  "departments": [
    {
      "id": 74,
      "name": "Guideshops",
      "parent_id": null,
      "child_ids": []
    }
  ],
  "offices": [
    {
      "id": 1556,
      "name": "San Diego",
      "location": {
        "name": "San Diego, CA, United States"
      },
      "parent_id": null,
      "child_ids": []
    }
  ],
  "hiring_team": {
    "hiring_managers": [],
    "recruiters": [],
    "coordinators": [],
    "sourcers": []
  },
  "custom_fields": {
    "employment_type": "Full-time",
    "salary": "$123,000",
    "bonus": 1000,
    "options": "1500"
  },
  "keyed_custom_fields": {
    "bonus": {
      "name": "Bonus",
      "type": "number",
      "value": 1000
    },
    "time_type": {
      "name": "Employment Type",
      "type": "single_select",
      "value": "Full-time"
    },
    "stock_options": {
      "name": "Options",
      "type": "short_text",
      "value": "1500"
    },
    "salary": {
      "name": "Salary",
      "type": "short_text",
      "value": "$123,000"
    }
  },
  "openings": [
    {
      "id": 123,
      "opening_id": null,
      "status": "closed",
      "opened_at": "2015-09-10T19:01:46.077Z",
      "closed_at": "2015-09-21T21:28:17.628Z",
      "application_id": 18682391,
      "close_reason": {
        "id": 678,
        "name": "Hire - Backfill"
      }
    },
    {
      "id": 124,
      "opening_id": null,
      "status": "closed",
      "opened_at": "2015-09-21T21:28:17.679Z",
      "closed_at": "2016-03-09T20:07:35.649Z",
      "application_id": 18492607,
      "close_reason": {
        "id": 679,
        "name": "Hired"
      }
    },
    {
      "id": 125,
      "opening_id": null,
      "status": "open",
      "opened_at": "2016-03-09T20:07:35.675Z",
      "closed_at": null,
      "application_id": null,
      "close_reason": null
    }
  ]
}


See noteworthy response attributes.

POST: Create Job

curl -X POST 'https://harvest.greenhouse.io/v1/jobs'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
   "template_job_id": 12345,
   "number_of_openings": 2,
   "job_post_name": "External Name That Appears On Job Boards",
   "job_name": "Internal Name That Appears On Hiring Plans",
   "department_id": 123,
   "office_ids": [
      234, 
      345
    ],
   "requisition_id": "abc-123",
   "opening_ids": [
      "abc-123-1", 
      "abc-123-2"
    ]
}

HTTP Request

POST https://harvest.greenhouse.io/v1/jobs

JSON Body Parameters

ParameterRequiredTypeDescription
template_job_idYesNumberThis is the job we will use to generate the new job. The new job will receive most of the settings of the template job. The On-Behalf-Of user must have access to this job.
number_of_openingsYesNumberThe number of openings that will be created for this job.
job_post_nameNoStringThis will be the name on the new job post. If this is not included, the job post names in the base job will be copied.
job_nameNoStringThis is the internal name of the new job. If this is not included, the name of the new job will be “Copy Of (the template job’s name)”
department_idNoNumberThe department of the new job. This should be a department id from the Departments endpoint. If this element is omitted, the new job will receive the department of the template job. If this element is included but blank, it will create the job with no departments. If the organization requires jobs to have a department, this case will return a 422 response.
office_idsNoArray[Numbers]The offices of the new job. These should be office ids from the Offices endpoint. If this element is omitted, the new job will receive the offices of the template job. If this element is included but blank, it will create the job with no offices. If the organization requires jobs to have an office, this case will return a 422 response.
requisition_idNoStringA requisition id for this job.
opening_idsNoArray[Strings]An array of opening ids for the new job. If this is included, the number of opening ids in this array must match the number_of_openings element.

The above returns a JSON response, structured like this:

{
  "id": 112746,
  "name": "Internal Name That Appears On Hiring Plans",
  "requisition_id": "abc-123",
  "notes": "Looking for the best!",
  "confidential": false,
  "status": "open",
  "created_at": "2015-09-10T19:01:46.078Z",
  "opened_at": "2015-09-10T19:01:46.078Z",
  "closed_at": null,
  "departments": [
    {
      "id": 123,
      "name": "Guideshops",
      "parent_id": null,
      "child_ids": []
    }
  ],
  "offices": [
    {
      "id": 234,
      "name": "San Diego",
      "location": {
        "name": "San Diego, CA, United States"
      },
      "parent_id": null,
      "child_ids": []
    },
    {
      "id": 345,
      "name": "New York",
      "location": {
        "name": "New York, NY, United States"
      },
      "parent_id": null,
      "child_ids": []
    }
  ],
   "hiring_team": {
    "hiring_managers": [
      {
        "id": 158108,
        "name": "Sam McsSamson"
      }
    ],
    "recruiters": [
      {
        "id": 158101,
        "name": "Major Tom",
        "responsible": true
      }
    ],
    "coordinators": [
      {
        "id": 158109,
        "name": "Roger Cord",
        "responsible": true
      }
    ],
    "sourcers": [
      {
        "id": 158102,
        "name": "Lara Sourcerer"
      }
    ]
  },
  "custom_fields": {
    "employment_type": "Full-time",
    "salary": "$123,000",
    "bonus": 1000,
    "options": "1500"
  },
  "keyed_custom_fields": {
    "bonus": {
      "name": "Bonus",
      "type": "number",
      "value": 1000
    },
    "time_type": {
      "name": "Employment Type",
      "type": "single_select",
      "value": "Full-time"
    },
    "stock_options": {
      "name": "Options",
      "type": "short_text",
      "value": "1500"
    },
    "salary": {
      "name": "Salary",
      "type": "short_text",
      "value": "$123,000"
    }
  },
  "openings": [
    {
      "id": 123,
      "opening_id": "abc-123-1",
      "status": "open",
      "opened_at": "2015-09-10T19:01:46.077Z",
      "closed_at": null,
      "application_id": null,
      "close_reason": null
    },
    {
      "id": 124,
      "opening_id": "abc-123-2",
      "status": "open",
      "opened_at": "2015-09-10T19:01:46.077Z",
      "closed_at": null,
      "application_id": null,
      "close_reason": null
    }
  ]
}

PUT: Replace Hiring Team

curl -X PUT 'https://harvest.greenhouse.io/v1/jobs/{id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
  "hiring_managers": [
    {
      "user_id": 1234
    },
    {
      "user_id": 2345
    }
  ],
  "sourcers": [
    {
      "user_id": 3456
    },
    {
      "user_id": 4567
    }
  ],
  "recruiters": [
    {
      "user_id": 5678,
      "responsible_for_future_candidates": true,
      "responsible_for_active_candidates": true,
      "responsible_for_inactive_candidates": true
    },
    {
      "user_id": 6789,
      "responsible_for_future_candidates": false,
      "responsible_for_active_candidates": false,
      "responsible_for_inactive_candidates": false
    }
  ],
  "coordinators": [
    {
      "user_id": 7890,
      "responsible_for_future_candidates": true,
      "responsible_for_active_candidates": false,
      "responsible_for_inactive_candidates": false
    },
    {
      "user_id": 8901,
      "responsible_for_future_candidates": false,
      "responsible_for_active_candidates": false,
      "responsible_for_inactive_candidates": false
    }
  ]
}

HTTP Request

PUT https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team

JSON Body Parameters

There are four types of hiring team members, represented by the four hashes sent in the JSON body. If any of these types are not included, hiring team members of that type will not be changed. If a blank element {} is included, that part of the hiring team will be cleared.

Note that this PUT method REPLACES the existing members of the hiring team. For each element included in the JSON request body, the existing hiring team members in Greenhouse will be removed and replaced with the current members. Also, this process is transactional: if there is one failure, no elements will be updated. Finally, if you have a Hiring Team Updated web hook configured, you will receive one web hook notification per element, so you may receive up to four web hook notifications when this endpoint is used.

ParameterRequiredTypeDescription
responsible_for_future_candidatesYes for coordinator or recruiterbooleanThe user becomes the responsible person for all new candidates. Only one user in the group of users may be designated as responsible.
responsible_for_active_candidatesYes for coordinator or recruiterbooleanThe user becomes the responsible person for all existing candidates with active applications
responsible_for_inactive_candidatesYes for coordinator or recruiterbooleanThe user becomes the responsible person for all hired and rejected candidates

On success, this will return a 200 response code with a success message in the JSON body.

Offers

The offer object

An organization’s offers.

{
  "id": 4949,
  "version": 1,
  "application_id": 1234,
  "created_at": "2014-02-13T22:30:58Z",
  "updated_at": "2014-07-31T20:49:05.604Z",
  "sent_at": null,
  "resolved_at": null,
  "starts_at": null,
  "status": "deprecated",
  "custom_fields": {
    "employment_type": "Contractor",
    "favorite_station": "The Swan",
    "best_seasons": null,
    "start_date": "2004-09-21",
    "willing_to_negotiate": null,
    "salary": "Around $100k",
    "notes": "This is a note field"
  },
  "keyed_custom_fields": {
    "time_type": {
      "name": "Employment Type",
      "type": "single_select",
      "value": "Contractor"
    },
    "favorite_station": {
      "name": "Favorite Station",
      "type": "single_select",
      "value": "The Swan"
    },
    "best_seasons": {
      "name": "Best seasons",
      "type": "multi_select",
      "value": null
    },
    "start_date": {
      "name": "Start Date",
      "type": "date",
      "value": "2004-09-21"
    },
    "will_negotiate": {
      "name": "Willing to negotiate",
      "type": "yes_no",
      "value": null
    },
    "salary": {
      "name": "Salary",
      "type": "short_text",
      "value": "Around $100k"
    },
    "notes": {
      "name": "Notes",
      "type": "long_text",
      "value": "This is a note field"
    }
  }
}

Noteworthy attributes

AttributeDescription
idThe offer’s unique identifier
versionThe version number of this offer. When an existing offer is updated, a new one is typically created with an incremented version.
application_idThe ID of the associated application.
created_atDate whe this offer was created.
resolved_atDate when this offer was resolved (e.g. when it was accepted, rejected).
sent_atDate when this offer was sent to the candidate.
starts_atDate 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.
statusOne of: unresolved, accepted, rejected, deprecated.
custom_fieldsContains 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.
keyed_custom_fieldsThis 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.

GET: List Offers

All offers made by an organization ordered by application_id.

curl 'https://harvest.greenhouse.io/v1/offers' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 4949,
    "version": 1,
    "application_id": 1234,
    "created_at": "2014-02-13T22:30:58Z",
    "updated_at": "2014-07-31T20:49:05.604Z",
    "sent_at": null,
    "resolved_at": null,
    "starts_at": null,
    "status": "deprecated",
    "custom_fields": {
      "employment_type": "Contractor",
      "favorite_station": "The Swan",
      "best_seasons": null,
      "start_date": "2004-09-21",
      "willing_to_negotiate": null,
      "salary": "$123,000",
      "notes": "This is a note field"
    },
    "keyed_custom_fields": {
      "time_type": {
        "name": "Employment Type",
        "type": "single_select",
        "value": "Contractor"
      },
      "favorite_station": {
        "name": "Favorite Station",
        "type": "single_select",
        "value": "The Swan"
      },
      "best_seasons": {
        "name": "Best seasons",
        "type": "multi_select",
        "value": null
      },
      "start_date": {
        "name": "Start Date",
        "type": "date",
        "value": "2004-09-21"
      },
      "will_negotiate": {
        "name": "Willing to negotiate",
        "type": "yes_no",
        "value": null
      },
      "salary": {
        "name": "Salary",
        "type": "currency",
        "value": "$123,000"
      },
      "notes": {
        "name": "Notes",
        "type": "long_text",
        "value": "This is a note field"
      }
    }
  },
  {
    "id": 5318,
    "version": 1,
    "application_id": 1234,
    "created_at": "2014-02-13T22:30:58Z",
    "updated_at": "2014-07-31T20:49:05.604Z",
    "sent_at": null,
    "resolved_at": null,
    "starts_at": null,
    "status": "deprecated",
    "custom_fields": {
      "employment_type": "Part-Time",
      "favorite_station": "The Looking Glass",
      "best_seasons": ["Season 1", "Season 2"],
      "start_date": "2014-05-01",
      "willing_to_negotiate": true,
      "salary": {
        "value": 42000,
        "currency": "EUR"
      },
      "notes": "Very excited to start working with this candidate"
    },
    "keyed_custom_fields": {
      "time_type": {
        "name": "Employment Type",
        "type": "single_select",
        "value": "Part-Time"
      },
      "favorite_station": {
        "name": "Favorite Station",
        "type": "single_select",
        "value": "The Looking Glass"
      },
      "best_seasons": {
        "name": "Best seasons",
        "type": "multi_select",
        "value": ["Season 1", "Season 2"]
      },
      "start_date": {
        "name": "Start Date",
        "type": "date",
        "value": "2014-05-01"
      },
      "will_negotiate": {
        "name": "Willing to negotiate",
        "type": "yes_no",
        "value": true
      },
      "salary": {
        "name": "Salary",
        "type": "currency",
        "value": {
          "value": 42000,
          "currency": "EUR"
        }
      },
      "notes": {
        "name": "Notes",
        "type": "long_text",
        "value": "Very excited to start working with this candidate"
      }
    }
  }
]

HTTP Request

GET https://harvest.greenhouse.io/v1/offers

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only offers that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only offers that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only offers that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only offers that were updated after this timestamp. Timestamp must be in in ISO-8601 format.


See noteworthy response attributes.

GET: List Offers for Application

curl 'https://harvest.greenhouse.io/v1/applications/{application_id}/offers'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 4949,
    "version": 1,
    "application_id": 1234,
    "created_at": "2014-02-13T22:30:58Z",
    "updated_at": "2014-07-31T20:49:05.604Z",
    "sent_at": null,
    "resolved_at": null,
    "starts_at": null,
    "status": "deprecated",
    "custom_fields": {
      "employment_type": "Contractor",
      "favorite_station": "The Swan",
      "best_seasons": null,
      "start_date": null,
      "willing_to_negotiate": null,
      "salary": null,
      "notes": null
    },
    "keyed_custom_fields": {
      "time_type": {
        "name": "Employment Type",
        "type": "single_select",
        "value": "Contractor"
      },
      "favorite_station": {
        "name": "Favorite Station",
        "type": "single_select",
        "value": "The Swan"
      },
      "best_seasons": {
        "name": "Best seasons",
        "type": "multi_select",
        "value": null
      },
      "start_date": {
        "name": "Start Date",
        "type": "date",
        "value": null
      },
      "will_negotiate": {
        "name": "Willing to negotiate",
        "type": "yes_no",
        "value": null
      },
      "salary": {
        "name": "Salary",
        "type": "currency",
        "value": null
      },
      "notes": {
        "name": "Notes",
        "type": "long_text",
        "value": null
      }
    }
  },
  {
    "id": 5318,
    "version": 2,
    "application_id": 1234,
    "created_at": "2014-02-13T22:30:58Z",
    "updated_at": "2014-07-31T20:49:05.604Z",
    "sent_at": null,
    "resolved_at": null,
    "starts_at": null,
    "status": "deprecated",
    "custom_fields": {
      "employment_type": "Part-Time",
      "favorite_station": "The Looking Glass",
      "best_seasons": ["Season 1", "Season 2"],
      "start_date": "2014-05-01",
      "willing_to_negotiate": true,
      "salary": {
        "value": 42000,
        "currency": "EUR"
      },
      "notes": "Very excited to start working with this candidate"
    },
    "keyed_custom_fields": {
      "time_type": {
        "name": "Employment Type",
        "type": "single_select",
        "value": "Part-Time"
      },
      "favorite_station": {
        "name": "Favorite Station",
        "type": "single_select",
        "value": "The Looking Glass"
      },
      "best_seasons": {
        "name": "Best seasons",
        "type": "multi_select",
        "value": ["Season 1", "Season 2"]
      },
      "start_date": {
        "name": "Start Date",
        "type": "date",
        "value": "2014-05-01"
      },
      "will_negotiate": {
        "name": "Willing to negotiate",
        "type": "yes_no",
        "value": true
      },
      "salary": {
        "name": "Salary",
        "type": "currency",
        "value": {
          "value": 42000,
          "currency": "EUR"
        }
      },
      "notes": {
        "name": "Notes",
        "type": "long_text",
        "value": "Very excited to start working with this candidate"
      }
    }
  }
]

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

HTTP Request

GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers

URL Parameters

ParameterDescription
application_idID of the application whose offers you want to retrieve

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.


See noteworthy response attributes.

GET: Retrieve Current Offer for Application

curl 'https://harvest.greenhouse.io/v1/applications/{application_id}/offers/current_offer' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
  "id": 4949,
  "version": 1,
  "application_id": 1234,
  "created_at": "2014-02-13T22:30:58Z",
  "updated_at": "2014-07-31T20:49:05.604Z",
  "sent_at": null,
  "resolved_at": null,
  "starts_at": null,
  "status": "deprecated",
  "custom_fields": {
    "employment_type": "Contractor",
    "favorite_station": "The Swan",
    "best_seasons": null,
    "start_date": null,
    "willing_to_negotiate": null,
    "salary": "$123,000",
    "notes": "This is a note field"
  },
  "keyed_custom_fields": {
    "time_type": {
      "name": "Employment Type",
      "type": "single_select",
      "value": "Contractor"
    },
    "favorite_station": {
      "name": "Favorite Station",
      "type": "single_select",
      "value": "The Swan"
    },
    "best_seasons": {
      "name": "Best seasons",
      "type": "multi_select",
      "value": null
    },
    "start_date": {
      "name": "Start Date",
      "type": "date",
      "value": null
    },
    "will_negotiate": {
      "name": "Willing to negotiate",
      "type": "yes_no",
      "value": null
    },
    "salary": {
      "name": "Salary",
      "type": "currency",
      "value": "$123,000"
    },
    "notes": {
      "name": "Notes",
      "type": "long_text",
      "value": "This is a note field"
    }
  }
}

Fetch the current offer for an application.

HTTP Request

GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers/current_offer

URL Parameters

ParameterDescription
application_idID of the application whose current offer you want to retrieve


See noteworthy response attributes.

GET: Retrieve Offer

curl 'https://harvest.greenhouse.io/v1/offers/{id}' 
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
  "id": 4949,
  "version": 1,
  "application_id": 1234,
  "created_at": "2014-02-13T22:30:58Z",
  "updated_at": "2014-07-31T20:49:05.604Z",
  "sent_at": null,
  "resolved_at": null,
  "starts_at": null,
  "status": "deprecated",
  "custom_fields": {
    "employment_type": "Contractor",
    "favorite_station": "The Swan",
    "best_seasons": null,
    "start_date": null,
    "willing_to_negotiate": null,
    "salary": null,
    "notes": null
  },
  "keyed_custom_fields": {
    "time_type": {
      "name": "Employment Type",
      "type": "single_select",
      "value": "Contractor"
    },
    "favorite_station": {
      "name": "Favorite Station",
      "type": "single_select",
      "value": "The Swan"
    },
    "best_seasons": {
      "name": "Best seasons",
      "type": "multi_select",
      "value": null
    },
    "start_date": {
      "name": "Start Date",
      "type": "date",
      "value": null
    },
    "will_negotiate": {
      "name": "Willing to negotiate",
      "type": "yes_no",
      "value": null
    },
    "salary": {
      "name": "Salary",
      "type": "currency",
      "value": null
    },
    "notes": {
      "name": "Notes",
      "type": "long_text",
      "value": null
    }
  }
}

Retrieve an offer by its ID.

HTTP Request

GET https://harvest.greenhouse.io/v1/offers/{id}

URL Parameters

ParameterDescription
idID of the offer to retrieve


See noteworthy response attributes.

Offices

The office object

An organization’s offices.

With render_as=list (default)

{
  "id": 175,
  "name": "San Francisco",
  "parent_id": 180,
  "child_ids": [190, 195],
  "location": {
    "name": "San Francisco, CA"
  }
}

With render_as=tree

{
  "id": 175,
  "name": "San Francisco",
  "children": [
    {
      "id": 190,
      "name": "West",
      "children": [],
      "location": {
        "name": "San Francisco, CA"
      }
    },
    {
      "id": 195,
      "name": "East",
      "children": [],
      "location": {
        "name": "San Francisco, CA"
      }
    }
  ],
  "location": {
    "name": "San Francisco, CA"
  }
}

Noteworthy attributes

AttributeDescription
idThe office’s unique identifier
nameThe office’s name

GET: List Offices

curl 'https://harvest.greenhouse.io/v1/offices'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

With render_as=list (default)

[
  {
    "id": 175,
    "name": "San Francisco",
    "parent_id": 180,
    "child_ids": [190, 195],
    "location": {
      "name": "San Francisco, CA"
    }
  },
  {
    "id": 344,
    "name": "Bangkok",
    "parent_id": null,
    "child_ids": [],
    "location": {
      "name": "Bangkok Thailand"
    }
  },
  {
    "id": 145,
    "name": "Remote Locations",
    "parent_id": null,
    "child_ids": [],
    "location": {
      "name": null
    }
  }
]

With render_as=tree

[
  {
    "id": 175,
    "name": "San Francisco",
    "children": [
      {
        "id": 190,
        "name": "West",
        "children": [],
        "location": {
          "name": "San Francisco, CA"
        }
      },
      {
        "id": 195,
        "name": "East",
        "children": [],
        "location": {
          "name": "San Francisco, CA"
        }
      }
    ],
    "location": {
      "name": "San Francisco, CA"
    }
  },
  {
    "id": 344,
    "name": "Bangkok",
    "children": [],
    "location": {
      "name": "Bangkok Thailand"
    }
  },
  {
    "id": 145,
    "name": "Remote Locations",
    "children": [],
    "location": {
      "name": null
    }
  }
]

List all of an organization’s offices.

HTTP Request

GET https://harvest.greenhouse.io/v1/offices

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
render_asThis parameter defines how to represent the list of offices. The default value is ‘list’, which returns a flat list of offices. If this is set to 'tree’, offices are represented in a tree-like structure where they may include sub-offices as children


See noteworthy response attributes.

GET: Retrieve Office

curl 'https://harvest.greenhouse.io/v1/offices/{id}'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 175,
  "name": "San Francisco",
  "parent_id": 180,
  "child_ids": [190, 195],
  "location": {
    "name": "San Francisco, CA"
  }
}

With render_as=tree

{
  "id": 175,
  "name": "San Francisco",
  "children": [
    {
      "id": 190,
      "name": "West",
      "children": [],
      "location": {
        "name": "San Francisco, CA"
      }
    },
    {
      "id": 195,
      "name": "East",
      "children": [],
      "location": {
        "name": "San Francisco, CA"
      }
    }
  ],
  "location": {
    "name": "San Francisco, CA"
  }
}

Retrieve an office by its ID.

HTTP Request

GET https://harvest.greenhouse.io/v1/offices/{id}

URL Parameters

ParameterDescription
idThe ID of the office to retrieve

Querystring parameters

ParameterDescription
render_asThis parameter defines how to represent the list of offices. The default value is 'list’, which returns a flat list of offices. If this is set to 'tree’, offices are represented in a tree-like structure where they may include sub-offices as children


See noteworthy response attributes.

POST: Add Office

curl -X POST 'https://harvest.greenhouse.io/v1/offices
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "name": "A New Office",
  "parent_id": 12345,
  "primary_contact_user_id": 234,
  "location": "New York, NY"
}

The above command returns a JSON response, structured like this:

{
  "id": 3,
  "name": "A New Office",
  "location": {
    "name": "New York, NY"
  },
  "primary_contact_user_id": 234,
  "parent_id": 12345,
  "child_ids": []
}

Create a new office

HTTP Request

POST https://harvest.greenhouse.io/v1/offices

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes. Must be a user who can create offices.

JSON Body Parameters

ParameterRequiredTypeDescription
nameyesstringThe name of your new office. Must be less than 255 characters and unique within your organization.
locationnostringThis is a text representation of the office’s location. This is free-form text. It is not geo-located.
primary_contact_user_idnonumberThe id of the user who will be the primary in-house contact for this office. This user must be a site-admin.
parent_id*nonumberThe office id for the new office to be nested under. If this isn’t included, the office will be created at the top level.

* - The tiered office feature is available only for customers with Standard or Premium Greenhouse Recruiting. Use of this field will return an error for Basic Greenhouse Recruiting customers.

Rejection Reasons

The rejection reason object

Represents rejection reasons configured by an organization under the Custom Options section of Greenhouse.

{
  "id": 262,
  "name": "Missing resume",
  "type": {
    "id": 1,
    "name": "We rejected them"
  }
}

Noteworthy attributes

AttributeDescription
idThe rejection reason’s unique identifier
nameThe rejection reason’s name
typeOne of {"id": 1, "name": "We rejected them"}, {"id": 2, "name": "They rejected us"}, {"id": 3, "name": "None specified"}

GET: List Rejection Reasons

curl 'https://harvest.greenhouse.io/v1/rejection_reasons'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 262,
    "name": "Missing resume",
    "type": {
      "id": 1,
      "name": "We rejected them"
    }
  },
  {
    "id": 280,
    "name": "Not in NYC",
    "type": {
      "id": 1,
      "name": "We rejected them"
    }
  },
  {
    "id": 230,
    "name": "Hiring Freeze",
    "type": {
      "id": 2,
      "name": "None specified"
    }
  }
]

List all of an organization’s rejection reasons.

HTTP Request

GET https://harvest.greenhouse.io/v1/rejection_reasons

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.


See noteworthy response attributes.

Scheduled Interviews

The scheduled interview object

Interviews that have been scheduled for the specified application.

{
  "id": 9128481,
  "application_id": 4684156,
  "start": {
    "date_time": "2014-03-26T22:15:00.000Z"
  },
  "end": {
    "date_time": "2014-03-26T22:30:00.000Z"
  },
  "location": "Big Conference Room",
  "status": "awaiting_feedback",
  "interview": {
    "id": 7001,
    "name": "Culture Fit"
  },
  "organizer": {
    "id": 2000,
    "name": "Jack Shepard"
  },
  "interviewers": [
    {
      "id": 4080,
      "name": "Kate Austen",
      "email": "kate.austen@example.com",
      "scorecard_id": 11274
    }
  ]
}

Noteworthy attributes

AttributeDescription
idThe scheduled interview’s unique identifier
startA date_time value if this interview has a precise start time, or a date value if this is an all-day event.
endA date_time value if this interview has a precise start time, or a date value if this is an all-day event.
locationThe location of the interview.
statusOne of: to_be_scheduled, scheduled, awaiting_feedback, complete, skipped, collect_feedback, to_be_sent, sent, received.
organizerThe user who is the organizer for this interview
interviewersAn array containing the users who have interviews with this candidate, including, if applicable, the ID of the scorecard they completed.

GET: List Interviews

curl 'https://harvest.greenhouse.io/v1/scheduled_interviews'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

[
  {
    "id": 9128481,
    "application_id": 432904,
    "start": {
      "date_time": "2014-03-26T22:15:00.000Z"
    },
    "end": {
      "date_time": "2014-03-26T22:30:00.000Z"
    },
    "location": "Big Conference Room",
    "status": "awaiting_feedback",
    "interview": {
      "id": 7001,
      "name": "Culture Fit"
    },
    "organizer": {
      "id": 2000,
      "name": "Jack Shepard"
    },
    "interviewers": [
      {
        "id": 4080,
        "name": "Kate Austen",
        "email": "kate.austen@example.com",
        "scorecard_id": 11274
      }
    ]
  },
  {
    "id": 9128482,
    "application_id": 432905,
    "start": {
      "date": "2014-07-08"
    },
    "end": {
      "date": "2014-07-09"
    },
    "location": "Small Conference Room",
    "interview": {
      "id": 7002,
      "name": "Whiteboarding Challenge"
    },
    "organizer": {
      "id": 2000,
      "name": "Jack Shepard"
    },
    "status": "complete",
    "interviewers": [
      {
        "id": 3412,
        "name": "Charlie Pace",
        "email": "youalleverybody@example.com",
        "scorecard_id": null
      }
    ]
  }
]

List all of an organization’s scheduled interviews.

HTTP Request

GET https://harvest.greenhouse.io/v1/scheduled_interviews

Optional querystring Parameters

Timestamps must be in in ISO-8601 format.

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeOnly return scheduled interviews that were created before this timestamp.
created_afterOnly return scheduled interviews that were created after this timestamp.
updated_beforeOnly return scheduled interviews that were updated before this timestamp.
updated_afterOnly return scheduled interviews that were updated after this timestamp.
starts_beforeOnly return scheduled interviews scheduled to start before this timestamp.
starts_afterOnly return scheduled interviews scheduled to start after this timestamp.
ends_beforeOnly return scheduled interviews scheduled to end before this timestamp.
ends_afterOnly return scheduled interviews scheduled to end after this timestamp.

GET: List Interviews for Application

curl 'https://harvest.greenhouse.io/v1/applications/{id}/scheduled_interviews'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 9128481,
    "application_id": 432904,
    "start": {
      "date_time": "2014-03-26T22:15:00.000Z"
    },
    "end": {
      "date_time": "2014-03-26T22:30:00.000Z"
    },
    "location": "Big Conference Room",
    "status": "awaiting_feedback",
    "interview": {
      "id": 7001,
      "name": "Culture Fit"
    },
    "organizer": {
      "id": 2000,
      "name": "Jack Shepard"
    },
    "interviewers": [
      {
        "id": 4080,
        "name": "Kate Austen",
        "email": "kate.austen@example.com",
        "scorecard_id": 11274
      }
    ]
  },
  {
    "id": 9128482,
    "application_id": 432904,
    "start": {
      "date": "2014-07-08"
    },
    "end": {
      "date": "2014-07-09"
    },
    "location": "Small Conference Room",
    "interview": {
      "id": 7002,
      "name": "Whiteboarding Challenge"
    },
    "organizer": {
      "id": 2000,
      "name": "Jack Shepard"
    },
    "status": "complete",
    "interviewers": [
      {
        "id": 3412,
        "name": "Charlie Pace",
        "email": "youalleverybody@example.com",
        "scorecard_id": null
      }
    ]
  }
]

Interviews that have been scheduled for this application.

HTTP Request

GET https://harvest.greenhouse.io/v1/applications/{id}/scheduled_interviews

Querystring Parameters

ParameterDescription
idID of the application to retrieve
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only scheduled interviews that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only scheduled interviews that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only scheduled interviews that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only scheduled interviews that were updated after this timestamp. Timestamp must be in in ISO-8601 format.


See noteworthy response attributes.

GET: Retrieve Interview

curl 'https://harvest.greenhouse.io/v1/scheduled_interviews/123'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
  "id": 9128481,
  "application_id": 4684156,
  "start": {
    "date_time": "2014-03-26T22:15:00.000Z"
  },
  "end": {
    "date_time": "2014-03-26T22:30:00.000Z"
  },
  "location": "Big Conference Room",
  "status": "awaiting_feedback",
  "interview": {
    "id": 7001,
    "name": "Culture Fit"
  },
  "organizer": {
    "id": 2000,
    "name": "Jack Shepard"
  },
  "interviewers": [
    {
      "id": 4080,
      "name": "Kate Austen",
      "email": "kate.austen@example.com",
      "scorecard_id": 11274
    }
  ]
}

Retrieve an interview by its ID.

HTTP Request

GET https://harvest.greenhouse.io/v1/scheduled_interviews/{id}

URL Parameters

ParameterDescription
idThe ID of the scheduled interview to retrieve

Scorecards

All submitted scorecards ordered by candidate.

The scorecard object

{
  "id": 123,
  "updated_at": "2016-08-22T19:52:38.384Z",
  "created_at": "2016-08-22T19:52:38.384Z",
  "interview": "Application Review",
  "candidate_id": 1234,
  "application_id": 3456,
  "interviewed_at": "2016-08-18T16:00:00.000Z",
  "submitted_by": {
    "id": 4080,
    "name": "Kate Austen",
    "employee_id": null
  },
  "submitted_at": "2014-03-26T21:59:51Z",
  "overall_recommendation": "yes",
  "attributes": [
    {
      "name": "Communication",
      "type": "Skills",
      "note": "What a great communicator!",
      "rating": "yes"
    },
    {
      "name": "Adaptable",
      "type": "Skills",
      "note": null,
      "rating": "yes"
    },
    {
      "name": "Relationship Manager",
      "type": "Skills",
      "note": null,
      "rating": "mixed"
    },
    {
      "name": "Project Management",
      "type": "Skills",
      "note": null,
      "rating": "mixed"
    },
    {
      "name": "Problem Solver",
      "type": "Skills",
      "note": null,
      "rating": "no"
    },
    {
      "name": "Analytical",
      "type": "Skills",
      "note": null,
      "rating": "definitely_not"
    }
  ],
  "ratings": {
    "definitely_not": [
      "Analytical"
    ],
    "no": [
      "Problem Solver"
    ],
    "mixed": [
      "Relationship Manager",
      "Project Management"
    ],
    "yes": [
      "Communication",
      "Adaptable"
    ],
    "strong_yes": []
  },
  "questions": [
    {
      "id": null,
      "question": "Key Take-Aways",
      "answer": "Seems like a decent candidate."
    },
    {
      "id": null,
      "question": "Private Notes",
      "answer": "Seems like a decent candidate."
    }
  ]
}

Noteworthy attributes

AttributeDescription
idThe scorecard’s unique identifier
candidate_idThe ID of the candidate whom this scorecard was written for.
submitted_byThe user who submitted this scorecard.
overall_recommendationOne of: definitely_not, no, yes, strong_yes, mixed, no_decision
attributesArray containing the attributes of the Scorecard. Describes each attribute’s name, type, rating (can be “no_decision”), and an optional note.

GET: List Scorecards

curl 'https://harvest.greenhouse.io/v1/scorecards'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 123,
    "updated_at": "2016-08-22T19:52:38.384Z",
    "created_at": "2016-08-22T19:52:38.384Z",
    "interview": "Application Review",
    "candidate_id": 1234,
    "application_id": 3456,
    "interviewed_at": "2016-08-18T16:00:00.000Z",
    "submitted_by": {
      "id": 4080,
      "name": "Kate Austen",
      "employee_id": null
    },
    "submitted_at": "2014-03-26T21:59:51Z",
    "overall_recommendation": "yes",
    "attributes": [
      {
        "name": "Communication",
        "type": "Skills",
        "note": "What a great communicator!",
        "rating": "yes"
      },
      {
        "name": "Adaptable",
        "type": "Skills",
        "note": null,
        "rating": "yes"
      },
      {
        "name": "Relationship Manager",
        "type": "Skills",
        "note": null,
        "rating": "mixed"
      },
      {
        "name": "Project Management",
        "type": "Skills",
        "note": null,
        "rating": "mixed"
      },
      {
        "name": "Problem Solver",
        "type": "Skills",
        "note": null,
        "rating": "no"
      },
      {
        "name": "Analytical",
        "type": "Skills",
        "note": null,
        "rating": "definitely_not"
      }
    ],
    "ratings": {
      "definitely_not": [
        "Analytical"
      ],
      "no": [
        "Problem Solver"
      ],
      "mixed": [
        "Relationship Manager",
        "Project Management"
      ],
      "yes": [
        "Communication",
        "Adaptable"
      ],
      "strong_yes": []
    },
    "questions": [
      {
        "id": null,
        "question": "Key Take-Aways",
        "answer": "Seems like a decent candidate."
      },
      {
        "id": null,
        "question": "Private Notes",
        "answer": "Seems like a decent candidate."
      }
    ]
  },
  { },
]

List all of an organization’s scorecards.

HTTP Request

GET https://harvest.greenhouse.io/v1/scorecards

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
created_beforeReturn only scorecards that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only scorecards that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only scorecards that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only scorecards that were updated after this timestamp. Timestamp must be in in ISO-8601 format.


See noteworthy response attributes.

GET: List Scorecards for Application

curl 'https://harvest.greenhouse.io/v1/applications/{id}/scorecards'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 123,
    "updated_at": "2016-08-22T19:52:38.384Z",
    "created_at": "2016-08-22T19:52:38.384Z",
    "interview": "Application Review",
    "candidate_id": 1234,
    "application_id": 3456,
    "interviewed_at": "2016-08-18T16:00:00.000Z",
    "submitted_by": {
      "id": 4080,
      "name": "Kate Austen",
      "employee_id": null
    },    
    "submitted_at": "2014-03-26T21:59:51Z",
    "overall_recommendation": "yes",
    "attributes": [
      {
        "name": "Communication",
        "type": "Skills",
        "note": "What a great communicator!",
        "rating": "yes"
      },
      {
        "name": "Adaptable",
        "type": "Skills",
        "note": null,
        "rating": "yes"
      },
      {
        "name": "Relationship Manager",
        "type": "Skills",
        "note": null,
        "rating": "mixed"
      },
      {
        "name": "Project Management",
        "type": "Skills",
        "note": null,
        "rating": "mixed"
      },
      {
        "name": "Problem Solver",
        "type": "Skills",
        "note": null,
        "rating": "no"
      },
      {
        "name": "Analytical",
        "type": "Skills",
        "note": null,
        "rating": "definitely_not"
      }
    ],
    "ratings": {
      "definitely_not": [
        "Analytical"
      ],
      "no": [
        "Problem Solver"
      ],
      "mixed": [
        "Relationship Manager",
        "Project Management"
      ],
      "yes": [
        "Communication",
        "Adaptable"
      ],
      "strong_yes": []
    },
    "questions": [
      {
        "id": null,
        "question": "Key Take-Aways",
        "answer": "Seems like a decent candidate."
      },
      {
        "id": null,
        "question": "Private Notes",
        "answer": "Seems like a decent candidate."
      }
    ]
  },
  { },
]

List all submitted scorecards for the requested application.

HTTP Request

GET https://harvest.greenhouse.io/v1/applications/{id}/scorecards

URL Parameters

ParameterDescription
idID of application whose scorecards you want to retrieve.


See noteworthy response attributes.

GET: Retrieve Scorecard

curl 'https://harvest.greenhouse.io/v1/scorecards/{id}'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 123,
  "updated_at": "2016-08-22T19:52:38.384Z",
  "created_at": "2016-08-22T19:52:38.384Z",
  "interview": "Application Review",
  "candidate_id": 1234,
  "application_id": 3456,
  "interviewed_at": "2016-08-18T16:00:00.000Z",
  "submitted_by": {
    "id": 4080,
    "name": "Kate Austen",
    "employee_id": null
  }, 
  "submitted_at": "2014-03-26T21:59:51Z",
  "overall_recommendation": "yes",
  "attributes": [
    {
      "name": "Communication",
      "type": "Skills",
      "note": "What a great communicator!",
      "rating": "yes"
    },
    {
      "name": "Adaptable",
      "type": "Skills",
      "note": null,
      "rating": "yes"
    },
    {
      "name": "Relationship Manager",
      "type": "Skills",
      "note": null,
      "rating": "mixed"
    },
    {
      "name": "Project Management",
      "type": "Skills",
      "note": null,
      "rating": "mixed"
    },
    {
      "name": "Problem Solver",
      "type": "Skills",
      "note": null,
      "rating": "no"
    },
    {
      "name": "Analytical",
      "type": "Skills",
      "note": null,
      "rating": "definitely_not"
    }
  ],
  "ratings": {
    "definitely_not": [
      "Analytical"
    ],
    "no": [
      "Problem Solver"
    ],
    "mixed": [
      "Relationship Manager",
      "Project Management"
    ],
    "yes": [
      "Communication",
      "Adaptable"
    ],
    "strong_yes": []
  },
  "questions": [
    {
      "id": null,
      "question": "Key Take-Aways",
      "answer": "Seems like a decent candidate."
    },
    {
      "id": null,
      "question": "Private Notes",
      "answer": "Seems like a decent candidate."
    }
  ]
}

HTTP Request

GET https://harvest.greenhouse.io/v1/scorecards/{id}

URL Parameters

ParameterDescription
idThe ID of the scorecard to retrieve


See noteworthy response attributes.

Sources

The source object

An organization’s sources.

{
  "id": 632,
  "name": "Other",
  "type": {
    "id": 5,
    "name": "Prospecting"
  }
}

Noteworthy attributes

AttributeDescription
idThe source’s unique identifier
type.nameOne of: attend_events, referrals, third_party_boards, candidate_search, other, social_media, company_marketing, agencies, prospecting

GET: List Sources

curl 'https://harvest.greenhouse.io/v1/sources'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 632,
    "name": "Other",
    "type": {
      "id": 5,
      "name": "Prospecting"
    }
  },
  {
    "id": 928,
    "name": "Destiny",
    "type": {
      "id": 7,
      "name": "Supernatural Means"
    }
  }
]

Lists an organization’s sources, grouped by strategy.

HTTP Request

GET https://harvest.greenhouse.io/v1/sources

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.


See noteworthy response attributes.

Tags

Some resource types allow tags to be assigned to them. Tags are useful for grouping resources. Currently, only candidates can be tagged from the Harvest API.

The candidate tag object

{
  "id": 230,
  "name": "New York"
}

Noteworthy attributes

AttributeDescription
idThe candidate tag’s unique identifier
nameThe name of the tag

GET: List Candidate Tags

List all of an organization’s candidate tags.

curl -X GET 'https://harvest.greenhouse.io/v1/tags/candidate'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 365,
    "name": "Ruby"
  },
  {
    "id": 366,
    "name": "Rails"
  },
  {
    "id": 367,
    "name": "Junior"
  }
]

HTTP Request

GET https://harvest.greenhouse.io/v1/tags/candidate


See noteworthy response attributes.

GET: List tags applied to candidate

curl -X GET 'https://harvest.greenhouse.io/v1/candidates/{id}/tags
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

[
  {
    "id": 41892882,
    "candidate_tag_id": 1094,
    "candidate_tag_name": "Accounting Candidate"
  }
]

Retrieve the list of tags applied to a given candidate

HTTP Request

GET https://harvest.greenhouse.io/v1/candidates/{id}/tags

URL Parameters

ParameterDescription
idThe ID of the candidate whose tags you want to retrieve


See noteworthy response attributes.

DELETE: Remove tag from candidate

curl -X DELETE 'https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "message": "Tag 365 has been removed from candidate 29555013"
}

Remove a tag from a candidate

HTTP Request

DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

URL Parameters

ParameterDescription
candidate_idThe ID of the candidate to whom you want to apply the tag
tag_idThe ID of the tag you wish to apply


See noteworthy response attributes.

JSON Body Parameters

No body parameters.

PUT: Add a candidate tag

curl -X PUT 'https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "message": "Tag 365, 'Ruby', has been applied to candidate 29555013"
}

Apply a tag to a given candidate

HTTP Request

PUT https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

URL Parameters

ParameterDescription
candidate_idThe ID of the candidate to whom you want to apply the tag
tag_idThe ID of the tag you wish to apply


See noteworthy response attributes.

JSON Body Parameters

No body parameters.

Tracking Links

Tracking Links are URLs which allow users to track the source and/or referrer of candidates who applied through the link. Greenhouse generates Tracking Links by appending a token to the end of a job post or job boad URL. These tokens represent a combination of source_id and/or referrer_id, and can link back to a job post, job board, or job.

{
  "id": 162,
  "token": "tnch4u",
  "created_at": "2012-10-07T15:06:35.975Z",
  "updated_at": "2016-09-27T17:52:56.533Z",
  "related_post_id": 1,
  "related_post_type": "SocialMediaPost",
  "job_id": 271,
  "job_post_id": 1275,
  "job_board": {
    "id": 8578,
    "company_name": "Business Corp",
    "url_token": "businessco"
  },
  "source": {
    "id": 4,
    "public_name": "Twitter"
  },
  "credited_to": {
    "id": 1,
    "name": "Some Employee",
    "employee_id": "ABC12345"
  }
}

Noteworthy attributes

AttributeDescription
idThe tracking link’s unique identifier
tokenThe token present in the url
related_post_idIf there is an associated social media post, the Greenhouse ID for that post
related_post_typeWill be “SocialMediaPost” if the link was posted through the social network sharing feature, otherwise this value will be null
job_idThe job associated with this tracking link
job_post_idThe job post associated with this tracking link
job_boardThe job board associated with this tracking link
sourceThe source of the job (recruiter, social media site, etc)
credited_toThe employee credited with a referral for this tracking link

JSON Schema

To view the JSON Schema definition for the Tracking Link object, please click here. This will tell you all of the valid types and definitions, as well as expected fields in the response.

Retrieve the specific tracking link data for the supplied token.

curl -X GET 'https://harvest.greenhouse.io/v1/tracking_links/{token}'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 162,
  "token": "tnch4u",
  "created_at": "2012-10-07T15:06:35.975Z",
  "updated_at": "2016-09-27T17:52:56.533Z",
  "related_post_id": 1,
  "related_post_type": "SocialMediaPost",
  "job_id": 271,
  "job_post_id": 1275,
  "job_board": {
    "id": 8578,
    "company_name": "Business Corp",
    "url_token": "businessco"
  },
  "source": {
    "id": 4,
    "public_name": "Twitter"
  },
  "credited_to": {
    "id": 1,
    "name": "Some Employee",
    "employee_id": "ABC12345"
  }
}

HTTP Request

GET https://harvest.greenhouse.io/v1/tracking_links/{token}

URL Parameters

ParameterDescription
tokenThe token you want to retrieve the data for


See noteworthy response attributes.

Users

The user object

An organization’s Greenhouse users.

{
  "id": 112,
  "name": "Juliet Burke",
  "updated_at": "2016-11-17T16:13:48.888Z",
  "created_at": "2015-11-18T22:26:32.243Z",  
  "disabled": false,
  "site_admin": true,
  "emails": [
    "juliet.burke@example.com",
    "other.woman@example.com"
  ],
  "employee_id": "221"
}

Noteworthy Attributes

AttributeDescription
idThe user’s unique identifier
site_adminIf true, this user is a site admin, which means the user has full permissions on all non-private jobs.

GET: List Users

curl 'https://harvest.greenhouse.io/v1/users'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 112,
    "name": "Juliet Burke",
    "updated_at": "2016-11-17T16:13:48.888Z",
    "created_at": "2015-11-18T22:26:32.243Z",  
    "disabled": false,
    "site_admin": true,
    "emails": [
      "juliet.burke@example.com",
      "other.woman@example.com"
    ],
    "employee_id": "221"
  },
  {
    "id": 712,
    "name": "Mr. Eko",
    "updated_at": "2016-11-03T18:05:47.361Z",
    "created_at": "2015-11-18T22:27:11.111Z",
    "disabled": false,
    "site_admin": true,
    "emails": [
      "mr.eko@example.com"
    ],
    "employee_id": "700"
  }
]

List all of an organization’s Greenhouse users.

HTTP Request

GET https://harvest.greenhouse.io/v1/users

Querystring parameters

ParameterDescription
per_pageReturn up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.
pageA cursor for use in pagination. Returns the n-th chunk of per_page objects.
employee_idReturn a single user that matches this employee id.
created_beforeReturn only users that were created before this timestamp. Timestamp must be in in ISO-8601 format.
created_afterReturn only users that were created after this timestamp. Timestamp must be in in ISO-8601 format.
updated_beforeReturn only users that were updated before this timestamp. Timestamp must be in in ISO-8601 format.
updated_afterReturn only users that were updated after this timestamp. Timestamp must be in in ISO-8601 format.
emailReturn only the user who has this e-mail address as their primary e-mail or a secondary e-mail.


See noteworthy response attributes.

GET: Retrieve User

curl 'https://harvest.greenhouse.io/v1/users/{id}'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
{
  "id": 112,
  "name": "Juliet Burke",
  "updated_at": "2016-11-17T16:13:48.888Z",
  "created_at": "2015-11-18T22:26:32.243Z",  
  "disabled": false,
  "site_admin": true,
  "emails": [
    "juliet.burke@example.com",
    "other.woman@example.com"
  ],
  "employee_id": "221"
}

HTTP Request

GET https://harvest.greenhouse.io/v1/users/{id}

URL Parameters

ParameterDescription
idThe ID of the user to retrieve

Querystring Parameters

ParameterDescription
employee_idThe Employee ID of the user to retrieve


See noteworthy response attributes.

PATCH: Disable User

curl -X PATCH 'https://harvest.greenhouse.io/v1/users/{id}/disable'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 253528,
  "name": "Bob Smith",
  "updated_at": "2017-03-23T18:58:27.796Z",
  "created_at": "2016-04-28T15:28:16.440Z",
  "disabled": true,
  "site_admin": false,
  "emails": [
    "bob@email.org"
  ],
  "employee_id": "221"
}

Disable a user. It is safe to call this method on a user that is currently disabled. If the user is already disabled, nothing happens.

HTTP Request

PATCH https://harvest.greenhouse.io/v1/users/{id}/disable

PATCH: Enable User

curl -X PATCH 'https://harvest.greenhouse.io/v1/users/{id}/enable'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns JSON structured like this:

{
  "id": 253528,
  "name": "Bob Smith",
  "updated_at": "2017-03-23T18:58:27.796Z",
  "created_at": "2016-04-28T15:28:16.440Z",
  "disabled": false,
  "site_admin": false,
  "emails": [
    "bob@email.org"
  ],
  "employee_id": "221"
}

Enable a user. It is safe to call this method on a user that is currently enabled. If the user is already enabled, nothing happens.

HTTP Request

PATCH https://harvest.greenhouse.io/v1/users/{id}/enable

PATCH: Edit User

curl -X PATCH 'https://harvest.greenhouse.io/v1/users/{id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "first_name": "Bob",
  "last_name": "Smith",
  "employee_id": "ABC12345"
}

Edit a user’s basic information.

HTTP Request

PATCH https://harvest.greenhouse.io/v1/users/{id}

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
first_nameNostringThe user’s new first name. If included, this cannot be blank.
last_nameNostringThe user’s new last name. If included, this cannot be blank.
employee_id*NostringThe user’s external employee id. If included, this cannot be blank, nor can it match any other employee-id for a user in this organization.

* - If the employee id feature is not enabled for your organization, attempting to edit this field will raise an API Error.

POST: Add User

curl -X POST 'https://harvest.greenhouse.io/v1/users'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "first_name": "Bob",
  "last_name": "Smith",
  "email": "bob@email.org",
  "send_email_invite": true,
  "employee_id": "ABC12345"
}

Create a new user with Basic permissions.

HTTP Request

POST https://harvest.greenhouse.io/v1/users

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
first_nameYesstringThe user’s first name
last_nameYesstringThe user’s last name
emailYesstringThe user’s email address. Must be a valid email address.
send_email_invite*NobooleanIf true, an email will be sent to the user alerting them of any new job permissions that have been assigned to them. Emails are never sent when permissions are removed. If false, nothing happens. Default is false.
employee_idNostringThe user’s external employee id.

* - A newly created user will not be able to login until they create a password via the invitation link or configured in an SSO system.

POST: Add E-mail Address To User

curl -X POST 'https://harvest.greenhouse.io/v1/users/{id}/email_addresses'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command takes a JSON request, structured like this:

{
  "email": "bob@email.org",
  "send_verification": true,
}

Creates a new unverified e-mail address on the given user. The address will not be considered verified until the user receives the verification e-mail and clicks on the link to verify the address. There is no method in the API to verify an e-mail address. This endpoint is also used to re-send a verification e-mail. The request body to do this is exactly the same. If an unverified e-mail is received with send_verification set to true, Greenhouse will attempt to re-send the verification e-mail. If you attempt this with a verified e-mail, nothing occurs.

HTTP Request

POST https://harvest.greenhouse.io/v1/users/{id}/email_addresses

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
emailYesstringThe user’s email address. Must be a valid email address.
send_verificationNobooleanIf true, an email will be sent to the user to verify this e-mail address. If false, nothing happens. Default is false.

There are 3 successful response states for this endpoint.

User Permissions

The job permission object

The user role a user has for a job.

{
  "id": 382934,
  "job_id": 9192,
  "user_role_id": 123
}

Noteworthy Attributes

AttributeDescription
idThe job permission’s unique identifier
job_idThe ID of the job the user has permission for
user_role_idThe ID of the user role the user has for the job

GET: List Job Permissions

curl 'https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 7879576,
    "job_id": 80722,
    "user_role_id": 4730
  },
  {
    "id": 7879577,
    "job_id": 83475,
    "user_role_id": 4730
  },
  {
    "id": 7879579,
    "job_id": 146048,
    "user_role_id": 4730
  },
  {
    "id": 7879580,
    "job_id": 87904,
    "user_role_id": 4730
  },
  {
    "id": 7879582,
    "job_id": 116958,
    "user_role_id": 4730
  },
  {
    "id": 7879583,
    "job_id": 82318,
    "user_role_id": 4730
  }
]

List the job permissions for a given user.

HTTP Request

GET https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs

URL Parameters

ParameterDescription
idThe ID of the user whose job permissions to retrieve

Note: This endpoint is only intended for use with Job Admin and/or Interviewer users, as these roles are assigned on a per job basis. Users that are Site Admins have permissions on all public jobs and will return an empty array. Basic users cannot be assigned to any jobs and will also return an empty array.

This endpoint supports pagination. See the Pagination section for more detail.

DELETE: Remove a Job Permission

curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs'
-d '{ "job_permission_id": {job_permission_id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns a JSON response, structured like this:

{
  "message": "Job Permission 321231 has been deleted."
}

Removes a user’s job permission.

HTTP Request

DELETE https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
job_permission_idYesintegerThe ID of the job permission

PUT: Add a Job Permission

curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs'
-d '{ "job_id": {job_id}, "user_role_id": {user_role_id} }'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns a JSON response, structured like this:

{
  "id": 271232,
  "job_id": 12891,
  "user_role_id": 1172
}

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

HTTP Request

PUT https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
job_idYesintegerThe ID of the job
user_role_idYesintegerThe ID of the user role

Note: This endpoint does not support assigning a user role to a user for a confidential job.

The future job permission object

The user role a user will get when a job with the specified criteria is created.

{
  "id": 87819,
  "office_id": 29192,
  "department_id": null,
  "user_role_id": 4730
}

Noteworthy Attributes

AttributeDescription
idThe future job permission’s unique identifier
office_idThe ID of the office of the job
department_idThe ID of the department of the job
user_role_idThe ID of the user role that will be granted

GET: List Future Job Permissions

curl 'https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 87819,
    "office_id": null,
    "department_id": null,
    "user_role_id": 4730
  },
  {
    "id": 92834,
    "office_id": 8232,
    "department_id": null,
    "user_role_id": 4730
  },
  {
    "id": 82129,
    "office_id": 8232,
    "department_id": 92921,
    "user_role_id": 4730
  }
]

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

HTTP Request

GET https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs

URL Parameters

ParameterDescription
idThe ID of the user whose future job permissions to retrieve

This endpoint supports pagination. See the Pagination section for more detail.

DELETE: Remove a Future Job Permission

curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs'
-d '{ "future_job_permission_id": {future_job_permission_id}'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns a JSON response, structured like this:

{
  "message": "Future Job Permission 639234 has been deleted."
}

Removes a user’s future job permission.

HTTP Request

DELETE https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
future_job_permission_idYesintegerThe ID of the future job permission

PUT: Add a Future Job Permission

curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs'
-d '{ "office_id": {office_id}, "department_id": {department_id}, "user_role_id": {user_role_id} }'
-H "On-Behalf-Of: {greenhouse user ID}"
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"

The above command returns a JSON response, structured like this:

{
  "id": 9283,
  "office_id": 281921,
  "department_id": 61921,
  "user_role_id": 91821
}

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

HTTP Request

PUT https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs

Headers

HeaderDescription
On-Behalf-OfID of the user issuing this request. Required for auditing purposes.

JSON Body Parameters

ParameterRequiredTypeDescription
office_idNointegerThe ID of the office. Set to null to include all offices.
department_idNointegerThe ID of the department. Set to null to include all departments.
user_role_idYesintegerThe ID of the user role

User Roles

The user role object

The roles that can be assigned to a user.

{
  "id": 4729,
  "type": "interviewer",
  "name": "Interviewer"
}

Noteworthy Attributes

AttributeDescription
idThe user role ID
typeThe type of role. Will be interviewer or job_admin.
nameThe name of the role

GET: List User Roles

curl 'https://harvest.greenhouse.io/v1/user_roles'
-H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6"
[
  {
    "id": 4729,
    "type": "interviewer",
    "name": "Interviewer"
  },
  {
    "id": 4730,
    "type": "job_admin",
    "name": "Standard"
  },
  {
    "id": 4731,
    "type": "job_admin",
    "name": "Private"
  }
]

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

HTTP Request

GET https://harvest.greenhouse.io/v1/user_roles