CINXE.COM

<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> <link rel="manifest" href="/images/favicons/manifest.json"> <link rel="icon" href="images/favicons/favicon.ico" sizes="32x32"> <link rel="icon" href="images/favicons/icon.svg" type="image/svg+xml"> <link rel="apple-touch-icon" href="images/favicons/apple-touch-icon.png"> <meta name="theme-color" content="#047957"> <title>Harvest API | Greenhouse</title> <style media="screen"> .highlight table td { padding: 5px; } .highlight table pre { margin: 0; } .highlight, .highlight .w { color: #f8f8f2; background-color: #272822; } .highlight .err { color: #272822; background-color: #f92672; } .highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs { color: #75715e; } .highlight .cp { color: #f4bf75; } .highlight .nt { color: #f4bf75; } .highlight .o, .highlight .ow { color: #f8f8f2; } .highlight .p, .highlight .pi { color: #f8f8f2; } .highlight .gi { color: #a6e22e; } .highlight .gd { color: #f92672; } .highlight .gh { color: #66d9ef; background-color: #272822; font-weight: bold; } .highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv { color: #ae81ff; } .highlight .kc { color: #fd971f; } .highlight .kt { color: #fd971f; } .highlight .kd { color: #fd971f; } .highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 { color: #a6e22e; } .highlight .sa { color: #ae81ff; } .highlight .sr { color: #a1efe4; } .highlight .si { color: #cc6633; } .highlight .se { color: #cc6633; } .highlight .nn { color: #f4bf75; } .highlight .nc { color: #f4bf75; } .highlight .no { color: #f4bf75; } .highlight .na { color: #66d9ef; } .highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx { color: #a6e22e; } .highlight .ss { color: #a6e22e; } </style> <style media="print"> * { -webkit-transition:none!important; transition:none!important; } .highlight table td { padding: 5px; } .highlight table pre { margin: 0; } .highlight, .highlight .w { color: #586e75; } .highlight .err { color: #002b36; background-color: #dc322f; } .highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs { color: #657b83; } .highlight .cp { color: #b58900; } .highlight .nt { color: #b58900; } .highlight .o, .highlight .ow { color: #93a1a1; } .highlight .p, .highlight .pi { color: #93a1a1; } .highlight .gi { color: #859900; } .highlight .gd { color: #dc322f; } .highlight .gh { color: #268bd2; background-color: #002b36; font-weight: bold; } .highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv { color: #6c71c4; } .highlight .kc { color: #cb4b16; } .highlight .kt { color: #cb4b16; } .highlight .kd { color: #cb4b16; } .highlight .s, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 { color: #859900; } .highlight .sa { color: #6c71c4; } .highlight .sr { color: #2aa198; } .highlight .si { color: #d33682; } .highlight .se { color: #d33682; } .highlight .nn { color: #b58900; } .highlight .nc { color: #b58900; } .highlight .no { color: #b58900; } .highlight .na { color: #268bd2; } .highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx { color: #859900; } .highlight .ss { color: #859900; } </style> <link href="stylesheets/screen_harvest.css" rel="stylesheet" media="screen" /> <link href="stylesheets/print.css" rel="stylesheet" media="print" /> <script src="javascripts/all.js"></script> <script type="text/javascript"> !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+"cdn.segment.com/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.1.0"; analytics.load("2q7wwCrJormvWKrplqZYR2gXyxLK5Uhx"); analytics.page() }}(); </script> </head> <body class="harvest" data-languages="["shell","ruby"]"> <a href="#" id="nav-button"> NAV <img src="images/navbar.png" alt="" /> </a> <div class="toc-wrapper"> <a href="/" class="nav-home-link"> <div class="nav-home"> <img src="images/logo.png" class="logo" alt="" /> Developers Home </div> </a> <div class="lang-selector"> <a href="#" data-language-name="shell">shell</a> <a href="#" data-language-name="ruby">ruby</a> </div> <div class="search"> <input type="text" class="search" id="input-search" placeholder="Search"> </div> <ul class="search-results"></ul> <ul id="toc" class="toc-list-h1"> <li> <a href="#introduction" class="toc-h1 toc-link" data-title="Introduction">Introduction</a> <ul class="toc-list-h2"> <li> <a href="#authentication" class="toc-h2 toc-link" data-title="Authentication">Authentication</a> </li> <li> <a href="#rate-limiting" class="toc-h2 toc-link" data-title="Rate limiting">Rate limiting</a> </li> <li> <a href="#pagination" class="toc-h2 toc-link" data-title="Pagination">Pagination</a> </li> <li> <a href="#validation" class="toc-h2 toc-link" data-title="Validation">Validation</a> </li> <li> <a href="#general-considerations" class="toc-h2 toc-link" data-title="General considerations">General considerations</a> </li> <li> <a href="#errors" class="toc-h2 toc-link" data-title="Errors">Errors</a> </li> <li> <a href="#harvest-change-log" class="toc-h2 toc-link" data-title="Harvest Change Log">Harvest Change Log</a> </li> </ul> </li> <li> <a href="#activity-feed" class="toc-h1 toc-link" data-title="Activity Feed">Activity Feed</a> <ul class="toc-list-h2"> <li> <a href="#the-activity-feed-object" class="toc-h2 toc-link" data-title="The activity feed object">The activity feed object</a> </li> <li> <a href="#get-retrieve-activity-feed" class="toc-h2 toc-link" data-title="GET: Retrieve Activity Feed">GET: Retrieve Activity Feed</a> </li> </ul> </li> <li> <a href="#applications" class="toc-h1 toc-link" data-title="Applications">Applications</a> <ul class="toc-list-h2"> <li> <a href="#the-application-object" class="toc-h2 toc-link" data-title="The application object">The application object</a> </li> <li> <a href="#get-list-applications" class="toc-h2 toc-link" data-title="GET: List Applications">GET: List Applications</a> </li> <li> <a href="#get-retrieve-application" class="toc-h2 toc-link" data-title="GET: Retrieve Application">GET: Retrieve Application</a> </li> <li> <a href="#delete-delete-application" class="toc-h2 toc-link" data-title="DELETE: Delete Application">DELETE: Delete Application</a> </li> <li> <a href="#post-add-application-to-candidate-prospect" class="toc-h2 toc-link" data-title="POST: Add Application to Candidate/Prospect">POST: Add Application to Candidate/Prospect</a> </li> <li> <a href="#patch-update-application" class="toc-h2 toc-link" data-title="PATCH: Update Application">PATCH: Update Application</a> </li> <li> <a href="#post-advance-application" class="toc-h2 toc-link" data-title="POST: Advance Application">POST: Advance Application</a> </li> <li> <a href="#post-move-application-different-job" class="toc-h2 toc-link" data-title="POST: Move Application (Different Job)">POST: Move Application (Different Job)</a> </li> <li> <a href="#post-move-application-same-job" class="toc-h2 toc-link" data-title="POST: Move Application (Same Job)">POST: Move Application (Same Job)</a> </li> <li> <a href="#patch-convert-prospect-to-candidate" class="toc-h2 toc-link" data-title="PATCH: Convert Prospect To Candidate">PATCH: Convert Prospect To Candidate</a> </li> <li> <a href="#post-add-attachment-to-application" class="toc-h2 toc-link" data-title="POST: Add Attachment to Application">POST: Add Attachment to Application</a> </li> <li> <a href="#post-hire-application" class="toc-h2 toc-link" data-title="POST: Hire Application">POST: Hire Application</a> </li> <li> <a href="#post-reject-application" class="toc-h2 toc-link" data-title="POST: Reject Application">POST: Reject Application</a> </li> <li> <a href="#patch-update-rejection-reason" class="toc-h2 toc-link" data-title="PATCH: Update Rejection Reason">PATCH: Update Rejection Reason</a> </li> <li> <a href="#post-unreject-application" class="toc-h2 toc-link" data-title="POST: Unreject Application">POST: Unreject Application</a> </li> </ul> </li> <li> <a href="#approvals" class="toc-h1 toc-link" data-title="Approvals">Approvals</a> <ul class="toc-list-h2"> <li> <a href="#the-approval-flow-object" class="toc-h2 toc-link" data-title="The approval flow object">The approval flow object</a> </li> <li> <a href="#get-list-approvals-for-job" class="toc-h2 toc-link" data-title="GET: List Approvals For Job">GET: List Approvals For Job</a> </li> <li> <a href="#get-retrieve-approval-flow" class="toc-h2 toc-link" data-title="GET: Retrieve Approval Flow">GET: Retrieve Approval Flow</a> </li> <li> <a href="#post-request-approvals" class="toc-h2 toc-link" data-title="POST: Request Approvals">POST: Request Approvals</a> </li> <li> <a href="#get-pending-approvals-for-user" class="toc-h2 toc-link" data-title="GET: Pending Approvals For User">GET: Pending Approvals For User</a> </li> <li> <a href="#put-replace-an-approver-in-an-approver-group" class="toc-h2 toc-link" data-title="PUT: Replace an approver in an approver group">PUT: Replace an approver in an approver group</a> </li> <li> <a href="#put-create-or-replace-an-approval-flow" class="toc-h2 toc-link" data-title="PUT: Create or replace an approval flow">PUT: Create or replace an approval flow</a> </li> </ul> </li> <li> <a href="#candidates" class="toc-h1 toc-link" data-title="Candidates">Candidates</a> <ul class="toc-list-h2"> <li> <a href="#the-candidate-object" class="toc-h2 toc-link" data-title="The candidate object">The candidate object</a> </li> <li> <a href="#get-list-candidates" class="toc-h2 toc-link" data-title="GET: List Candidates">GET: List Candidates</a> </li> <li> <a href="#get-retrieve-candidate" class="toc-h2 toc-link" data-title="GET: Retrieve Candidate">GET: Retrieve Candidate</a> </li> <li> <a href="#delete-delete-candidate" class="toc-h2 toc-link" data-title="DELETE: Delete Candidate">DELETE: Delete Candidate</a> </li> <li> <a href="#patch-edit-candidate" class="toc-h2 toc-link" data-title="PATCH: Edit Candidate">PATCH: Edit Candidate</a> </li> <li> <a href="#post-add-attachment" class="toc-h2 toc-link" data-title="POST: Add Attachment">POST: Add Attachment</a> </li> <li> <a href="#post-add-candidate" class="toc-h2 toc-link" data-title="POST: Add Candidate">POST: Add Candidate</a> </li> <li> <a href="#post-add-note" class="toc-h2 toc-link" data-title="POST: Add Note">POST: Add Note</a> </li> <li> <a href="#post-add-e-mail-note" class="toc-h2 toc-link" data-title="POST: Add E-mail Note">POST: Add E-mail Note</a> </li> <li> <a href="#post-add-education" class="toc-h2 toc-link" data-title="POST: Add Education">POST: Add Education</a> </li> <li> <a href="#delete-remove-education-from-candidate" class="toc-h2 toc-link" data-title="DELETE: Remove Education From Candidate">DELETE: Remove Education From Candidate</a> </li> <li> <a href="#post-add-employment" class="toc-h2 toc-link" data-title="POST: Add Employment">POST: Add Employment</a> </li> <li> <a href="#delete-remove-employment-from-candidate" class="toc-h2 toc-link" data-title="DELETE: Remove Employment From Candidate">DELETE: Remove Employment From Candidate</a> </li> <li> <a href="#post-add-prospect" class="toc-h2 toc-link" data-title="POST: Add Prospect">POST: Add Prospect</a> </li> <li> <a href="#put-anonymize-candidate" class="toc-h2 toc-link" data-title="PUT: Anonymize Candidate">PUT: Anonymize Candidate</a> </li> <li> <a href="#put-merge-candidates" class="toc-h2 toc-link" data-title="PUT: Merge Candidates">PUT: Merge Candidates</a> </li> </ul> </li> <li> <a href="#close-reasons" class="toc-h1 toc-link" data-title="Close Reasons">Close Reasons</a> <ul class="toc-list-h2"> <li> <a href="#the-close-reason-object" class="toc-h2 toc-link" data-title="The close reason object">The close reason object</a> </li> <li> <a href="#get-list-close-reasons" class="toc-h2 toc-link" data-title="GET: List Close Reasons">GET: List Close Reasons</a> </li> </ul> </li> <li> <a href="#custom-fields" class="toc-h1 toc-link" data-title="Custom Fields">Custom Fields</a> <ul class="toc-list-h2"> <li> <a href="#the-custom-field-object" class="toc-h2 toc-link" data-title="The custom field object">The custom field object</a> </li> <li> <a href="#get-list-custom-fields" class="toc-h2 toc-link" data-title="GET: List Custom Fields">GET: List Custom Fields</a> </li> <li> <a href="#get-retrieve-custom-field" class="toc-h2 toc-link" data-title="GET: Retrieve Custom Field">GET: Retrieve Custom Field</a> </li> <li> <a href="#the-custom-field-options-object" class="toc-h2 toc-link" data-title="The custom field options object">The custom field options object</a> </li> <li> <a href="#post-create-custom-field" class="toc-h2 toc-link" data-title="POST: Create Custom Field">POST: Create Custom Field</a> </li> <li> <a href="#patch-update-custom-field" class="toc-h2 toc-link" data-title="PATCH: Update Custom Field">PATCH: Update Custom Field</a> </li> <li> <a href="#delete-delete-custom-field" class="toc-h2 toc-link" data-title="DELETE: Delete Custom Field">DELETE: Delete Custom Field</a> </li> <li> <a href="#get-list-custom-field-options" class="toc-h2 toc-link" data-title="GET: List Custom Field Options">GET: List Custom Field Options</a> </li> <li> <a href="#post-create-custom-field-options" class="toc-h2 toc-link" data-title="POST: Create Custom Field Options">POST: Create Custom Field Options</a> </li> <li> <a href="#patch-update-custom-field-options" class="toc-h2 toc-link" data-title="PATCH: Update Custom Field Options">PATCH: Update Custom Field Options</a> </li> <li> <a href="#delete-remove-custom-field-options" class="toc-h2 toc-link" data-title="DELETE: Remove Custom Field Options">DELETE: Remove Custom Field Options</a> </li> </ul> </li> <li> <a href="#demographic-data" class="toc-h1 toc-link" data-title="Demographic Data">Demographic Data</a> <ul class="toc-list-h2"> <li> <a href="#the-demographic-question-set-object" class="toc-h2 toc-link" data-title="The Demographic Question Set object">The Demographic Question Set object</a> </li> <li> <a href="#the-demographic-question-object" class="toc-h2 toc-link" data-title="The Demographic Question object">The Demographic Question object</a> </li> <li> <a href="#the-demographic-answer-option-object" class="toc-h2 toc-link" data-title="The Demographic Answer Option object">The Demographic Answer Option object</a> </li> <li> <a href="#the-demographic-answer-object" class="toc-h2 toc-link" data-title="The Demographic Answer object">The Demographic Answer object</a> </li> <li> <a href="#get-list-demographic-question-sets" class="toc-h2 toc-link" data-title="GET: List Demographic Question Sets">GET: List Demographic Question Sets</a> </li> <li> <a href="#get-retrieve-demographic-question-set" class="toc-h2 toc-link" data-title="GET: Retrieve Demographic Question Set">GET: Retrieve Demographic Question Set</a> </li> <li> <a href="#get-list-demographic-questions" class="toc-h2 toc-link" data-title="GET: List Demographic Questions">GET: List Demographic Questions</a> </li> <li> <a href="#get-list-demographic-questions-for-demographic-question-set" class="toc-h2 toc-link" data-title="GET: List Demographic Questions For Demographic Question Set">GET: List Demographic Questions For Demographic Question Set</a> </li> <li> <a href="#get-retrieve-demographic-question" class="toc-h2 toc-link" data-title="GET: Retrieve Demographic Question">GET: Retrieve Demographic Question</a> </li> <li> <a href="#get-list-demographic-answer-options" class="toc-h2 toc-link" data-title="GET: List Demographic Answer Options">GET: List Demographic Answer Options</a> </li> <li> <a href="#get-list-demographic-answer-options-for-demographic-question" class="toc-h2 toc-link" data-title="GET: List Demographic Answer Options For Demographic Question">GET: List Demographic Answer Options For Demographic Question</a> </li> <li> <a href="#get-retrieve-demographic-answer-option" class="toc-h2 toc-link" data-title="GET: Retrieve Demographic Answer Option">GET: Retrieve Demographic Answer Option</a> </li> <li> <a href="#get-list-demographic-answers" class="toc-h2 toc-link" data-title="GET: List Demographic Answers">GET: List Demographic Answers</a> </li> <li> <a href="#get-list-demographic-answers-for-application" class="toc-h2 toc-link" data-title="GET: List Demographic Answers For Application">GET: List Demographic Answers For Application</a> </li> <li> <a href="#get-retrieve-demographic-answer" class="toc-h2 toc-link" data-title="GET: Retrieve Demographic Answer">GET: Retrieve Demographic Answer</a> </li> </ul> </li> <li> <a href="#departments" class="toc-h1 toc-link" data-title="Departments">Departments</a> <ul class="toc-list-h2"> <li> <a href="#the-department-object" class="toc-h2 toc-link" data-title="The department object">The department object</a> </li> <li> <a href="#get-list-departments" class="toc-h2 toc-link" data-title="GET: List Departments">GET: List Departments</a> </li> <li> <a href="#get-retrieve-department" class="toc-h2 toc-link" data-title="GET: Retrieve Department">GET: Retrieve Department</a> </li> <li> <a href="#patch-edit-department" class="toc-h2 toc-link" data-title="PATCH: Edit Department">PATCH: Edit Department</a> </li> <li> <a href="#post-add-department" class="toc-h2 toc-link" data-title="POST: Add Department">POST: Add Department</a> </li> </ul> </li> <li> <a href="#education" class="toc-h1 toc-link" data-title="Education">Education</a> <ul class="toc-list-h2"> <li> <a href="#the-education-objects" class="toc-h2 toc-link" data-title="The education objects">The education objects</a> </li> <li> <a href="#get-list-degrees" class="toc-h2 toc-link" data-title="GET: List Degrees">GET: List Degrees</a> </li> <li> <a href="#get-list-disciplines" class="toc-h2 toc-link" data-title="GET: List Disciplines">GET: List Disciplines</a> </li> <li> <a href="#get-list-schools" class="toc-h2 toc-link" data-title="GET: List Schools">GET: List Schools</a> </li> </ul> </li> <li> <a href="#eeoc" class="toc-h1 toc-link" data-title="EEOC">EEOC</a> <ul class="toc-list-h2"> <li> <a href="#the-eeoc-object" class="toc-h2 toc-link" data-title="The EEOC object">The EEOC object</a> </li> <li> <a href="#get-list-eeoc" class="toc-h2 toc-link" data-title="GET: List EEOC">GET: List EEOC</a> </li> <li> <a href="#get-retrieve-eeoc-data-for-application" class="toc-h2 toc-link" data-title="GET: Retrieve EEOC Data for Application">GET: Retrieve EEOC Data for Application</a> </li> </ul> </li> <li> <a href="#email-templates" class="toc-h1 toc-link" data-title="Email Templates">Email Templates</a> <ul class="toc-list-h2"> <li> <a href="#the-email-template-object" class="toc-h2 toc-link" data-title="The email template object">The email template object</a> </li> <li> <a href="#get-list-email-templates" class="toc-h2 toc-link" data-title="GET: List Email Templates">GET: List Email Templates</a> </li> <li> <a href="#get-retrieve-email-template" class="toc-h2 toc-link" data-title="GET: Retrieve Email Template">GET: Retrieve Email Template</a> </li> </ul> </li> <li> <a href="#job-openings" class="toc-h1 toc-link" data-title="Job Openings">Job Openings</a> <ul class="toc-list-h2"> <li> <a href="#the-job-opening-object" class="toc-h2 toc-link" data-title="The job opening object">The job opening object</a> </li> <li> <a href="#get-list-job-openings" class="toc-h2 toc-link" data-title="GET: List Job Openings">GET: List Job Openings</a> </li> <li> <a href="#get-single-opening-for-job" class="toc-h2 toc-link" data-title="GET: Single Opening For Job">GET: Single Opening For Job</a> </li> <li> <a href="#delete-destroy-openings" class="toc-h2 toc-link" data-title="DELETE: Destroy Openings">DELETE: Destroy Openings</a> </li> <li> <a href="#patch-edit-openings" class="toc-h2 toc-link" data-title="PATCH: Edit Openings">PATCH: Edit Openings</a> </li> <li> <a href="#post-create-new-openings" class="toc-h2 toc-link" data-title="POST: Create New Openings">POST: Create New Openings</a> </li> </ul> </li> <li> <a href="#job-posts" class="toc-h1 toc-link" data-title="Job Posts">Job Posts</a> <ul class="toc-list-h2"> <li> <a href="#the-job-post-object" class="toc-h2 toc-link" data-title="The job post object">The job post object</a> </li> <li> <a href="#get-list-job-posts" class="toc-h2 toc-link" data-title="GET: List Job Posts">GET: List Job Posts</a> </li> <li> <a href="#get-retrieve-job-post" class="toc-h2 toc-link" data-title="GET: Retrieve Job Post">GET: Retrieve Job Post</a> </li> <li> <a href="#get-list-job-posts-for-job" class="toc-h2 toc-link" data-title="GET: List Job Posts for Job">GET: List Job Posts for Job</a> </li> <li> <a href="#get-retrieve-job-post-for-job" class="toc-h2 toc-link" data-title="GET: Retrieve Job Post for Job">GET: Retrieve Job Post for Job</a> </li> <li> <a href="#get-retrieve-custom-locations-for-job-post" class="toc-h2 toc-link" data-title="GET: Retrieve Custom Locations for Job Post">GET: Retrieve Custom Locations for Job Post</a> </li> <li> <a href="#patch-update-job-post" class="toc-h2 toc-link" data-title="PATCH: Update Job Post">PATCH: Update Job Post</a> </li> <li> <a href="#patch-update-job-post-status" class="toc-h2 toc-link" data-title="PATCH: Update Job Post Status">PATCH: Update Job Post Status</a> </li> </ul> </li> <li> <a href="#job-stages" class="toc-h1 toc-link" data-title="Job Stages">Job Stages</a> <ul class="toc-list-h2"> <li> <a href="#the-job-stage-object" class="toc-h2 toc-link" data-title="The job stage object">The job stage object</a> </li> <li> <a href="#get-list-job-stages" class="toc-h2 toc-link" data-title="GET: List Job Stages">GET: List Job Stages</a> </li> <li> <a href="#get-list-job-stages-for-job" class="toc-h2 toc-link" data-title="GET: List Job Stages for Job">GET: List Job Stages for Job</a> </li> <li> <a href="#get-retrieve-job-stage" class="toc-h2 toc-link" data-title="GET: Retrieve Job Stage">GET: Retrieve Job Stage</a> </li> </ul> </li> <li> <a href="#jobs" class="toc-h1 toc-link" data-title="Jobs">Jobs</a> <ul class="toc-list-h2"> <li> <a href="#the-job-object" class="toc-h2 toc-link" data-title="The job object">The job object</a> </li> <li> <a href="#get-list-jobs" class="toc-h2 toc-link" data-title="GET: List Jobs">GET: List Jobs</a> </li> <li> <a href="#get-retrieve-job" class="toc-h2 toc-link" data-title="GET: Retrieve Job">GET: Retrieve Job</a> </li> <li> <a href="#patch-update-job" class="toc-h2 toc-link" data-title="PATCH: Update Job">PATCH: Update Job</a> </li> <li> <a href="#post-create-job" class="toc-h2 toc-link" data-title="POST: Create Job">POST: Create Job</a> </li> <li> <a href="#get-hiring-team" class="toc-h2 toc-link" data-title="GET: Hiring Team">GET: Hiring Team</a> </li> <li> <a href="#put-replace-hiring-team" class="toc-h2 toc-link" data-title="PUT: Replace Hiring Team">PUT: Replace Hiring Team</a> </li> <li> <a href="#post-add-hiring-team-members" class="toc-h2 toc-link" data-title="POST: Add Hiring Team Members">POST: Add Hiring Team Members</a> </li> <li> <a href="#delete-remove-hiring-team-member" class="toc-h2 toc-link" data-title="DELETE: Remove Hiring Team Member">DELETE: Remove Hiring Team Member</a> </li> </ul> </li> <li> <a href="#offers" class="toc-h1 toc-link" data-title="Offers">Offers</a> <ul class="toc-list-h2"> <li> <a href="#the-offer-object" class="toc-h2 toc-link" data-title="The offer object">The offer object</a> </li> <li> <a href="#get-list-offers" class="toc-h2 toc-link" data-title="GET: List Offers">GET: List Offers</a> </li> <li> <a href="#get-list-offers-for-application" class="toc-h2 toc-link" data-title="GET: List Offers for Application">GET: List Offers for Application</a> </li> <li> <a href="#get-retrieve-current-offer-for-application" class="toc-h2 toc-link" data-title="GET: Retrieve Current Offer for Application">GET: Retrieve Current Offer for Application</a> </li> <li> <a href="#get-retrieve-offer" class="toc-h2 toc-link" data-title="GET: Retrieve Offer">GET: Retrieve Offer</a> </li> <li> <a href="#patch-update-current-offer" class="toc-h2 toc-link" data-title="PATCH: Update Current Offer">PATCH: Update Current Offer</a> </li> </ul> </li> <li> <a href="#offices" class="toc-h1 toc-link" data-title="Offices">Offices</a> <ul class="toc-list-h2"> <li> <a href="#the-office-object" class="toc-h2 toc-link" data-title="The office object">The office object</a> </li> <li> <a href="#get-list-offices" class="toc-h2 toc-link" data-title="GET: List Offices">GET: List Offices</a> </li> <li> <a href="#get-retrieve-office" class="toc-h2 toc-link" data-title="GET: Retrieve Office">GET: Retrieve Office</a> </li> <li> <a href="#patch-edit-office" class="toc-h2 toc-link" data-title="PATCH: Edit Office">PATCH: Edit Office</a> </li> <li> <a href="#post-add-office" class="toc-h2 toc-link" data-title="POST: Add Office">POST: Add Office</a> </li> </ul> </li> <li> <a href="#prospect-pools" class="toc-h1 toc-link" data-title="Prospect Pools">Prospect Pools</a> <ul class="toc-list-h2"> <li> <a href="#the-prospect-pools-object" class="toc-h2 toc-link" data-title="The prospect pools object">The prospect pools object</a> </li> <li> <a href="#get-list-prospect-pools" class="toc-h2 toc-link" data-title="GET: List Prospect Pools">GET: List Prospect Pools</a> </li> <li> <a href="#get-retrieve-prospect-pool" class="toc-h2 toc-link" data-title="GET: Retrieve Prospect Pool">GET: Retrieve Prospect Pool</a> </li> </ul> </li> <li> <a href="#rejection-reasons" class="toc-h1 toc-link" data-title="Rejection Reasons">Rejection Reasons</a> <ul class="toc-list-h2"> <li> <a href="#the-rejection-reason-object" class="toc-h2 toc-link" data-title="The rejection reason object">The rejection reason object</a> </li> <li> <a href="#get-list-rejection-reasons" class="toc-h2 toc-link" data-title="GET: List Rejection Reasons">GET: List Rejection Reasons</a> </li> </ul> </li> <li> <a href="#scheduled-interviews" class="toc-h1 toc-link" data-title="Scheduled Interviews">Scheduled Interviews</a> <ul class="toc-list-h2"> <li> <a href="#the-scheduled-interview-object" class="toc-h2 toc-link" data-title="The Scheduled Interview object">The Scheduled Interview object</a> </li> <li> <a href="#get-list-scheduled-interviews" class="toc-h2 toc-link" data-title="GET: List Scheduled Interviews">GET: List Scheduled Interviews</a> </li> <li> <a href="#get-list-scheduled-interviews-for-application" class="toc-h2 toc-link" data-title="GET: List Scheduled Interviews for Application">GET: List Scheduled Interviews for Application</a> </li> <li> <a href="#get-retrieve-scheduled-interview" class="toc-h2 toc-link" data-title="GET: Retrieve Scheduled Interview">GET: Retrieve Scheduled Interview</a> </li> <li> <a href="#post-create-scheduled-interview" class="toc-h2 toc-link" data-title="POST: Create Scheduled Interview">POST: Create Scheduled Interview</a> </li> <li> <a href="#patch-update-scheduled-interview" class="toc-h2 toc-link" data-title="PATCH: Update Scheduled Interview">PATCH: Update Scheduled Interview</a> </li> <li> <a href="#delete-remove-scheduled-interview" class="toc-h2 toc-link" data-title="Delete: Remove Scheduled Interview">Delete: Remove Scheduled Interview</a> </li> </ul> </li> <li> <a href="#scorecards" class="toc-h1 toc-link" data-title="Scorecards">Scorecards</a> <ul class="toc-list-h2"> <li> <a href="#the-scorecard-object" class="toc-h2 toc-link" data-title="The scorecard object">The scorecard object</a> </li> <li> <a href="#get-list-scorecards" class="toc-h2 toc-link" data-title="GET: List Scorecards">GET: List Scorecards</a> </li> <li> <a href="#get-list-scorecards-for-application" class="toc-h2 toc-link" data-title="GET: List Scorecards for Application">GET: List Scorecards for Application</a> </li> <li> <a href="#get-retrieve-scorecard" class="toc-h2 toc-link" data-title="GET: Retrieve Scorecard">GET: Retrieve Scorecard</a> </li> </ul> </li> <li> <a href="#sources" class="toc-h1 toc-link" data-title="Sources">Sources</a> <ul class="toc-list-h2"> <li> <a href="#the-source-object" class="toc-h2 toc-link" data-title="The source object">The source object</a> </li> <li> <a href="#get-list-sources" class="toc-h2 toc-link" data-title="GET: List Sources">GET: List Sources</a> </li> </ul> </li> <li> <a href="#tags" class="toc-h1 toc-link" data-title="Tags">Tags</a> <ul class="toc-list-h2"> <li> <a href="#the-candidate-tag-object" class="toc-h2 toc-link" data-title="The candidate tag object">The candidate tag object</a> </li> <li> <a href="#get-list-candidate-tags" class="toc-h2 toc-link" data-title="GET: List Candidate Tags">GET: List Candidate Tags</a> </li> <li> <a href="#post-add-new-candidate-tag" class="toc-h2 toc-link" data-title="POST: Add New Candidate Tag">POST: Add New Candidate Tag</a> </li> <li> <a href="#delete-destroy-a-candidate-tag" class="toc-h2 toc-link" data-title="DELETE: Destroy a candidate tag">DELETE: Destroy a candidate tag</a> </li> <li> <a href="#get-list-tags-applied-to-candidate" class="toc-h2 toc-link" data-title="GET: List tags applied to candidate">GET: List tags applied to candidate</a> </li> <li> <a href="#delete-remove-tag-from-candidate" class="toc-h2 toc-link" data-title="DELETE: Remove tag from candidate">DELETE: Remove tag from candidate</a> </li> <li> <a href="#put-add-a-candidate-tag" class="toc-h2 toc-link" data-title="PUT: Add a candidate tag">PUT: Add a candidate tag</a> </li> </ul> </li> <li> <a href="#tracking-links" class="toc-h1 toc-link" data-title="Tracking Links">Tracking Links</a> <ul class="toc-list-h2"> <li> <a href="#the-tracking-link-object" class="toc-h2 toc-link" data-title="The tracking link object">The tracking link object</a> </li> <li> <a href="#json-schema" class="toc-h2 toc-link" data-title="JSON Schema">JSON Schema</a> </li> <li> <a href="#get-tracking-link-data-for-token" class="toc-h2 toc-link" data-title="GET: Tracking Link Data for Token">GET: Tracking Link Data for Token</a> </li> </ul> </li> <li> <a href="#users" class="toc-h1 toc-link" data-title="Users">Users</a> <ul class="toc-list-h2"> <li> <a href="#the-user-object" class="toc-h2 toc-link" data-title="The user object">The user object</a> </li> <li> <a href="#get-list-users" class="toc-h2 toc-link" data-title="GET: List Users">GET: List Users</a> </li> <li> <a href="#get-retrieve-user" class="toc-h2 toc-link" data-title="GET: Retrieve User">GET: Retrieve User</a> </li> <li> <a href="#patch-edit-user" class="toc-h2 toc-link" data-title="PATCH: Edit User">PATCH: Edit User</a> </li> <li> <a href="#patch-disable-user" class="toc-h2 toc-link" data-title="PATCH: Disable User">PATCH: Disable User</a> </li> <li> <a href="#patch-enable-user" class="toc-h2 toc-link" data-title="PATCH: Enable User">PATCH: Enable User</a> </li> <li> <a href="#patch-change-user-permission-level" class="toc-h2 toc-link" data-title="PATCH: Change user permission level">PATCH: Change user permission level</a> </li> <li> <a href="#post-add-user" class="toc-h2 toc-link" data-title="POST: Add User">POST: Add User</a> </li> <li> <a href="#post-add-e-mail-address-to-user" class="toc-h2 toc-link" data-title="POST: Add E-mail Address To User">POST: Add E-mail Address To User</a> </li> </ul> </li> <li> <a href="#user-permissions" class="toc-h1 toc-link" data-title="User Permissions">User Permissions</a> <ul class="toc-list-h2"> <li> <a href="#the-job-permission-object" class="toc-h2 toc-link" data-title="The job permission object">The job permission object</a> </li> <li> <a href="#get-list-job-permissions" class="toc-h2 toc-link" data-title="GET: List Job Permissions">GET: List Job Permissions</a> </li> <li> <a href="#delete-remove-a-job-permission" class="toc-h2 toc-link" data-title="DELETE: Remove a Job Permission">DELETE: Remove a Job Permission</a> </li> <li> <a href="#put-add-a-job-permission" class="toc-h2 toc-link" data-title="PUT: Add a Job Permission">PUT: Add a Job Permission</a> </li> <li> <a href="#the-future-job-permission-object" class="toc-h2 toc-link" data-title="The future job permission object">The future job permission object</a> </li> <li> <a href="#get-list-future-job-permissions" class="toc-h2 toc-link" data-title="GET: List Future Job Permissions">GET: List Future Job Permissions</a> </li> <li> <a href="#delete-remove-a-future-job-permission" class="toc-h2 toc-link" data-title="DELETE: Remove a Future Job Permission">DELETE: Remove a Future Job Permission</a> </li> <li> <a href="#put-add-a-future-job-permission" class="toc-h2 toc-link" data-title="PUT: Add a Future Job Permission">PUT: Add a Future Job Permission</a> </li> </ul> </li> <li> <a href="#user-roles" class="toc-h1 toc-link" data-title="User Roles">User Roles</a> <ul class="toc-list-h2"> <li> <a href="#the-user-role-object" class="toc-h2 toc-link" data-title="The user role object">The user role object</a> </li> <li> <a href="#get-list-user-roles" class="toc-h2 toc-link" data-title="GET: List User Roles">GET: List User Roles</a> </li> </ul> </li> </ul> <ul class="toc-appendage"> <li id="github_link"><a href="https://github.com/grnhse/greenhouse-api-docs/tree/master/source/includes/harvest" title="View on Github" target="_blank">View on GitHub</a></li> </ul> <ul class="toc-footer"> <li><a href='/assessment.html' title="Assessment API">Assessment API</a></li> <li><a href='/audit-log.html' title="Audit Log API">Audit Log API</a></li> <li><a href='/candidate-ingestion.html' title="Ingestion API">Ingestion API</a></li> <li><a href="/job-board.html" title="Job Board API">Job Board API</a></li> <li><a href='/gho.html' title="Onboarding API">Onboarding API</a></li> <li><a href='/webhooks.html' title="Webhooks">Webhooks</a></li> </ul> </div> <div class="page-wrapper"> <div class="dark-box"></div> <div class="content"> <h1 id='introduction'>Introduction</h1><div class="highlight"><pre class="highlight plaintext"><code> _ _ _ | |__ ___| | | ___ | '_ \ / _ \ | |/ _ \ | | | | __/ | | (_) | |_| |_|\___|_|_|\___/ _ __ _____ _ __| | __| | \ \ /\ / / _ \| '__| |/ _` | \ V V / (_) | | | | (_| | \_/\_/ \___/|_| |_|\__,_| </code></pre></div> 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... <ol> <li> Update candidate information.</li> <li> Add attachments to candidate profiles.</li> <li> Advance, move, and reject applications.</li> </ol> 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 <a href="https://github.com/grnhse/greenhouse-api-docs">GitHub repo</a> or fork it and contribute changes! <h2 id='authentication'>Authentication</h2> <blockquote> To authorize, use this code: </blockquote> <div class="highlight"><pre class="highlight ruby tab-ruby"><code>require 'base64' api_token = 'a7183e1b7e9ab09b8a5cfa87d1934c3c' credential = Base64.strict_encode64(api_token + ':') # => "YTcxODNlMWI3ZTlhYjA5YjhhNWNmYTg3ZDE5MzRjM2M6" headers = { "Authorization" => "Basic " + credential } </code></pre></div><div class="highlight"><pre class="highlight shell tab-shell"><code># 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 ... </code></pre></div> 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 is 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. <h3 id='authorization-header'>Authorization header</h3> <blockquote> Your <code>Authorization</code> header should look like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>Authorization: Basic YTcxODNlMWI3ZTlhYjA5YjhhNWNmYTg3ZDE5MzRjM2M6 </code></pre></div> Most HTTP clients will automatically use a given username and password to generate the required Authorization header. However, you may need to explicitly set this header. The header has the following format: <code>Authorization: Basic <base64("username:password")></code> Since only a username needs to be provided in our case, you'll need to append a <code>:</code> (colon) to your Greenhouse API token and then Base64 encode the resulting string. <aside class="success"> Important: Use HTTPS for all requests. Requests made over HTTP will always return an HTTP 403 response. Keep your API key a secret! </aside> <h3 id='setting-credentials-with-curl'>Setting credentials with cURL</h3> If you're making test API requests with cURL you can use the <code>-u</code> flag to set the username and password (which is blank). cURL will automatically generate the <code>Authorization</code> header. <h3 id='setting-permissions-for-api-keys'>Setting permissions for API Keys</h3> 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 the 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. <h2 id='rate-limiting'>Rate limiting</h2><div class="highlight"><pre class="highlight plaintext"><code>Status: 200 OK X-RateLimit-Limit: 50 X-RateLimit-Remaining: 49 </code></pre></div> Harvest API requests for approved Greenhouse partners and customer-built custom integrations are limited to the amount specified in the returned <code>X-RateLimit-Limit</code> header, per 10 seconds. Unlisted vendors may be subject to additional rate limits. Exceeding the limit will return an <code>HTTP 429</code> response. Status requests for approved integrations can be checked using the <code>X-RateLimit-Remaining</code> header. In the <code>HTTP 429</code> response, the <code>X-RateLimit-Reset</code> header is the timestamp indicating when you can try again while the <code>Retry-After</code> header is the number of seconds indicating when you can try again. <h2 id='pagination'>Pagination</h2> <blockquote> Example paging header </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>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" </code></pre></div> API methods that return a collection of results are always paginated. Paginated results will include a <code>Link</code> (see <a href="https://tools.ietf.org/html/rfc5988">RFC-5988</a>) response header with the following information. <ul> <li><code>next</code>. The corresponding URL is the link to the next page.</li> <li><code>prev</code>. The corresponding URL is the link to the previous page.</li> <li><code>last</code>. The corresponding URL is the link to the last page. Will not be returned if the query param <code>skip_count</code> is <code>true</code>.</li> </ul> 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 <code>next</code> link and is used by the following endpoints: <ul> <li><a href="#get-list-eeoc">GET: List EEOC</a></li> <li><a href="#get-list-user-roles">GET: List User Roles</a></li> <li><a href="#get-list-custom-fields">GET: List Custom Fields</a></li> <li><a href="#get-list-custom-field-options">GET: List Custom Field Options</a></li> <li><a href="#get-list-job-openings">GET: List Job Openings</a></li> <li><a href="#get-list-approvals-for-job">GET: List Approvals For Job</a></li> <li><a href="#get-pending-approvals-for-user">GET: Pending Approvals For User</a></li> <li><a href="#get-list-demographic-questions">GET: List Demographic Questions</a></li> <li><a href="#get-list-demographic-answer-options">GET: List Demographic Answer Options</a></li> <li><a href="#get-list-demographic-answer-options-for-demographic-question">GET: List Demographic Answer Options For Demographic Question</a></li> <li><a href="#get-list-demographic-answers">GET: List Demographic Answers</a></li> <li><a href="#get-list-demographic-answers-for-application">GET: List Demographic Answers for Application</a></li> </ul> <aside class="warning">Since paging mechanisms may differ per paginated endpoint and may change in the future, it is important to use the Link headers and not page manually by changing the paging-related query parameters.</aside> <h2 id='validation'>Validation</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "message": "Validation error", "errors": [ { "message": "Must be one of: candidate, prospect", "field": "type" } ] } </code></pre></div> Methods that take input will validate all parameters. Any parameter that fails validation will trigger an error response with status <code>HTTP 422</code>. The response body will be a JSON object that includes a message as well as a list of fields that failed validation. <h2 id='general-considerations'>General considerations</h2> Unless otherwise specified, API methods generally conform to the following: <ul> <li>Properties without a value will use <code>null</code> instead of being undefined</li> <li>"Snake Case" is used for attribute names (e.g. <code>first_name</code>)</li> <li>Timestamps are rendered in ISO-8601 format (e.g. `2016-02-03T16:38:46.985Z)</li> <li>URLs to external resources are valid for 7 days</li> <li>We reserve the right to add more properties to objects, but will never change or remove them</li> <li>Custom Fields on the <a href="#applications">application object</a> are only available to customers with Enterprise-level accounts</li> <li>Resumes, cover letters, and other document attachments in Greenhouse are hosted on Amazon Web Services and are provided via signed, temporary URLs. Due to the ephemeral nature of these resource links, users should download these documents immediately after the request is made and should not rely on these URLs to be available for future requests. In the event AWS S3 is experiencing issues, document attachments will not be available in Harvest.</li> </ul> <h2 id='errors'>Errors</h2> <table><thead> <tr> <th>Error Code</th> <th>Meaning</th> </tr> </thead><tbody> <tr> <td>401</td> <td>Unauthorized – Ensure you’re using a valid Harvest API key with the correct permissions in the <code>Authorization</code> header (Basic Auth).</td> </tr> <tr> <td>403</td> <td>Forbidden -- You don't have access to that record.</td> </tr> <tr> <td>404</td> <td>Not Found -- Resource not found.</td> </tr> <tr> <td>422</td> <td>Not processed – We're not able to process your request. Validate your parameters.</td> </tr> <tr> <td>429</td> <td>Rate limit exceeded – You're being <a href="https://developers.greenhouse.io/harvest.html#throttling">throttled</a> for exceeding our rate limit.</td> </tr> <tr> <td>500</td> <td>Server error – We're having a problem with our server. Give us a few minutes and try again, or check <a href="https://status.greenhouse.io/">our status page</a></td> </tr> </tbody></table> <h2 id='harvest-change-log'>Harvest Change Log</h2> The timestamps below are Eastern Time. <table><thead> <tr> <th>Date</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>Nov 6, 2024</td> <td>Updated <a href="#post-add-application-to-candidate-prospect">Add Candidate Application</a> link on <a href="#post-add-prospect">POST: Add Prospect</a> description.</td> </tr> <tr> <td>Oct 7, 2024</td> <td>Updated favicon, github mark, and color palette. Fixed typos and formatting errors.</td> </tr> <tr> <td>Aug 7, 2024 7:00:00AM</td> <td>Replaced 'web hook' with webhook</td> </tr> <tr> <td>Jul 10, 2024 7:00:00AM</td> <td>Updated <a href="#the-job-object">The job object</a> <code>openings[].opened_at</code> and <a href="#job-openings">The job opening object</a> <code>opened_at</code> param descriptions</td> </tr> <tr> <td>Jul 9, 2024 9:00:00AM</td> <td>Updated <a href="#post-reject-application">POST: Reject Application</a> <code>rejection_email.send_email_at</code> param documentation to indicate the time zone</td> </tr> <tr> <td>Jun 8, 2024 3:10:00PM</td> <td>Add ability to update custom fields in rejection details to <a href="#patch-update-application">PATCH: Update Application</a></td> </tr> <tr> <td>Jun 13, 2024 5:00:00PM</td> <td>Updated <a href="#pagination">Introduction - Pagination</a> <code>last</code> param, and all list endpoint documentation using old pagination to include <code>skip_count</code> param</td> </tr> <tr> <td>Jun 13, 2024 5:00:00PM</td> <td>Updated <a href="#pagination">Introduction - Pagination</a> <code>last</code> param, and all list endpoint documentation using old pagination to include <code>skip_count</code> param</td> </tr> <tr> <td>Apr 12, 2024 9:30:00AM</td> <td>Updated sample response in the <a href="#get-list-offices">GET: List Offices</a> and <a href="#get-retrieve-office">GET: Retrieve Office</a> documentation</td> </tr> <tr> <td>Mar 25, 2024 9:15:00AM</td> <td>Updated <code>job_id</code> description in the <a href="#get-list-candidates">GET: List Candidates</a> section</td> </tr> <tr> <td>Mar 21, 2024 3:15:00PM</td> <td>Updated description in the <a href="#rate-limiting">Rate-Limiting</a> section</td> </tr> <tr> <td>Feb 23 2024 1:00:00PM</td> <td>Updated description of the application parameter in the <a href="#post-add-prospect">POST: Add Prospect</a> documentation</td> </tr> <tr> <td>Dec 11, 2023 4:00:00PM</td> <td>Added a Note to <a href="#patch-update-current-offer">PATCH: Update Current Offer</a> documentation</td> </tr> <tr> <td>Nov 15, 2023 12:45:00PM</td> <td>Added <code>job_post_custom_location_id</code> field to Job Post response object and updated sample response</td> </tr> <tr> <td>Nov 13, 2023 11:09:00AM</td> <td>Update error status code message.</td> </tr> <tr> <td>Oct 30, 2023 3:20:00PM</td> <td>Removed language indicating <a href="#put-anonymize-candidate">PUT: Anonymize Candidate</a> is restricted to Expert Tier</td> </tr> <tr> <td>Oct 12, 2023 2:15:00PM</td> <td>Updated Throttling section to Rate limiting and updated description</td> </tr> <tr> <td>Aug 22, 2023 3:00:00PM</td> <td>Included <code>active</code> attribute in the <a href="#the-job-stage-object">Job Stage Object</a></td> </tr> <tr> <td>Aug 22, 2023 3:00:00PM</td> <td>Fixed URL expiry timing in <a href="#general-considerations">General Considerations</a> and the <a href="#the-candidate-object">Candidate Object</a></td> </tr> <tr> <td>May 15, 2023 12:00:00PM</td> <td>Added ability to update closed openings in the <a href="#patch-edit-openings">Edit Openings Endpoint</a></td> </tr> <tr> <td>April 12, 2023 3:00:00PM</td> <td>Modified format of request links for <a href="#post-scheduled-interviews">POST: Scheduled Interviews</a> and <a href="#patch-scheduled-interviews">PATCH: Scheduled Interviews</a>.</td> </tr> <tr> <td>March 7, 2023 10:00:00AM</td> <td>Modified <code>intenal</code> querystring parameter on <a href="#job-posts">job post</a> GET requests to work in the reverse manner. When included in a request and set to <code>false</code>, the response will only include external job posts.</td> </tr> <tr> <td>February 28, 2023 12:00:00PM</td> <td>Added <code>internal</code> querystring parameter to <a href="#job-posts">job post</a> GET requests to return only internal job posts. When included in a request and set to <code>true</code>, the response will only include internal job posts.</td> </tr> <tr> <td>November 21, 2022 12:00:00PM</td> <td>Deprecated version 1 of the <a href="#delete-destroy-openings">DELETE: Destroy Openings</a> endpoint. Only v2 is available going forward.</td> </tr> <tr> <td>November 9, 2022 04:00:00PM</td> <td>The <code>full_content</code> querystring parameter has been modified on <a href="#job-posts">job post</a> GET requests to return Pay Transparency ranges (if present). When included in a request, the "content" or "internal_content" fields will return a concatenated string that includes the Board-level introduction, the Post-level description, pay transparency ranges, and the Board-level conclusion.</td> </tr> <tr> <td>October 18, 2022 12:00:00PM</td> <td>Added ability to create and update User Attributes to the <a href="#users">Users</a> endpoints</td> </tr> <tr> <td>September 22, 2022 12:00:00PM</td> <td>Updated <a href="#delete-destroy-openings">DELETE: Destroy Openings</a> to a v2 endpoint. The v1 endpoint will be deprecated in a future release. Users and partners should switch over to the v2 endpoint as soon as possible to avoid issues with your integration.</td> </tr> <tr> <td>September 12, 2022 12:00:00PM</td> <td>Added <code>created_at</code> field for application's attachments object.</td> </tr> <tr> <td>September 9, 2022 12:00:00PM</td> <td>Added <a href="#patch-convert-prospect-to-candidate">PATCH: Convert Prospect To Candidate</a> endpoint to allow conversion of a prospect application to a candidate application on a selected job.</td> </tr> <tr> <td>August 1, 2022 12:00:00PM</td> <td>Making <code>content_type</code> required for attachments unless uploading using a URL.</td> </tr> <tr> <td>May 18, 2021 12:00:00PM</td> <td>Added <code>video_conferencing_url</code> to Scheduled Interview object.</td> </tr> <tr> <td>May 3, 2021 05:00:00PM</td> <td>Added <code>priority</code> to Job Stages object.</td> </tr> <tr> <td>May 3, 2021 04:00:00PM</td> <td>Added <code>job_post_id</code> field to application's response object.</td> </tr> <tr> <td>April 21, 2021 11:00:00AM</td> <td>Added ability to change external_id for custom field options.</td> </tr> <tr> <td>April 13, 2021 01:00:00PM</td> <td>Added ability to change user permission level to basic.</td> </tr> <tr> <td>September 28, 2020 12:00:00PM</td> <td>"Required" field added to Demographic Questions.</td> </tr> <tr> <td>September 23, 2020 03:00:00PM</td> <td>Attachments have been added at the application level. Previously, an aggregation of all attachments on all applications was included at the candidate level and not at all in the applications endpoint. Now, the applications endpoint includes attachments specific to each application and the candidates endpoint includes attachments in each application specific to that application.</td> </tr> <tr> <td>September 10, 2020 05:00:00PM</td> <td>A new querystring parameter has been added to <a href="#job-posts">job post</a> GET requests to return Board-level Introductions and Conclusions (if present). When included in a request, the "content" or "internal_content" fields will return a concatenated string that includes the Board-level introduction, the Post-level description, and the Board-level conclusion.</td> </tr> <tr> <td>May 28, 2020 05:00:00PM</td> <td>Candidate photos have been removed from Greenhouse and will no longer be accepted as a field to be anonymized in <a href="#put-anonymize-candidate">PUT Anonymize Candidates</a></td> </tr> <tr> <td>May 5, 2020 12:00:00PM</td> <td>Added "interview_step" field to the scorecards response. This provides the "ID" of the existing "interview" field. The "name" sub-element of the "interview_step" element should match the current "interview" element. The "interview" field is maintained for backward compatibility.</td> </tr> <tr> <td>Apr 22, 2020 09:00:00AM</td> <td>Added external_id as field to the <a href="#the-custom-field-options-object">Custom Field Option object</a>.</td> </tr> <tr> <td>Apr 13, 2020 09:00:00AM</td> <td>The V1 endpoints for [PATCH: Edit User], [PATCH: Disable User], and [PATCH: Enable User] have been deprecated. Users should move to the V2 endpoints as soon as convenient. This change was made to take advantage of additional ways to look up users in Greenhouse.</td> </tr> <tr> <td>Apr 12, 2020 09:00:00AM</td> <td>V1 of [PATCH: Update Job Post] has been deprecated. Updating a job post's status has been extracted to [PATCH: Update Job Post Status], while updating all other properties remains on [PATCH: Update Job Post]. The new endpoint more accurately reflects the permissions required by the On-Behalf-Of user to access and edit the Job Post's properties.</td> </tr> <tr> <td>Apr 5, 2020 09:00:00AM</td> <td>Added V2 of <a href="#post-scheduled-interviews">POST: Scheduled Interviews</a> and <a href="#patch-scheduled-interviews">PATCH: Scheduled Interviews</a>. Deprecated V1.</td> </tr> <tr> <td>Jan 30, 2020 05:30:00PM</td> <td>Added ability to update custom field values in a <a href="#patch-edit-openings">PATCH: Job Openings</a> request</td> </tr> <tr> <td>Jan 30, 2020 05:30:00PM</td> <td>Added ability to re-open a closed job opening in a <a href="#patch-edit-openings">PATCH: Job Openings</a> request</td> </tr> <tr> <td>Jan 15, 2020 04:00:00PM</td> <td>Added ability to update a rejection reason on a rejected application. <a href="#patch-update-rejection-reason">PATCH: Update Rejection Reason</a></td> </tr> <tr> <td>Dec 20, 2019 04:00:00PM</td> <td>Added ability to assign custom field values in a <a href="#post-create-new-openings">POST: Job Openings</a> request</td> </tr> <tr> <td>Nov 26, 2019 11:00:00 AM</td> <td>Updated the error response text to be more descriptive when attempting to delete a required custom field</td> </tr> <tr> <td>Nov 26, 2019 11:00:00 AM</td> <td>Added ability to update custom fields on an application's current offer via <a href="#patch-update-current-offer">PATCH: Update Current Offer</a></td> </tr> <tr> <td>Nov 12, 2019 10:00:00 AM</td> <td>Added a v2 version of <a href="#patch-edit-user-v2">PATCH: Edit User</a>, <a href="#patch-disable-user-v2">PATCH: Disable User</a>, and <a href="#patch-enable-user-v2">PATCH: Enable User</a></td> </tr> <tr> <td>Oct 7, 2019 03:00:00 PM</td> <td>Added custom fields to openings on organizations with this option enabled. <a href="#get-list-job-openings">GET: Openings</a></td> </tr> <tr> <td>Oct 1, 2019 11:00:00AM</td> <td>Added ability to filter offers by start_date with starts_before and starts_after. <a href="#get-list-offers">GET: Offers</a></td> </tr> <tr> <td>Sep 18, 2019 01:00:00PM</td> <td>Added ability to create prospect applications for existing candidates/prospects <a href="#post-add-application-to-candidate-prospect">POST: Add Application to Candidate/Prospect</a></td> </tr> <tr> <td>Aug 12, 2019 05:00:00PM</td> <td>Prospect post data will return in Job Posts endpoints.</td> </tr> <tr> <td>Jul 31, 2019 01:00:00PM</td> <td>Added ability to filter demographic data answers by created_at and updated_at dates <a href="#get-list-demographic-answers">GET: Demographic Answers</a></td> </tr> <tr> <td>Jul 17, 2019 01:00:00PM</td> <td>Added ability to update the current offer on an application via <a href="#patch-update-current-offer">PATCH: Update Current Offer</a></td> </tr> <tr> <td>Jul 17, 2019 01:00:00PM</td> <td>Added ability to post new attachments to applications via <a href="#post-add-attachment-to-application">POST: Add Attachment to Application</a></td> </tr> <tr> <td>Jun 26, 2019 12:00:00PM</td> <td>Added ability to create new Offices linked by external parent ids to <a href="#post-add-office">POST: Add Office</a>.</td> </tr> <tr> <td>Jun 26, 2019 12:00:00PM</td> <td>Added ability to create new Departments linked by external parent ids to <a href="#post-add-department">POST: Add Department</a>.</td> </tr> <tr> <td>Jun 26, 2019 12:00:00PM</td> <td>Added child and parent office external IDs to the <a href="#the-office-object">Office object</a>.</td> </tr> <tr> <td>Jun 26, 2019 12:00:00PM</td> <td>Added child and parent department external IDs to the <a href="#the-department-object">Department object</a>.</td> </tr> <tr> <td>Jun 12, 2019 02:00:00PM</td> <td>Added <code>prospective_department</code> and <code>prospective_office</code> to the <a href="#the-application-object">Application object</a>.</td> </tr> <tr> <td>Jun 7, 2019 02:00:00PM</td> <td>Added default interviewers and estimated duration to the <a href="#the-job-stage-object">Job Stage object</a></td> </tr> <tr> <td>May 24, 2019 01:00:00PM</td> <td>Added ability to set location on job posts via office and custom location id via <a href="#patch-update-job-post">PATCH: Update Job Post</a></td> </tr> <tr> <td>May 24, 2019 01:00:00PM</td> <td>Added <code>schedulable</code> field to <a href="#job-stages">Job Stages Endpoints</a></td> </tr> <tr> <td>May 24, 2019 01:00:00PM</td> <td>Added <code>first_published_at</code> field to <a href="#job-posts">Job Posts Endpoints</a></td> </tr> <tr> <td>May 15, 2019 05:00:00PM</td> <td>Added ability to change prospect pool and stage via <a href="#patch-update-application">PATCH: Update Application</a></td> </tr> <tr> <td>May 15, 2019 03:15:00PM</td> <td>Added <code>opening</code> field to <a href="#offers">Offers</a>.</td> </tr> <tr> <td>May 7, 2019 03:30:00PM</td> <td>Added <a href="#demographic-data">Demographic Data endpoints</a></td> </tr> <tr> <td>Apr 8 , 2019 04:00:00PM</td> <td>Added <code>interviewer</code> to <a href="#the-scorecard-object">Scorecard object</a></td> </tr> <tr> <td>Mar 18, 2019 03:30:00PM</td> <td>Added ability to delete a Candidate Tag via <a href="#delete-destroy-a-candidate-tag">DELETE: Destroy a Candidate Tag</a></td> </tr> <tr> <td>Mar 6, 2019 02:15:00PM</td> <td>Added <code>linked_candidate_ids</code> to <a href="#users">Users Endpoints</a></td> </tr> <tr> <td>Feb 28, 2019 02:34:00PM</td> <td>Added <code>primary_email_address</code> to <a href="#users">Users Endpoints</a></td> </tr> <tr> <td>Feb 28, 2019 12:30:00PM</td> <td>Added <code>updated_at</code> to <a href="#jobs">Jobs Endpoints</a></td> </tr> <tr> <td>Feb 13, 2019 03:30:00PM</td> <td>Added ability to create new candidate tags via <a href="#post-add-new-candidate-tag">POST: Add New Candidate Tag</a></td> </tr> <tr> <td>Feb 1, 2019 11:28:00AM</td> <td>Added partial response (HTTP Status code 202) to <a href="#post-create-job">POST: Create Job</a></td> </tr> <tr> <td>Jan 8, 2019 12:00:00PM</td> <td>Added <code>can_email</code> flag to <a href="#the-candidate-object">Candidates Endpoints</a></td> </tr> </tbody></table> <h1 id='activity-feed'>Activity Feed</h1><h2 id='the-activity-feed-object'>The activity feed object</h2> The activity feed is the list of activities on a candidate's profile, including interviews, notes, and emails. <div class="highlight"><pre class="highlight json tab-json"><code>{ "notes": [ { "id": 123456, "created_at": "2014-03-26T20:11:40Z", "body": "Very mysterious.", "user": { "id": 512, "first_name": "Sayid", "last_name": "Jarrah", "name": "Sayid Jarrah", "employee_id": "12345" }, "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": "sam.smith@example.com", "user": { "id": 214, "first_name": "Boone", "last_name": "Carlyle", "name": "Boone Carlyle", "employee_id": "67890" } } ], "activities": [ { "id": 6756789, "created_at": "2014-04-01T15:55:29Z", "subject": "Candidate Rejected", "body": "Reason: Lacking hustle\n\nThis candidate turned out to be problematic for us...", "user": { "id": 214, "first_name": "Boone", "last_name": "Carlyle", "name": "Boone Carlyle", "employee_id": "67890" } }, { "id": 6757869, "created_at": "2014-03-26T20:26:38Z", "subject": "Candidate Stage Change", "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": "67890" } } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The internal Greenhouse ID of the activity feed note.</td> </tr> <tr> <td>note</td> <td>An array of notes associated with this candidate.</td> </tr> <tr> <td>email</td> <td>An array of emails sent to and from this candidate.</td> </tr> <tr> <td>activity</td> <td>An array of events associated with this candidate.</td> </tr> <tr> <td>visibility*</td> <td>The visibility setting on the note. One of <code>admin_only</code>, <code>public</code>, or <code>private</code>.</td> </tr> </tbody></table> * - Due to a legacy typo, the response includes the same value as <code>visiblity</code>. It is safe to ignore this value, but it is maintained for backward compatibility. <h2 id='get-retrieve-activity-feed'>GET: Retrieve Activity Feed</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "notes": [ { "id": 12345, "created_at": "2014-03-26T20:11:40Z", "body": "Very mysterious.", "user": { "id": 512, "first_name": "Sayid", "last_name": "Jarrah", "name": "Sayid Jarrah", "employee_id": "12345" }, "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": "sam.smith@example.com", "user": { "id": 214, "first_name": "Boone", "last_name": "Carlyle", "name": "Boone Carlyle", "employee_id": "67890" } } ], "activities": [ { "id": 6756789, "created_at": "2014-04-01T15:55:29Z", "subject": "Candidate Rejected", "body": "Reason: Lacking hustle\n\nThis candidate turned out to be problematic for us...", "user": { "id": 214, "first_name": "Boone", "last_name": "Carlyle", "name": "Boone Carlyle", "employee_id": "67890" } }, { "id": 6757869, "created_at": "2014-03-26T20:26:38Z", "subject": "Candidate Stage Change", "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": "67890" } } ] } </code></pre></div> Retrieve a candidate's activity feed. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the candidate whose activity feed you want to retrieve.</td> </tr> </tbody></table> <a href="#the-activity-feed-object">See noteworthy response attributes.</a> <h1 id='applications'>Applications</h1><h2 id='the-application-object'>The application object</h2> Applications associate <a href="#candidates">candidates</a> with <a href="#jobs">jobs</a>. There are 2 kinds of applications: candidates and prospects. Candidate applications always have exactly 1 job. Prospect applications can have 0 or more jobs. <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 1871, "public_name": "Happy Hour" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": { "id": 8, "name": "Lacking skill(s)/qualification(s)", "type": { "id": 1, "name": "We rejected them" } }, "rejection_details": { "custom_fields": { "custom_rejection_question_field": "Not a good fit" }, "keyed_custom_fields": { "custom_rejection_question_field": { "name": "Was this candidate a good fit?", "type": "short_text", "value": "Not a good fit." } } }, "jobs": [ { "id": 123, "name": "Accounting Manager" } ], "job_post_id": 123, "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." } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>Application ID</td> </tr> <tr> <td>prospect</td> <td>If <code>true</code>, this is a prospect application which means that the associated person is a prospect and has not yet applied for this job.</td> </tr> <tr> <td>status</td> <td>One of: <code>active</code>, <code>rejected</code>, <code>hired</code>, <code>converted</code>.</td> </tr> <tr> <td>jobs</td> <td>An array containing the <a href="#jobs">job</a> that the candidate applied for.</td> </tr> <tr> <td>job_post_id</td> <td>The ID of the job post through which the candidate applied. This value is null if the application was created through other means, e.g. manually adding candidates or importing candidates through sourcing integrations</td> </tr> <tr> <td>candidate_id</td> <td>The ID of the <a href="#candidates">candidate</a> who is applying for this job.</td> </tr> <tr> <td>current_stage</td> <td>The current <a href="#job-stages">stage</a> that this application is in.</td> </tr> <tr> <td>credited_to.id</td> <td>The ID of the user who will receive credit for this application.</td> </tr> <tr> <td>location</td> <td>The contents of the location question on a job post.</td> </tr> <tr> <td>answers</td> <td>The answers provided to the questions in the job post for this application. Array contains the text value of the question and answer. Answers are always plaintext strings. Booleans will return <code>Yes</code> or <code>No</code>.</td> </tr> <tr> <td>custom_fields</td> <td>Contains a hash of the custom fields configured for this resource. The properties in this hash reflect the active custom fields as of the time this method is called.</td> </tr> <tr> <td>keyed_custom_fields</td> <td>This contains the same information as custom_fields but formatted in a different way that includes more information. This will tell you the type of custom field data to expect, the text name of custom field, and the value. The key of this hash is the custom field's immutable field key, which will not change even if the name of the custom field is changed in Greenhouse.</td> </tr> <tr> <td>prospective_department</td> <td>The <a href="#the-department-object">department</a> that this prospect application is being considered for.</td> </tr> <tr> <td>prospective_office</td> <td>The <a href="#the-office-object">office</a> that this prospect application is being considered for.</td> </tr> </tbody></table> <h2 id='get-list-applications'>GET: List Applications</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X GET 'https://harvest.greenhouse.io/v1/applications' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 2, "public_name": "Jobs page on your website" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 107761, "name": "UX Designer - Boston" } ], "job_post_id": 123, "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" } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] }, { "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", "location": null, "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 " } ], "job_post_id": null, "status": "hired", "current_stage": null, "answers": [ { "question": "How did you hear about this job?", "answer": "Online Research" }, { "question": "Website", "answer": "mytestwebsite.com" } ], "prospective_office": { "primary_contact_user_id": null, "parent_id": null, "name": "New York", "location": { "name": "New York, NY" }, "id": 59213, "external_id": null, "child_ids": [] }, "prospective_department": { "parent_id": null, "name": "Marketing", "id": 9024, "external_id": null, "child_ids": [] }, "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": "Option 1" }, "keyed_custom_fields": { "application_custom_test": { "name": "Application Custom Test", "type": "single_select", "value": "Option 1" } }, "attachments": [ { "filename": "Jack_Smith_Offer_Packet_09_27_2020.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } ] </code></pre></div> List all of an organization's applications. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving applications will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only applications that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only applications that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>last_activity_after</td> <td>Return only applications where 'last_activity_at' is at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>job_id</td> <td>If supplied, only return applications that involve this job. Will return both candidates and prospects.</td> </tr> <tr> <td>status</td> <td>If supplied, only return applications that match this status. Accepted values are active, converted, hired, and rejected. If anything else is used, an empty response will be returned rather than an error.</td> </tr> </tbody></table> <a href="#the-application-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-application'>GET: Retrieve Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X GET 'https://harvest.greenhouse.io/v1/applications/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 2, "public_name": "Jobs page on your website" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 107761, "name": "UX Designer - Boston" } ], "job_post_id": 123, "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" } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> Retrieve an application by its <code>id</code>. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications/{id}</code> <h3 id='url-parameters'>URL parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the application to retrieve</td> </tr> </tbody></table> <a href="#the-application-object">See noteworthy response attributes.</a> <h2 id='delete-delete-application'>DELETE: Delete Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/applications/{id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "message": "Application 29622362 has been deleted." } </code></pre></div> Delete an application by <code>id</code>. Note that only candidate applications can be deleted, you cannot delete a prospect application. <h3 id='http-request-3'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/applications/{id}</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <a href="#the-candidate-object">See noteworthy response attributes.</a> <h2 id='post-add-application-to-candidate-prospect'>POST: Add Application to Candidate/Prospect</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/applications' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> To create a prospect application for jobs 123 and 456: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "prospect": "true", "job_ids": [123, 456], "prospective_office_id": 58319, "prospective_department_id": 9021, "prospect_pool_id": 1640, "prospect_pool_stage_id": 7594, "prospect_owner_id": 107468 } </code></pre></div> <blockquote> To create a prospect application on no jobs: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "prospect": "true" } </code></pre></div> <blockquote> To create a candidate application: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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" } ] } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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" } ], "job_post_id": null, "status": "active", "current_stage": { "id": 1945557, "name": "Application Review" }, "answers": [], "custom_fields": { "birthday": "1992-01-27", "bio": "This is my bio" }, "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null } } </code></pre></div> Create a new application for an existing candidate or prospect. The new application can be a candidate application or a prospect application, depending on the <code>"prospect"</code> parameter which defaults to <code>"false"</code>. The JSON body parameters differ depending on whether you are creating a prospect application or a candidate application. The main difference is that prospect applications can be considered for zero, one, or multiple jobs. <h3 id='http-request-4'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/candidates/{id}/applications</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-for-candidate-application'>JSON Body Parameters for Candidate application</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job you want to create an application to for this candidate</td> </tr> <tr> <td>source_id</td> <td>No</td> <td>integer</td> <td>The id of the source to be credited for this application</td> </tr> <tr> <td>initial_stage_id</td> <td>No</td> <td>integer</td> <td>The ID of the job stage this application will be created in.</td> </tr> <tr> <td>referrer</td> <td>No</td> <td>object</td> <td>An object representing the referrer</td> </tr> <tr> <td>referrer[type]</td> <td>No</td> <td>string</td> <td>A string representing the type of referrer: 'id', 'email', or 'outside'</td> </tr> <tr> <td>referrer[value]</td> <td>No</td> <td>string</td> <td>The id of the user who made the referral (not the referrer id)</td> </tr> <tr> <td>attachments</td> <td>No</td> <td>array</td> <td>An array of attachments to be uploaded to this application. See <a href="#post-add-attachment">Add Attachment</a> for parameters.</td> </tr> </tbody></table> <h3 id='json-body-parameters-for-prospect-application'>JSON Body Parameters for Prospect application</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>prospect</td> <td>Yes</td> <td>boolean</td> <td>Set to <code>"true"</code> in order to create a prospect application.</td> </tr> <tr> <td>job_ids</td> <td>No</td> <td>array</td> <td>An optional array of Job IDs to consider this prospect for.</td> </tr> <tr> <td>source_id</td> <td>No</td> <td>integer</td> <td>The id of the source to be credited for this application</td> </tr> <tr> <td>referrer</td> <td>No</td> <td>object</td> <td>An object representing the referrer</td> </tr> <tr> <td>referrer[type]</td> <td>No</td> <td>string</td> <td>A string representing the type of referrer: 'id', 'email', or 'outside'</td> </tr> <tr> <td>referrer[value]</td> <td>No</td> <td>string</td> <td>The id of the user who made the referral (not the referrer id)</td> </tr> <tr> <td>prospect_pool_id</td> <td>No</td> <td>integer</td> <td>Prospect Pool ID.</td> </tr> <tr> <td>prospect_pool_stage_id</td> <td>No</td> <td>integer</td> <td>Prospect Pool Stage ID. <code>prospect_pool_id</code> is required, and the prospect pool stage must belong to the given prospect pool.</td> </tr> <tr> <td>prospect_owner_id</td> <td>No</td> <td>integer</td> <td>User ID of the prospect owner.</td> </tr> <tr> <td>prospective_department_id</td> <td>No</td> <td>integer</td> <td>Department ID to consider this prospect for.</td> </tr> <tr> <td>prospective_office_id</td> <td>No</td> <td>integer</td> <td>Office ID to consider this prospect for. <code>prospective_department_id</code> is required in order to set a prospective office.</td> </tr> </tbody></table> <h2 id='patch-update-application'>PATCH: Update Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/applications/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "source_id": 16, "referrer": { "type": "id", "value": 123 } } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 2, "public_name": "Jobs page on your website" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 107761, "name": "UX Designer - Boston" } ], "job_post_id": 123, "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" } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> 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 <code>active</code>, <code>rejected</code>, or <code>hired</code>. <h3 id='http-request-5'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/applications/{id}</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>source_id</td> <td>No</td> <td>integer</td> <td>The ID of the application's source</td> </tr> <tr> <td>referrer</td> <td>No</td> <td>object</td> <td>An object representing the referrer</td> </tr> <tr> <td>referrer[type]</td> <td>No</td> <td>string</td> <td>A string representing the type of referrer: 'id', 'email', or 'outside'</td> </tr> <tr> <td>referrer[value]</td> <td>No</td> <td>string</td> <td>The id of the user who made the referral (not the referrer id)</td> </tr> <tr> <td>custom_fields[]</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new application custom field values. Passing an empty array does nothing. <a href="#custom-field-parameters">Click here</a> for more information on structuring custom field data for edit requests.</td> </tr> <tr> <td>prospect_pool_id</td> <td>No</td> <td>integer</td> <td>The ID of the prospect pool for the application</td> </tr> <tr> <td>prospect_stage_id</td> <td>No</td> <td>integer</td> <td>The ID of the prospect pool stage for the application</td> </tr> <tr> <td>rejection_details</td> <td>No</td> <td>object</td> <td>An object representing the rejection details of a rejected application. Note: Rejection details can't be updated if the application has not been rejected.</td> </tr> <tr> <td>rejection_details[custom_fields[]]</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new rejection detail custom field values. Passing an empty array does nothing. <a href="#custom-field-parameters">Click here</a> for more information on structuring custom field data for edit requests.</td> </tr> </tbody></table> <h2 id='post-advance-application'>POST: Advance Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/advance' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "from_stage_id": 123 } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 2, "public_name": "Jobs page on your website" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 107761, "name": "UX Designer - Boston" } ], "job_post_id": null, "status": "active", "current_stage": { "id": 456, "name": "Phone Interview" }, "answers": [ { "question": "How did you hear about this job?", "answer": "Online Research" }, { "question": "Website", "answer": "mytestwebsite.com" } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> 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 <code>active</code> state can be advanced. <h3 id='http-request-6'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/applications/{id}/advance</code> <h3 id='headers-4'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>from_stage_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job stage this application is currently in.</td> </tr> </tbody></table> <h2 id='post-move-application-different-job'>POST: Move Application (Different Job)</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/transfer_to_job' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "new_job_id": 123456, "new_stage_id": 234567 } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 2, "public_name": "Jobs page on your website" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 123456, "name": "UX Designer - Boston" } ], "job_post_id": null, "status": "active", "current_stage": { "id": 234567, "name": "Application Review" }, "answers": [ { "question": "How did you hear about this job?", "answer": "Online Research" }, { "question": "Website", "answer": "mytestwebsite.com" } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> 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. <h3 id='http-request-7'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/applications/{id}/transfer_to_job</code> <h3 id='headers-5'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-3'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>new_job_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job to which this application should be transferred</td> </tr> <tr> <td>new_stage_id</td> <td>No</td> <td>integer</td> <td>The 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</td> </tr> </tbody></table> <a href="#the-application-object">See noteworthy response attributes.</a> <h2 id='post-move-application-same-job'>POST: Move Application (Same Job)</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/move' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "from_stage_id": 1, "to_stage_id": 2 } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 33, "public_name": "Glassdoor" }, "credited_to": null, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 211706, "name": "Community Manager - New York" } ], "job_post_id": 123, "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" } ], "prospective_office": null, "prospective_department": null, "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 } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> 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 <code>active</code> state can be moved. <h3 id='http-request-8'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/applications/{id}/move</code> <h3 id='headers-6'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-4'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>from_stage_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job stage this application is currently in.</td> </tr> <tr> <td>to_stage_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job stage this application should be moved to.</td> </tr> </tbody></table> <a href="#the-application-object">See noteworthy response attributes.</a> <h2 id='patch-convert-prospect-to-candidate'>PATCH: Convert Prospect To Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/applications/{id}/convert_prospect' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "job_id": 123456, "initial_stage_id": 234567 } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true, "old_application_id": 1234321, "new_application_id": 43234323, "new_job_id": 123456, "new_stage_id": 234567 } </code></pre></div> Converts a prospect application to a candidate on a job. If a non-prospect application is provided, an error will be returned. <h3 id='http-request-9'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/applications/{id}/convert_prospect</code> <h3 id='headers-7'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-5'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job this prospect will become a candidate on.</td> </tr> <tr> <td>initial_stage_id</td> <td>No</td> <td>integer</td> <td>The 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</td> </tr> </tbody></table> <h2 id='post-add-attachment-to-application'>POST: Add Attachment to Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/attachments' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "filename" : "resume.pdf", "type" : "resume", "content" : "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs...", "content_type" : "application/pdf" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "filename": "resume.pdf", "url": "https://prod.s3.amazonaws.com/...", "type": "resume", "content_type": "application/pdf" } </code></pre></div> Post an attachment to an application by the application <code>id</code>. <h3 id='http-request-10'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/applications/{id}/attachments</code> <h3 id='headers-8'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-6'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>filename</td> <td>Yes</td> <td>string</td> <td>Name of the file</td> </tr> <tr> <td>type</td> <td>Yes</td> <td>string</td> <td>One of: ["resume", "cover_letter", "other", "take_home_test", "offer_letter", "signed_offer_letter"]. For type <code>take_home_test</code>, there must be an outstanding test on the application. For type <code>offer_letter</code>, there must be an existing offer on the application, and this action will retrigger the approvals process. For type <code>signed_offer_letter</code>, there must be an approved, sent offer letter.</td> </tr> <tr> <td>content</td> <td>No</td> <td>string</td> <td>Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.</td> </tr> <tr> <td>url</td> <td>No</td> <td>string</td> <td>Url of the attachment (if you are providing the url, you do not need to provide the content.) Please note, shareable links from cloud services such as Google Drive will result in a corrupted file. Please use machine-accessible URLs.</td> </tr> <tr> <td>visibility</td> <td>No</td> <td>string</td> <td>One of: ["public", "private", "admin_only"]. This only applies when attachment type is "other", and will be ignored for all other attachment types. If not supplied, type "other" documents will default to <code>admin_only</code>. Resumes, cover letters, and take home tests will always be <code>public</code>. Offer letters and signed offer letters will always be <code>private</code>.</td> </tr> <tr> <td>content_type</td> <td>Yes*</td> <td>string</td> <td>The 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: <ul><li>"application/atom+xml"</li><li>"application/javascript"</li><li>"application/json"</li><li>"application/msgpack"</li><li>"application/msword"</li><li>"application/pdf"</li><li>"application/rss+xml"</li><li>"application/vnd.ms-excel"</li><li>"application/vnd.openxmlformats- officedocument.spreadsheetml.sheet"</li><li>"application/vnd.openxmlformats- officedocument.wordprocessingml.document"</li><li>"application/vnd.ms-powerpoint"</li><li>"application/xml"</li><li>"application/x-www-form-urlencoded"</li><li>"application/x-yaml"</li><li>"application/zip"</li><li>"multipart/form-data"</li><li>"image/bmp"</li><li>"image/gif"</li><li>"image/jpeg"</li><li>"image/png"</li><li>"image/tiff"</li><li>"text/calendar"</li><li>"text/css"</li><li>"text/csv"</li><li>"text/html"</li><li>"text/javascript"</li><li>"text/plain"</li><li>"text/vcard"</li><li>"video/mpeg"</li></ul></td> </tr> </tbody></table> * - content_type is required for when uploading a document unless you are uploading using a URL. <h2 id='post-hire-application'>POST: Hire Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/hire' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "start_date": "2017-03-15", "opening_id": 454, "close_reason_id": 43432 } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 33, "public_name": "Glassdoor" }, "credited_to": null, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 211706, "name": "Community Manager - New York" } ], "job_post_id": 123, "status": "hired", "current_stage": null, "answers": [ { "question": "How many years experience do you have?", "answer": "2-4" }, { "question": "Can do you the travel required for this job?", "answer": "Yes" } ], "prospective_office": null, "prospective_department": null, "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 } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> Hire this application. The application must not be a prospect and all approvals for the job and offer must have occurred. <h3 id='http-request-11'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/applications/{id}/hire</code> <h3 id='headers-9'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-7'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>start_date</td> <td>No*</td> <td>string</td> <td>The start_date of the employee. Must be in the format YYYY-MM-DD</td> </tr> <tr> <td>opening_id</td> <td>No</td> <td>integer</td> <td>An opening ID to fill with this hire. This is the unique Greenhouse id of the opening (id in the openings endpoint) and not the human readable opening id text. If no opening is provided one will be selected.</td> </tr> <tr> <td>close_reason_id</td> <td>No</td> <td>integer</td> <td>The close reason to assign to the opening that will be closed with this hire.</td> </tr> </tbody></table> <ul> <li>- Start date may be required if the organization requires offers to have start dates and the application's current offer does not have one set.</li> </ul> Note that "current_stage" in the response JSON is null. A hired application no longer has a current stage. <a href="#the-application-object">See noteworthy response attributes.</a> <h2 id='post-reject-application'>POST: Reject Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/reject' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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 } } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 1871, "public_name": "Happy Hour" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": { "id": 815, "name": "The prospect is not qualified for this position.", "type": { "id": 1, "name": "We rejected them" } }, "rejection_details": { "custom_fields": { "custom_rejection_question_field": "Not a good fit" }, "keyed_custom_fields": { "custom_rejection_question_field": { "name": "Was this candidate a good fit?", "type": "short_text", "value": "This candidate wasn't a good fit." } } }, "jobs": [ { "id": 123, "name": "Accounting Manager" } ], "job_post_id": 456, "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." } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> Reject this application. The response is populated with the application's information which will reflect its new state. Note that only applications in the <code>active</code> state can be rejected. <h3 id='http-request-12'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/applications/{id}/reject</code> <h3 id='headers-10'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-8'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>rejection_reason_id</td> <td>No</td> <td>integer</td> <td>The ID of the reason why this application was rejected.</td> </tr> <tr> <td>notes</td> <td>No</td> <td>string</td> <td>Notes on why this application was rejected. These will be added to the activity feed.</td> </tr> <tr> <td>rejection_email</td> <td>No</td> <td>hash</td> <td>An email will be sent to the candidate notifying them of this rejection.</td> </tr> <tr> <td>rejection_email.send_email_at</td> <td>No</td> <td>string</td> <td>The rejection email will be delayed until this time. The On-Behalf-Of user's time zone will be used for scheduling the email.</td> </tr> <tr> <td>rejection_email.email_template_id</td> <td>Yes, if sending rejection_email</td> <td>string</td> <td>The template to use for the rejection email. Template must be an organization wide email template.</td> </tr> </tbody></table> <h2 id='patch-update-rejection-reason'>PATCH: Update Rejection Reason</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/applications/{id}/reject' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "rejection_reason_id": 815 } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: <code>json { "id": 12345, "message": "Rejection reason updated to 815 (Higher Salary Offer Made)", "success": true } </code> </blockquote> This endpoint updates the rejection reason on a currently rejected application. An application in any other state will return an error. The rejection reason id may be either a custom rejection reason for your organization or a Greenhouse default rejection reason. <h3 id='http-request-13'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/applications/{id}/reject</code> <h3 id='headers-11'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='url-parameters-2'>URL parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the application to update</td> </tr> </tbody></table> <h3 id='json-body-parameters-9'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>rejection_reason_id</td> <td>yes</td> <td>The ID of the new rejection reason</td> </tr> </tbody></table> <h2 id='post-unreject-application'>POST: Unreject Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/applications/{id}/unreject' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command requires an empty JSON body: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{} </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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", "location": { "address": "New York, New York, USA" }, "source": { "id": 2, "public_name": "Jobs page on your website" }, "credited_to": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 107761, "name": "UX Designer - Boston" } ], "job_post_id": 123, "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" } ], "prospective_office": null, "prospective_department": null, "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" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } </code></pre></div> <blockquote> An unsuccessful response: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "errors": [ { "message": "Application must be 'rejected', is currently 'active'" } ] } </code></pre></div> Unreject this application. The response is populated with the application in its new state. Note that only applications in the <code>rejected</code> state can be unrejected. <h3 id='http-request-14'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/applications/{id}/unreject</code> <h3 id='headers-12'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='url-parameters-3'>URL parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the application to unreject</td> </tr> </tbody></table> <h3 id='json-body-parameters-10'>JSON Body Parameters</h3> No JSON body parameters <h1 id='approvals'>Approvals</h1> An organization's approvals <h2 id='the-approval-flow-object'>The approval flow object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 49394, "offer_id": 45545, "sequential": true, "version": 2, "approval_type": "offer_candidate", "approval_status": "pending", "job_id": 12321, "requested_by_user_id": 543, "approver_groups": [ { "id": 2011242, "approvals_required": 1, "created_at": "2018-03-30T19:32:04.295Z", "resolved_at": null, "priority": 1, "job_id": 12321, "offer_id": null, "approvers": [ { "id": 1234, "name": "Michael Clayton", "employee_id": "abc-123", "email_addresses": ["mclayton@example.com"] } ] }, { "id": 2011241, "approvals_required": 1, "created_at": "2018-03-30T19:32:00.150Z", "resolved_at": "2018-03-30T19:34:17.374Z", "priority": 0, "job_id": 12321, "offer_id": null, "approvers": [ { "id": 1235, "name": "Clay Michaels", "employee_id": "abc-124", "email_addresses": ["cmichaels@example.com"] } ] } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy Attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The approval's unique identifier</td> </tr> <tr> <td>offer_id</td> <td>The specific offer for this approval. This will be empty for job approvals.</td> </tr> <tr> <td>sequential</td> <td>true or false based on whether the groups in this flow must approve sequentially</td> </tr> <tr> <td>version</td> <td>The specific version of this flow.</td> </tr> <tr> <td>approval_type</td> <td>One of 'open_job,' 'offer_job' or 'offer_candidate.' <code>open_job</code> refers to approval flows to <a href="https://support.greenhouse.io/hc/en-us/articles/201094534-Request-approval-to-start-recruiting-">start recruiting on a job</a>. <code>offer_job</code> refers to approval flows to <a href="https://support.greenhouse.io/hc/en-us/articles/360025776391">make offers on a job</a>. <code>offer_candidate</code> refers to approval flows for a <a href="https://support.greenhouse.io/hc/en-us/articles/360035625832-Offer-approval-overview">candidate offer</a>.</td> </tr> <tr> <td>approval_status</td> <td>one of 'pending', 'approved', or 'rejected'</td> </tr> <tr> <td>job_id</td> <td>The job for which approval is configured. This always has a value.</td> </tr> <tr> <td>requested_by_user_id</td> <td>The user who requested this approval be started.</td> </tr> </tbody></table> <h2 id='get-list-approvals-for-job'>GET: List Approvals For Job</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{job_id}/approval_flows' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 49394, "offer_id": 45545, "sequential": true, "version": 2, "approval_type": "offer_candidate", "approval_status": "pending", "job_id": 12321, "requested_by_user_id": 543, "approver_groups": [ { "id": 2011242, "approvals_required": 1, "created_at": "2018-03-30T19:32:04.295Z", "resolved_at": null, "priority": 1, "job_id": 12321, "offer_id": null, "approvers": [ { "id": 1234, "name": "Michael Clayton", "employee_id": "abc-123", "email_addresses": ["mclayton@example.com"] } ] }, { "id": 2011241, "approvals_required": 1, "created_at": "2018-03-30T19:32:00.150Z", "resolved_at": "2018-03-30T19:34:17.374Z", "priority": 0, "job_id": 12321, "offer_id": null, "approvers": [ { "id": 1235, "name": "Clay Michaels", "employee_id": "abc-124", "email_addresses": ["cmichaels@example.com"] } ] } ] }, { "id": 49395, "offer_id": null, "sequential": true, "version": 1, "approval_type": "offer_job", "approval_status": "pending", "job_id": 12321, "requested_by_user_id": 545, "approver_groups": [ { "id": 2011247, "approvals_required": 1, "created_at": "2018-03-30T19:32:04.295Z", "resolved_at": null, "priority": 1, "job_id": 12321, "offer_id": null, "approvers": [ { "id": 1234, "name": "Michael Clayton", "employee_id": "abc-123", "email_addresses": ["mclayton@example.com"] } ] } ] } ] </code></pre></div> List all of a job's approval flows <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{id}/approval_flows</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The id of the job for which you'd like to see approvals</td> </tr> </tbody></table> <a href="#the-approval-flow-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-approval-flow'>GET: Retrieve Approval Flow</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/approval_flows/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 49394, "offer_id": 45545, "sequential": true, "version": 2, "approval_type": "offer_candidate", "approval_status": "pending", "job_id": 12321, "requested_by_user_id": 543, "approver_groups": [ { "id": 2011242, "approvals_required": 1, "created_at": "2018-03-30T19:32:04.295Z", "resolved_at": null, "priority": 1, "job_id": 12321, "offer_id": null, "approvers": [ { "id": 1234, "name": "Michael Clayton", "employee_id": "abc-123", "email_addresses": ["mclayton@example.com"] } ] }, { "id": 2011241, "approvals_required": 1, "created_at": "2018-03-30T19:32:00.150Z", "resolved_at": "2018-03-30T19:34:17.374Z", "priority": 0, "job_id": 12321, "offer_id": null, "approvers": [ { "id": 1235, "name": "Clay Michaels", "employee_id": "abc-125", "email_addresses": ["cmichaels@example.com"] } ] } ] } </code></pre></div><h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/approval_flows/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the approval flow to retrieve</td> </tr> </tbody></table> <a href="#the-approval-flow-object">See noteworthy response attributes.</a> <h2 id='post-request-approvals'>POST: Request Approvals</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/approval_flows/{id}/request_approvals' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> Given an approval flow, request it be started. This will change the state of the first approver group from "waiting" to "due" and mark the On-Behalf-Of user as the requesting user. This endpoint will fail with a 403 response if the On-Behalf-Of user can't see the hiring plan or can't request approvals. It will fail with a 422 response if the approval flow can't be started. <h3 id='http-request-3'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/approval_flows/{id}/request_approvals</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h2 id='get-pending-approvals-for-user'>GET: Pending Approvals For User</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X GET 'https://harvest.greenhouse.io/v1/users/{id}/pending_approvals' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>[ { "id": 34564, "status": "waiting", "created_at": "2017-03-23T18:58:27.796Z", "resolved_at": null, "request_sent_at": "2017-03-23T18:58:27.796Z", "reminder_sent_at": "2017-03-25T18:58:27.796Z", "reminders_sent": 2, "approver_group_id": 3432, "reminder_sent_by_user_id": 343, "hiring_plan_id": 4567, "offer_id": null, "approval_flow_id": 292244, "approval_flow_type": "open_job", "approval_flow_status": "pending" }, { "id": 34568, "status": "due", "created_at": "2017-04-23T18:58:27.796Z", "resolved_at": null, "request_sent_at": "2017-04-23T18:58:27.796Z", "reminder_sent_at": "2017-04-25T18:58:27.796Z", "reminders_sent": 1, "approver_group_id": 3436, "reminder_sent_by_user_id": 343, "hiring_plan_id": 4568, "offer_id": 4534, "approval_flow_id": 268182, "approval_flow_type": "offer_candidate", "approval_flow_status": "pending" } ] </code></pre></div> Returns all pending approvals for this user. Pending approvals are defined as an approval chain that is not approved or rejected, that this user has not already approved or rejected, in a group that has not yet determined approval or rejection. <h3 id='http-request-4'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/users/{user_id}/pending_approvals</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the user whose pending approvals we want.</td> </tr> </tbody></table> <h3 id='querystring-parameters-2'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>type</td> <td>'job' or 'offer', where 'offer' returns only approvals which are for a specific offer and 'job' specifically excludes approvals for specific offers. Leaving this blank will return all approvals.</td> </tr> </tbody></table> <h3 id='noteworthy-attributes-2'>Noteworthy Attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>status</td> <td>This is either "waiting" or "due" for pending approvals</td> </tr> <tr> <td>approver_group_id</td> <td>This is Approver Group ID used in post requests to replace this user in approval steps.</td> </tr> </tbody></table> <h2 id='put-replace-an-approver-in-an-approver-group'>PUT: Replace an approver in an approver group</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/approver_groups/{id}/replace_approvers' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "remove_user_id": 1443, "add_user_id": 5432 } </code></pre></div> <blockquote> The above returns a JSON success message with the following information. </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "success": "true", "message": "Approver group updated.", "approval_flow_id": 454, "approver_group_id": 343, "removed_user_id": 1443, "added_user_id": 5432 } </code></pre></div> Removes the approver with user id given in remove_user_id and adds a new approver with the user id in add_user_id. Only approvers in unresolved groups may be replaced with this endpoint. If a group is currently "due", the new user will be notified that action is required. <h3 id='http-request-5'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/approver_groups/{approver_group_id}/replace_approvers</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes. Must have access to the approval flow.</td> </tr> </tbody></table> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>approver_group_id</td> <td>The approver group in which we are replacing an approver.</td> </tr> </tbody></table> <h3 id='input-json-parameters'>Input JSON Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>remove_user_id</td> <td>The user id of the approver to be removed.</td> </tr> <tr> <td>add_user_id</td> <td>The user id of the new approver. Must have access to this approval flow.</td> </tr> </tbody></table> <h3 id='noteworthy-output-json-parameters'>Noteworthy Output JSON Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>approval_flow_id</td> <td>The approval flow that was changed.</td> </tr> </tbody></table> <h2 id='put-create-or-replace-an-approval-flow'>PUT: Create or replace an approval flow</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/jobs/{job_id}/approval_flows' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "approval_type": "offer_candidate", "offer_id": 343, "sequential": false, "approver_groups": [ { "approvals_required": 2, "approvers": [ { "user_id": 1432 }, { "email": "eddie.vedder@example.com" } ] }, { "approvals_required": 1, "approvers": [ { "employee_id": "abc-123" } ] } ] } </code></pre></div> <blockquote> The above returns a JSON success message with the following information. </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true, "approval_flow_id": 49394 } </code></pre></div> Endpoint may create or replace the entirety of an approval flow on a certain job or offer. If no approval flow exists, it will create it. Otherwise, it will modify the existing one. The priority of the approver group is implied by the order of the approver_groups element, with the first receiving first priority. Approvers who already exist in the group with matching priority will remain unchanged, approvers who are not included will be removed, and new approvers will be added. If modifying an approval that has been started, this endpoint will restart it, which will remove previous approvals, and notify the first group that an approval is due. Approvals in the rejected or approved state can not be modified by this endpoint. <h3 id='http-request-6'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/jobs/{job_id}/approval_flows</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes. Must have access to the approval flow.</td> </tr> </tbody></table> <h3 id='url-parameters-4'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>We will replace the approval flow on this job.</td> </tr> </tbody></table> <h3 id='input-json-parameters-2'>Input JSON Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>approval_type</td> <td>Required. One of offer_job, open_job, or offer_candidate. Designates which of the approval flows to replace. This is used for look-up and will not be edited by the endpoint.</td> </tr> <tr> <td>offer_id</td> <td>Optional. If included, it will search for an offer approval for this specific offer only. The job level approval will stay unchanged. If this is included, only 'offer_candidate' is a valid approval type. This is used for look-up and will not be edited by the endpoint.</td> </tr> <tr> <td>sequential</td> <td>Required. Accepts boolean true or false.</td> </tr> <tr> <td>approver_groups</td> <td>The list of approver groups. The order of the approver group list implies the 'priority' value in the approver group object, with the first listed group receiving the highest priority and so on.</td> </tr> <tr> <td>approvals_required</td> <td>Required. The number of approvals that must be given for this group to be considered approved and sent to the next group. Must be a number greater than zero.</td> </tr> <tr> <td>approvers</td> <td>Must contain the Greenhouse user_id, e-mail address, or employee_id for an active user in Greenhouse. The user must have access to the job. The number of users supplied must be greater than or equal to the approvals_required value for this group. If the approver appears in more than one group, he will be appear in the group with the highest priority and ignored in later groups.</td> </tr> </tbody></table> <h1 id='candidates'>Candidates</h1> An organization's candidates. <h2 id='the-candidate-object'>The candidate object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 53883394, "first_name": "John", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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": null, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ], "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": "67890" }, "coordinator": { "id": 453636, "first_name": "Jane", "last_name": "Smith", "name": "Jane Smith", "employee_id": "12345" }, "can_email": true, "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", "location": { "address": "New York, New York, USA" }, "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": { "custom_fields": { "custom_rejection_question_field": null }, "keyed_custom_fields": { "custom_rejection_question_field": { "name": "Custom Rejection Question Field", "type": "short_text", "value": null } } }, "jobs": [ { "id": 149995, "name": "DevOps Engineer" } ], "job_post_id": 123, "status": "rejected", "current_stage": { "id": 1073533, "name": "Take Home Test" }, "answers": [ { "question": "How did you hear about this job?", "answer": "A friend" }, { "question": "Website", "answer": "https://example.com" }, { "question": "LinkedIn Profile", "answer": "https://linkedin.com/example" } ], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] }, { "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", "location": { "address": "New York, New York, United States" }, "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" } ], "job_post_id": 456, "status": "active", "current_stage": { "id": 2966800, "name": "Face to Face" }, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [] } ], "educations": [ { "id": 561227, "school_name": "University of Michigan - Ann Arbor", "degree": "Bachelor's Degree", "discipline": "Computer Science", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "employments": [ { "id": 8485064, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "linked_user_ids": [ 989604 ], "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" } } } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The candidate's unique identifier</td> </tr> <tr> <td>company</td> <td>The company at which the candidate currently works</td> </tr> <tr> <td>title</td> <td>The candidate's current title</td> </tr> <tr> <td>is_private</td> <td>Whether the candidate is private or not. One of: ["true", "false"]</td> </tr> <tr> <td>application_ids</td> <td>Array of <a href="#applications">application</a> IDs associated with this candidate. Can contain none, one, or several application IDs.</td> </tr> <tr> <td>phone_numbers[].type</td> <td>One of: ["home", "work", "mobile", "skype", "other"]</td> </tr> <tr> <td>addresses[].type</td> <td>One of: ["home", "work", "other"]</td> </tr> <tr> <td>email_addresses[].type</td> <td>One of: ["personal", "work", "other"]</td> </tr> <tr> <td>website_addresses[].type</td> <td>One of: ["personal", "company", "portfolio", "blog", "other"]</td> </tr> <tr> <td>recruiter</td> <td>The recruiter <a href="#users">user</a> who is responsible for this candidate.</td> </tr> <tr> <td>coordinator</td> <td>The coordinator <a href="#users">user</a> who is responsible for this candidate.</td> </tr> <tr> <td>attachments[].type</td> <td>One of: ["resume", "cover_letter", "offer_packet", "offer_letter", "take_home_test", "other"]</td> </tr> <tr> <td>attachments[].url</td> <td>URLs expire in 7 days.</td> </tr> <tr> <td>custom_fields</td> <td>Contains a hash of the custom fields configured for this resource. The properties in this hash reflect the active custom fields as of the time this method is called.</td> </tr> <tr> <td>keyed_custom_fields</td> <td>This contains the same information as custom_fields but formatted in a different way that includes more information. This will tell you the type of custom field data to expect, the text name of custom field, and the value. The key of this hash is the custom field's immutable field key, which will not change even if the name of the custom field is changed in Greenhouse.</td> </tr> <tr> <td>linked_user_ids</td> <td>If the candidate is an internal applicant, this returns the Greenhouse user ID of the candidate.</td> </tr> <tr> <td>photo_url</td> <td>Note: this field has been removed from Greenhouse and will always be null. For backwards compatibility, the field will remain in API payloads</td> </tr> </tbody></table> <h2 id='get-list-candidates'>GET: List Candidates</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/candidates' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 53883394, "first_name": "John", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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": null, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ], "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, "can_email": true, "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", "location": { "address": "New York, New York, USA" }, "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" } ], "job_post_id": 123, "status": "active", "current_stage": null, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": { "id": 224, "name": "Cold Outreach: Sourced" }, "prospect_stage": { "id": 817, "name": "Contacted" }, "prospect_owner": { "id": 92120, "name": "Greenhouse Admin" } }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] }, { "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", "location": null, "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": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [] } ], "educations": [ { "id": 561227, "school_name": "University of Michigan - Ann Arbor", "degree": "Bachelor's Degree", "discipline": "Computer Science", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "employments": [ { "id": 8485064, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "linked_user_ids": [ 989604 ], "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" } } } ] </code></pre></div> List all of an organization's candidates. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/candidates</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving candidates will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only candidates that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only candidates that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only candidates that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only candidates that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>job_id</td> <td>Only returns candidates who have applied to the specified job. Prospects on the job are not included.</td> </tr> <tr> <td>email</td> <td>If 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. If email and candidate_ids are included, candidate_ids will be ignored.</td> </tr> <tr> <td>candidate_ids</td> <td>If supplied, return only the candidates with the given ids. These are supplied as a comma separated string. e.g.: "candidate_ids=123,456,789". When combined with job_id, only return candidates with an application on the job. A maximum of 50 candidates can be returned this way.</td> </tr> </tbody></table> <a href="#the-candidate-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-candidate'>GET: Retrieve Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/candidates/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 53883394, "first_name": "John", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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": null, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ], "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": "67890" }, "coordinator": { "id": 453636, "first_name": "Jane", "last_name": "Smith", "name": "Jane Smith", "employee_id": "12345" }, "can_email": true, "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", "location": { "address": "New York, New York, USA" }, "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": { "custom_fields": { "custom_rejection_question_field": null }, "keyed_custom_fields": { "custom_rejection_question_field": { "name": "Custom Rejection Question Field", "type": "short_text", "value": null } } }, "jobs": [ { "id": 149995, "name": "DevOps Engineer" } ], "job_post_id": 123, "status": "rejected", "current_stage": { "id": 1073533, "name": "Take Home Test" }, "answers": [ { "question": "How did you hear about this job?", "answer": "A friend" }, { "question": "Website", "answer": "https://example.com" }, { "question": "LinkedIn Profile", "answer": "https://linkedin.com/example" } ], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] }, { "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", "location": { "address": "New York, New York, United States" }, "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" } ], "job_post_id": 456, "status": "active", "current_stage": { "id": 2966800, "name": "Face to Face" }, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [] } ], "educations": [ { "id": 561227, "school_name": "University of Michigan - Ann Arbor", "degree": "Bachelor's Degree", "discipline": "Computer Science", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "employments": [ { "id": 8485064, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "linked_user_ids": [ 989604 ], "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" } } } </code></pre></div> Retrieve a candidate by its <code>id</code>. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/candidates/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the candidate to retrieve</td> </tr> </tbody></table> <a href="#the-candidate-object">See noteworthy response attributes.</a> <h2 id='delete-delete-candidate'>DELETE: Delete Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/candidates/{id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "message": "Person 29622362 has been deleted." } </code></pre></div> Delete a candidate by <code>id</code>. <h3 id='http-request-3'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/candidates/{id}</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h2 id='patch-edit-candidate'>PATCH: Edit Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/candidates/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "first_name": "New", "last_name": "Name", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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" } ], "recruiter": { "user_id": 4354 }, "coordinator": { "email": "coordinator@example.com" }, "tags": [ "Walkabout", "Orientation" ], "custom_fields": [ { "id": 1234, "value": "Some new value" }, { "name_key": "single_select_field_name", "value": 12345 }, { "id": 5678, "delete_value": "true" } ] } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 53883394, "first_name": "New", "last_name": "Name", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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": null, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_28_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "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, "can_email": true, "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", "location": { "address": "New York, New York, USA" }, "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" } ], "job_post_id": 123, "status": "active", "current_stage": { "id": 2966800, "name": "Face to Face" }, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } ], "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" } } } ] </code></pre></div> Update or <code>patch</code> a single candidate by its <code>id</code>. <h3 id='http-request-4'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/candidates/{id}</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>first_name</td> <td>No</td> <td>string</td> <td>The candidate's first name</td> </tr> <tr> <td>last_name</td> <td>No</td> <td>string</td> <td>The candidate's last name</td> </tr> <tr> <td>company</td> <td>No</td> <td>string</td> <td>The candidate's company</td> </tr> <tr> <td>title</td> <td>No</td> <td>string</td> <td>The candidate's title</td> </tr> <tr> <td>is_private</td> <td>Whether the candidate is private or not. One of: ["true", "false"]</td> <td></td> <td></td> </tr> <tr> <td>phone_numbers[]</td> <td>No</td> <td>phone_number</td> <td>Array of phone numbers. Passing an empty array will clear all.</td> </tr> <tr> <td>addresses[]</td> <td>No</td> <td>address</td> <td>Array of addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>email_addresses[]</td> <td>No</td> <td>email_address</td> <td>Array of email addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>website_addresses[]</td> <td>No</td> <td>website_address</td> <td>Array of website addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>social_media_addresses[]</td> <td>No</td> <td>social_media_address</td> <td>Array of social media addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>tags[]</td> <td>No</td> <td>string</td> <td>Array of tags as strings. Passing an empty array will clear all.</td> </tr> <tr> <td>custom_fields[]</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new custom field values. Passing an empty array does nothing.</td> </tr> <tr> <td>recruiter</td> <td>No</td> <td>Hash</td> <td>An object representing the candidate's new recruiter</td> </tr> <tr> <td>recruiter[id]</td> <td>No</td> <td>Integer</td> <td>The ID of the new recruiter - either id or email must be present.</td> </tr> <tr> <td>recruiter[email]</td> <td>No</td> <td>String</td> <td>The email of the new recruiter - either id or email must be present.</td> </tr> <tr> <td>coordinator</td> <td>No</td> <td>Hash</td> <td>An object representing the candidate's new coordinator</td> </tr> <tr> <td>coordinator[id]</td> <td>No</td> <td>Integer</td> <td>The ID of the new coordinator - either id or email must be present.</td> </tr> <tr> <td>coordinator[email]</td> <td>No</td> <td>String</td> <td>The email of the new coordinator - either id or email must be present.</td> </tr> </tbody></table> <h3 id='custom-field-parameters'>Custom Field Parameters</h3> The custom field parameter structure is different in the PATCH method then in GET methods and responses. Certain types 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. <table><thead> <tr> <th>Parameter</th> <th>Required for</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>all</td> <td>The custom field id for this particular custom field. One of this or name_key is required.</td> </tr> <tr> <td>name_key</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>value</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>unit</td> <td>currency</td> <td>This 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.</td> </tr> <tr> <td>delete_value</td> <td>n/a</td> <td>When 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.</td> </tr> </tbody></table> <a href="#the-candidate-object">See noteworthy response attributes.</a> <aside class="notice"> There may be a delay between when Greenhouse receives the POST: Add Candidate Application request and when Greenhouse creates the full application record, which will result in a truncated API response. The truncated response body will contain the Application ID of the newly created application. You can retrieve the full application record by requesting the Application ID with the GET: Retrieve Application endpoint. If you receive a 404 error from the GET: Retrieve Application endpoint, this indicates that the full application record is still not available. Until the application record has been made fully-available in the API, please continue to request the record until the API returns a successful response. Our recommendation is to perform this check every 30 seconds until the data becomes available. </aside> <h2 id='post-add-attachment'>POST: Add Attachment</h2> <aside class="warning">As of July 2019, we introduced the ability to add attachments to an individual application and to upload new types of attachments. Documentation can be found <a href="#post-add-attachment-to-application">here</a>.</aside> <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/attachments' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "filename" : "resume.pdf", "type" : "resume", "content" : "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs...", "content_type" : "application/pdf" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "filename": "resume.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "resume", "content_type": "application/pdf" } </code></pre></div> Post an attachment to a candidate's profile by the candidate <code>id</code>. <h3 id='http-request-5'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/candidates/{id}/attachments</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>filename</td> <td>Yes</td> <td>string</td> <td>Name of the file</td> </tr> <tr> <td>type</td> <td>Yes</td> <td>string</td> <td>One of: ["resume", "cover_letter", "admin_only"]</td> </tr> <tr> <td>content</td> <td>No</td> <td>string</td> <td>Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.</td> </tr> <tr> <td>url</td> <td>No</td> <td>string</td> <td>Url of the attachment (if you are providing the url, you do not need to provide the content.) Please note, shareable links from cloud services such as Google Drive will result in a corrupted file. Please use machine-accessible URLs.</td> </tr> <tr> <td>content_type</td> <td>Yes*</td> <td>string</td> <td>The 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: <ul><li>"application/atom+xml"</li><li>"application/javascript"</li><li>"application/json"</li><li>"application/msgpack"</li><li>"application/msword"</li><li>"application/pdf"</li><li>"application/rss+xml"</li><li>"application/vnd.ms-excel"</li><li>"application/vnd.openxmlformats- officedocument.spreadsheetml.sheet"</li><li>"application/vnd.openxmlformats- officedocument.wordprocessingml.document"</li><li>"application/vnd.ms-powerpoint"</li><li>"application/xml"</li><li>"application/x-www-form-urlencoded"</li><li>"application/x-yaml"</li><li>"application/zip"</li><li>"multipart/form-data"</li><li>"image/bmp"</li><li>"image/gif"</li><li>"image/jpeg"</li><li>"image/png"</li><li>"image/tiff"</li><li>"text/calendar"</li><li>"text/css"</li><li>"text/csv"</li><li>"text/html"</li><li>"text/javascript"</li><li>"text/plain"</li><li>"text/vcard"</li><li>"video/mpeg"</li></ul></td> </tr> </tbody></table> * - content_type is required for when uploading a document unless you are uploading using a URL. <h2 id='post-add-candidate'>POST: Add Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/candidates' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "first_name": "John", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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" } ], "educations": [ { "school_id": 459, "discipline_id": 940, "degree_id": 1230, "start_date": "2001-09-15T00:00:00.000Z", "end_date": "2004-05-15T00:00:00.000Z" } ], "employments": [ { "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "tags": [ "Walkabout", "Orientation" ], "applications": [ { "job_id": 215725 }, { "job_id": 185289 } ] } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 57683957, "first_name": "John", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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, "can_email": true, "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", "location": { "address": "New York, New York, USA" }, "source": null, "credited_to": null, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 185289, "name": "Product Specialist" } ], "job_post_id": 123, "status": "active", "current_stage": { "id": 1355395, "name": "Application Review" }, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [] }, { "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", "location": null, "source": null, "credited_to": null, "rejection_reason": null, "rejection_details": null, "jobs": [ { "id": 215725, "name": "Operations Manager" } ], "job_post_id": 456, "status": "active", "current_stage": { "id": 1579673, "name": "Application Review" }, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [] } ], "educations": [ { "id": 561226, "school_name": "Siena College", "discipline": "Computer Science", "degree": "Bachelor's Degree" } ], "employments": [ { "id": 8485064, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "custom_fields": { "desired_salary": null, "work_remotely": null, "graduation_year": null }, "keyed_custom_fields": { "desired_salary": null, "work_remotely": null, "graduation_year_1": null } } </code></pre></div> Create a new candidate. <h3 id='http-request-6'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/candidates</code> <h3 id='headers-4'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-3'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>first_name</td> <td>Yes</td> <td>string</td> <td>The candidate's first name</td> </tr> <tr> <td>last_name</td> <td>Yes</td> <td>string</td> <td>The candidate's last name</td> </tr> <tr> <td>company</td> <td>No</td> <td>string</td> <td>The candidate's company</td> </tr> <tr> <td>title</td> <td>No</td> <td>string</td> <td>The candidate's title</td> </tr> <tr> <td>phone_numbers[]</td> <td>No</td> <td>phone_number</td> <td>Array of phone numbers. Passing an empty array will clear all.</td> </tr> <tr> <td>addresses[]</td> <td>No</td> <td>address</td> <td>Array of addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>email_addresses[]</td> <td>No</td> <td>email_address</td> <td>Array of email addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>website_addresses[]</td> <td>No</td> <td>website_address</td> <td>Array of website addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>social_media_addresses[]</td> <td>No</td> <td>social_media_address</td> <td>Array of social media addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>educations</td> <td>No</td> <td>Array</td> <td>An array of education records. See <a href="#post-add-education">Add Education</a> for parameters.</td> </tr> <tr> <td>employments</td> <td>No</td> <td>Array</td> <td>An array of employment records. See <a href="#post-add-employment">Add Employment</a> for parameters.</td> </tr> <tr> <td>tags[]</td> <td>No</td> <td>string</td> <td>Array of tags as strings. Passing an empty array will clear all.</td> </tr> <tr> <td>custom_fields[]</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new custom field values. Passing an empty array does nothing.</td> </tr> <tr> <td>recruiter</td> <td>No</td> <td>Object</td> <td>An object representing the candidate's recruiter</td> </tr> <tr> <td>recruiter[id]</td> <td>No</td> <td>Integer</td> <td>The ID of the recruiter - either id or email must be present.</td> </tr> <tr> <td>recruiter[email]</td> <td>No</td> <td>String</td> <td>The email of the recruiter - either id or email must be present.</td> </tr> <tr> <td>coordinator</td> <td>No</td> <td>Object</td> <td>An object representing the candidate's coordinator</td> </tr> <tr> <td>coordinator[id]</td> <td>No</td> <td>Integer</td> <td>The ID of the coordinator - either id or email must be present.</td> </tr> <tr> <td>coordinator[email]</td> <td>No</td> <td>String</td> <td>The email of the coordinator - either id or email must be present.</td> </tr> <tr> <td>custom_fields</td> <td>No</td> <td>Array</td> <td>Array of custom field value objects - See "Custom Field Parameters" under <a href="#patch-edit-candidate">Edit candidate</a> for parameters.</td> </tr> <tr> <td>activity_feed_notes</td> <td>No</td> <td>Array</td> <td>An array of activity feed objects. See <a href="#post-add-note">Add Note</a> for parameters.</td> </tr> <tr> <td>applications</td> <td>Yes</td> <td>Array</td> <td>An array of application objects. At least one required. See <a href="#post-add-application-to-candidate-prospect">Add Application</a> for parameters.</td> </tr> </tbody></table> <aside class="notice"> There may be a delay between when Greenhouse receives the POST: Add Candidate request and when Greenhouse creates the full candidate record, which will result in a truncated API response. The truncated response body will contain the Candidate ID and the Application ID(s) of the newly created candidate. You can retrieve the full candidate record by requesting the Candidate ID with the GET: Retrieve Candidate endpoint. If you receive a 404 error from the GET: Retrieve Candidate endpoint, this indicates that the full candidate record is still not available. Until the candidate record has been made fully-available in the API, please continue to request the record until the API returns a successful response. Our recommendation is to perform this check every 30 seconds until the data becomes available. </aside> <a href="#the-candidate-object">See noteworthy response attributes.</a> <h2 id='post-add-note'>POST: Add Note</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/notes' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "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" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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" } </code></pre></div> Create a candidate note. <h3 id='http-request-7'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/notes</code> <h3 id='headers-5'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-4'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>user_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the user creating the note</td> </tr> <tr> <td>body</td> <td>Yes</td> <td>string</td> <td>Note body</td> </tr> <tr> <td>visibility*</td> <td>Yes</td> <td>string</td> <td>One of: <code>"admin_only"</code>, <code>"private"</code>, <code>"public"</code></td> </tr> </tbody></table> * - Due to a legacy typo, the response includes the same value as <code>visiblity</code>. It is safe to ignore this value, but it is maintained for backward compatibility. <h2 id='post-add-e-mail-note'>POST: Add E-mail Note</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/emails' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "user_id": "214", "to": "candidate@example.com", "from": "recruiter@example.com", "cc": ["manager@example.com"], "subject": "Interview Scheduled", "body": "An interview has been scheduled for tomorrow." } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 226809053, "created_at": "2015-07-17T16:29:31Z", "subject": "Interview Scheduled", "body": "An interview has been scheduled for tomorrow.", "to": "candidate@example.com", "from": "recruiter@example.com", "cc": [ "manager@example.com" ], "user": { "id": 214, "first_name": "Donald", "last_name": "Johnson", "name": "Donald Johnson", "employee_id": "12345" } } </code></pre></div> Create a candidate e-mail note. <h3 id='http-request-8'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/candidates/{id}/activity_feed/emails</code> <h3 id='headers-6'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-5'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>user_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the user creating the note</td> </tr> <tr> <td>to</td> <td>Yes</td> <td>string</td> <td>This is a free text field that is meant to be an e-mail address. E-mail format will not be validated.</td> </tr> <tr> <td>from</td> <td>Yes</td> <td>string</td> <td>This is a free text field that is meant to be an e-mail address. E-mail format will not be validated.</td> </tr> <tr> <td>cc</td> <td>No</td> <td>Array</td> <td>This is meant to be an array of e-mail addresses. E-mail format will not be validated.</td> </tr> <tr> <td>subject</td> <td>Yes</td> <td>string</td> <td>The subject line of the e-mail.</td> </tr> <tr> <td>body</td> <td>Yes</td> <td>string</td> <td>The body of the e-mail.</td> </tr> </tbody></table> <h2 id='post-add-education'>POST: Add Education</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/educations' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "school_id": 459, "discipline_id": 940, "degree_id": 1230, "start_date": "2001-09-15T00:00:00.000Z", "end_date": "2004-05-15T00:00:00.000Z" } </code></pre></div> <blockquote> The above command returns a JSON response with a 201 status, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 5690098, "school_name": "Siena College", "discipline": "Computer Science", "degree": "Bachelor's Degree", "start_date": "2001-09-15T00:00:00.000Z", "end_date": "2004-05-15T00:00:00.000Z" } </code></pre></div> Create a new education record <h3 id='http-request-9'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/candidates/{id}/educations</code> <h3 id='headers-7'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-6'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>school_id</td> <td>No</td> <td>integer</td> <td>The ID of the college attended; from the GET schools endpoint</td> </tr> <tr> <td>discipline_id</td> <td>No</td> <td>integer</td> <td>The ID of the discipline of the candidate's education; from the GET disciplines endpoint.</td> </tr> <tr> <td>degree_id</td> <td>No</td> <td>integer</td> <td>The type of degree received; from the GET degrees endpoint</td> </tr> <tr> <td>start_month</td> <td>No</td> <td>integer</td> <td>The month the candidate began attendance. Must be between 1-12.</td> </tr> <tr> <td>start_year</td> <td>No</td> <td>integer</td> <td>The year the candidate began attendance. Must be between 1900-2100.</td> </tr> <tr> <td>start_date</td> <td>No</td> <td>DateTime</td> <td>The date the candidate began attendance. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.*</td> </tr> <tr> <td>end_month</td> <td>No</td> <td>integer</td> <td>The month the candidate finished attendance. Must be between 1-12.</td> </tr> <tr> <td>end_year</td> <td>No</td> <td>integer</td> <td>The year the candidate finished attendance. Must be between 1900-2100.</td> </tr> <tr> <td>end_date</td> <td>No</td> <td>DateTime</td> <td>The date the candidate finished attendance. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.*</td> </tr> </tbody></table> <ul> <li>- Note that start_date and end_date accept an <a href="#general-considerations">ISO-8601</a> timestamp in accordance with Harvest's standard timestamp rules, but only Month and Year will be displayed on the candidate profile in Greenhouse. The "latest education" will be updated automatically. Day and time information in these timestamps will be recorded but not referenced in Greenhouse.</li> <li>- Note that you can either have start_date, or start_month and start_year.</li> <li>- Note that you can either have end_date, or end_month and end_year.</li> </ul> <h2 id='delete-remove-education-from-candidate'>DELETE: Remove Education From Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/candidates/{candidate_id}/educations/{education_id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true, "message": "Education ID 2002247 destroyed." } </code></pre></div> Delete an education record by candidate and education id. <h3 id='http-request-10'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/educations/{education_id}</code> <h3 id='headers-8'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h2 id='post-add-employment'>POST: Add Employment</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/candidates/{id}/employments' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "company_name": "Greenhouse", "title": "Engineer", "start_date": "2001-09-15T00:00:00.000Z", "end_date": "2004-05-15T00:00:00.000Z" } </code></pre></div> <blockquote> The above command returns a JSON response with a 201 status, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 5690098, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2001-09-15T00:00:00.000Z", "end_date": "2004-05-15T00:00:00.000Z" } </code></pre></div> Create a new employment record <h3 id='http-request-11'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/candidates/{id}/employments</code> <h3 id='headers-9'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-7'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>company_name</td> <td>Yes</td> <td>String</td> <td>A free text field indicating an employer's name</td> </tr> <tr> <td>title</td> <td>Yes</td> <td>String</td> <td>A free text field indicating the candidate's title while at the employer.</td> </tr> <tr> <td>start_date</td> <td>Yes</td> <td>DateTime</td> <td>The date the candidate began at employer. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.*</td> </tr> <tr> <td>end_date</td> <td>No</td> <td>DateTime</td> <td>The date the candidate finished at employer. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.* An empty end_date indicates current employment.</td> </tr> </tbody></table> <ul> <li>- Note that start_date and end_date accept an <a href="#general-considerations">ISO-8601</a> timestamp in accordance with Harvest's standard timestamp rules, but time will be ignored in the context of employment. The "latest employment" will be updated automatically.</li> </ul> <h2 id='delete-remove-employment-from-candidate'>DELETE: Remove Employment From Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/candidates/{candidate_id}/employments/{employment_id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true, "message": "Employment ID 823384 destroyed." } </code></pre></div> Delete an employment record by candidate and employment id. <h3 id='http-request-12'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/employments/{employment_id}</code> <h3 id='headers-10'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h2 id='post-add-prospect'>POST: Add Prospect</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/prospects' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "first_name": "John", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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" } ], "educations": [ { "school_id": 459, "discipline_id": 940, "degree_id": 1230, "start_date": "2001-09-15T00:00:00.000Z", "end_date": "2004-05-15T00:00:00.000Z" } ], "employments": [ { "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "tags": [ "Walkabout", "Orientation" ], "application": { "job_ids": [123, 456, 789], "source_id": 1234, "referrer": { "type": "id", "value": 770 }, "custom_fields": [], "attachments": [] } } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 29843268, "first_name": "John", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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, "can_email": true, "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, "location": null, "credited_to": null, "rejection_reason": null, "rejection_details": null, "jobs": [], "job_post_id": null, "status": "active", "current_stage": null, "answers": [], "prospective_office": { "primary_contact_user_id": null, "parent_id": null, "name": "New York", "location": { "name": "New York, NY" }, "id": 59213, "external_id": null, "child_ids": [] }, "prospective_department": { "parent_id": null, "name": "Marketing", "id": 9024, "external_id": null, "child_ids": [] }, "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": { "test": "A test value" }, "keyed_custom_fields": { "test": { "name": "Test", "type": "long_text", "value": "A test value" } } } ], "educations": [ { "id": 561226, "school_name": "Siena College", "discipline": "Computer Science", "degree": "Bachelor's Degree" } ], "employments": [ { "id": 8485064, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "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" } } } </code></pre></div> 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 <a href="#post-add-application-to-candidate-prospect">Add Candidate Application</a> endpoint. The organization must be able to create prospects to set this field. <h3 id='http-request-13'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/prospects</code> <h3 id='headers-11'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-8'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>first_name</td> <td>Yes</td> <td>string</td> <td>The prospect's first name</td> </tr> <tr> <td>last_name</td> <td>Yes</td> <td>string</td> <td>The prospect's last name</td> </tr> <tr> <td>company</td> <td>No</td> <td>string</td> <td>The prospect's company</td> </tr> <tr> <td>title</td> <td>No</td> <td>string</td> <td>The prospect's title</td> </tr> <tr> <td>phone_numbers[]</td> <td>No</td> <td>phone_number</td> <td>Array of phone numbers. Passing an empty array will clear all.</td> </tr> <tr> <td>addresses[]</td> <td>No</td> <td>address</td> <td>Array of addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>email_addresses[]</td> <td>No</td> <td>email_address</td> <td>Array of email addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>website_addresses[]</td> <td>No</td> <td>website_address</td> <td>Array of website addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>social_media_addresses[]</td> <td>No</td> <td>social_media_address</td> <td>Array of social media addresses. Passing an empty array will clear all.</td> </tr> <tr> <td>tags[]</td> <td>No</td> <td>string</td> <td>Array of tags as strings. Passing an empty array will clear all.</td> </tr> <tr> <td>custom_fields[]</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new custom field values. Passing an empty array does nothing.</td> </tr> <tr> <td>recruiter</td> <td>No</td> <td>Object</td> <td>An object representing the prospect's recruiter</td> </tr> <tr> <td>recruiter[id]</td> <td>No</td> <td>Integer</td> <td>The ID of the recruiter - either id or email must be present.</td> </tr> <tr> <td>recruiter[email]</td> <td>No</td> <td>String</td> <td>The email of the recruiter - either id or email must be present.</td> </tr> <tr> <td>coordinator</td> <td>No</td> <td>Object</td> <td>An object representing the prospect's coordinator</td> </tr> <tr> <td>coordinator[id]</td> <td>No</td> <td>Integer</td> <td>The ID of the coordinator - either id or email must be present.</td> </tr> <tr> <td>coordinator[email]</td> <td>No</td> <td>String</td> <td>The email of the coordinator - either id or email must be present.</td> </tr> <tr> <td>custom_fields</td> <td>No</td> <td>Array</td> <td>Array of custom field value objects - See "Custom Field Parameters" under <a href="#patch-edit-candidate">Edit candidate</a> for parameters.</td> </tr> <tr> <td>activity_feed_notes</td> <td>No</td> <td>Array</td> <td>An array of activity feed objects. See <a href="#post-add-note">Add Note</a> for parameters.</td> </tr> <tr> <td>application</td> <td>No</td> <td>Hash</td> <td>Unlike a candidate application, a prospect application can contain zero or multiple job IDs because a prospect in Greenhouse Recruiting can be attached to zero or many jobs. If your request doesn't contain an application object, the prospect will be created with a single, jobless application. If your request includes an application object, the <code>source_id</code>, <code>referrer</code>, <code>custom_fields</code>, and <code>attachments</code> parameters must match the format of the <a href="#post-add-application">Add Application</a> endpoint.</td> </tr> <tr> <td>application[job_ids]</td> <td>No</td> <td>Array</td> <td>This 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.</td> </tr> </tbody></table> <aside class="notice"> There may be a delay between when Greenhouse receives the POST: Add Prospect request and when Greenhouse creates the full prospect record, which will result in a truncated API response. The truncated response body will contain the Prospect ID. You can retrieve the full prospect record by requesting the Prospect ID with the GET: Retrieve Candidate endpoint. If you receive a 404 error from the GET: Retrieve Candidate endpoint, this indicates that the full prospect record is still not available. Until the prospect record has been made fully-available in the API, please continue to request the record until the API returns a successful response. Our recommendation is to perform this check every 30 seconds until the data becomes available. </aside> <a href="#the-candidate-object">See noteworthy response attributes.</a> <h2 id='put-anonymize-candidate'>PUT: Anonymize Candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>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" </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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": null, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_28_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "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, "can_email": true, "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", "location": null, "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" } ], "job_post_id": 123, "status": "active", "current_stage": { "id": 1567309, "name": "Application Review" }, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [ { "filename": "John_Locke_Offer_Packet_09_27_2017.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "offer_packet", "created_at": "2020-09-27T18:45:27.137Z" } ] } ], "educations": [ { "id": 561227, "school_name": "University of Michigan - Ann Arbor", "degree": "Bachelor's Degree", "discipline": "Computer Science" } ], "employments": [ { "id": 8485064, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "custom_fields": { "desired_salary": null, "work_remotely": null, "graduation_year": null }, "keyed_custom_fields": { "desired_salary": null, "work_remotely": null, "graduation_year_1": null } } </code></pre></div> Anonymize the data associated with a candidate. <h3 id='http-request-14'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/candidates/{id}/anonymize?fields={field_names}</code> <h3 id='headers-12'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='querystring-parameters-2'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>fields</td> <td>Yes</td> <td>comma-delimited string</td> <td>The 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, follow_up_reminders, custom_application_fields, education, employment, candidate_stage_data, prospect_owner, custom_rejection_question_fields, touchpoints, prospect_pool_and_stage, prospect_jobs, prospect_offices, prospect_offices_and_departments, and third_party_integrations</td> </tr> </tbody></table> <h2 id='put-merge-candidates'>PUT: Merge Candidates</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/candidates/merge' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "primary_candidate_id": 73821, "duplicate_candidate_id": 839283 } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 55961742, "first_name": "Justin", "last_name": "Locke", "company": "The Tustin Box Company", "title": "Customer Success Representative", "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/...", "type": "resume" }, { "filename": "Justin Locke cover letter.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "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, "can_email": true, "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", "location": { "address": "New York, New York, USA" }, "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" } ], "job_post_id": 123, "status": "active", "current_stage": { "id": 1567309, "name": "Application Review" }, "answers": [], "prospective_office": null, "prospective_department": null, "prospect_detail": { "prospect_pool": null, "prospect_stage": null, "prospect_owner": null }, "attachments": [ { "filename": "Justin Locke resume.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "resume" }, { "filename": "Justin Locke cover letter.pdf", "url": "https://prod-heroku.s3.amazonaws.com/...", "type": "cover_letter" } ] } ], "educations": [ { "id": 561227, "school_name": "University of Michigan - Ann Arbor", "degree": "Bachelor's Degree", "discipline": "Computer Science" } ], "employments": [ { "id": 8485064, "company_name": "Greenhouse", "title": "Engineer", "start_date": "2012-08-15T00:00:00.000Z", "end_date": "2016-05-15T00:00:00.000Z" } ], "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" } } } </code></pre></div> Merge two candidates into one. <h3 id='http-request-15'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/candidates/merge</code> <h3 id='headers-13'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-9'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>primary_candidate_id</td> <td>Yes</td> <td>integer</td> <td>The id of the first candidate that will be merged. This candidate will also be the result of the merge.</td> </tr> <tr> <td>duplicate_candidate_id</td> <td>Yes</td> <td>integer</td> <td>The id of the second candidate that will be merged. This candidate will cease to exist after the merge is complete.</td> </tr> </tbody></table> <h1 id='close-reasons'>Close Reasons</h1> When closing an opening, it is possible to designate the reason the opening is being closed. This might be "Filled" or "Cancelled" or some other reason. These reasons are configured in Greenhouse. <h2 id='the-close-reason-object'>The close reason object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 230, "name": "Hired" } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The close reason's unique identifier. This is the ID that would be used in POST or PATCH statements involving close reasons.</td> </tr> <tr> <td>name</td> <td>The name of the close reason</td> </tr> </tbody></table> <h2 id='get-list-close-reasons'>GET: List Close Reasons</h2> List all of an organization's close reasons. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X GET 'https://harvest.greenhouse.io/v1/close_reasons' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 365, "name": "Hired" }, { "id": 366, "name": "Backfill" }, { "id": 367, "name": "Order cancelled" } ] </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/close_reasons</code> <a href="#the-close-reason-object">See noteworthy response attributes.</a> <h1 id='custom-fields'>Custom Fields</h1> An organization's custom_fields. <h2 id='the-custom-field-object'>The custom field object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123456, "name": "Seniority Level", "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", "description": "Seniority of this role", "expose_in_job_board_api": true, "api_only": false, "offices": [ { "id": 11915, "name": "New York", "location": { "name": "New York, New York, United States" }, "primary_contact_user_id": null, "parent_id": null, "parent_office_external_id": null, "child_ids": [], "child_office_external_ids": [], "external_id": null } ], "departments": [], "template_token_string": "{{SENIORITY}}", "custom_field_options": [ { "id": 123, "name": "Junior", "priority": 1, "external_id": "jr" }, { "id": 234, "name": "Senior", "priority": 2, "external_id": null } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The custom field's unique identifier</td> </tr> <tr> <td>name</td> <td>The field's name in Greenhouse</td> </tr> <tr> <td>active</td> <td>Boolean value which is false if the custom field has been deleted, true otherwise.</td> </tr> <tr> <td>field_type</td> <td>One of job, candidate, application, offer, opening, rejection_question, referral_question, or user_attribute. This is also included in the URL as an argument, which will return only custom fields that match the given type.</td> </tr> <tr> <td>priority</td> <td>Numeric field used for ordering in Greenhouse.</td> </tr> <tr> <td>value_type</td> <td>One of short_text, long_text, yes_no, single_select, multi_select, currency, currency_range, number, number_range, date, url, or user. For the user_attribute field type, only the following value types are supported currently: single_select, multi_select, yes_no, and user</td> </tr> <tr> <td>private</td> <td>Boolean value to say if this field is private in Greenhouse.</td> </tr> <tr> <td>required</td> <td>The object this field exists on can not be saved if this value is not set.</td> </tr> <tr> <td>require_approval</td> <td>Only applicable to job and opening custom fields, changes to this fields requires an approval flow in Greenhouse to be re-done.</td> </tr> <tr> <td>trigger_new_version</td> <td>Only applicable to offer custom fields, changes to this field creates a new offer version.</td> </tr> <tr> <td>name_key</td> <td>Listed 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.</td> </tr> <tr> <td>custom_field_options</td> <td>For single_select and multi_select field_types, this is the list of options for that select.</td> </tr> <tr> <td>custom_field_options.priority</td> <td>Numeric value used for ordering the custom field options.</td> </tr> <tr> <td>custom_field_options.external_id</td> <td>String value, the external_id for the custom field option</td> </tr> <tr> <td>description</td> <td>The custom field's description</td> </tr> <tr> <td>expose_in_job_board_api</td> <td>Boolean. Only relevant for Job custom fields. If true, then the field will be shown in the Job Board API.</td> </tr> <tr> <td>api_only</td> <td>Boolean. Only relevant for Job custom fields. If true, this custom field can only be edited from the API.</td> </tr> <tr> <td>offices</td> <td>Only relevant for Job, Opening, and Offer custom fields. If this custom field only applies to a subset of offices, then this list contains each office. Otherwise, if the list is empty, it applies to all offices.</td> </tr> <tr> <td>departments</td> <td>Only relevant for Job, Opening, and Offer custom fields. If this custom field only applies to a subset of departments, then this list contains each department. Otherwise, if the list is empty, it applies to all departments.</td> </tr> <tr> <td>template_token_string</td> <td>Token string used in email and offer document templates</td> </tr> </tbody></table> <h2 id='get-list-custom-fields'>GET: List Custom Fields</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/custom_fields/{field_type}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123456, "name": "Custom Field Name", "active": true, "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", "description": "Field description", "expose_in_job_board_api": false, "api_only": false, "offices": [], "departments": [], "template_token_string": "{{FIELD1}}", "custom_field_options": [ { "id": 123, "name": "Name One", "priority": 1, "external_id": "name-one" }, { "id": 234, "name": "Name Two", "priority": 2, "external_id": null } ] } ] </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/custom_fields/{field_type}</code> <h3 id='url-parameters'>URL parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*field_type</td> <td>Returns 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. One of: <code>offer</code>, <code>candidate</code>, <code>application</code>, <code>job</code>, <code>rejection_question</code>, <code>referral_question</code>, <code>user_attribute</code>.</td> </tr> </tbody></table> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>include_inactive</td> <td>When <code>true</code>, include inactive custom fields. Otherwise excludes inactive custom fields. Defaults to <code>false</code>.</td> </tr> </tbody></table> <a href="#the-custom-field-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-retrieve-custom-field'>GET: Retrieve Custom Field</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/custom_field/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123456, "name": "Custom Field Name", "active": true, "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", "description": "Field description", "expose_in_job_board_api": false, "api_only": false, "offices": [], "departments": [], "template_token_string": "{{FIELD1}}", "custom_field_options": [ { "id": 123, "name": "Name One", "priority": 1, "external_id": "name-one" }, { "id": 234, "name": "Name Two", "priority": 2, "external_id": null } ] } </code></pre></div><h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/custom_field/{id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the custom field to retrieve</td> </tr> </tbody></table> <a href="#the-custom-field-object">See noteworthy response attributes.</a> <h2 id='the-custom-field-options-object'>The custom field options object</h2> Refers to the options available for single-select and multi-select custom fields. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123456, "name": "Option A", "priority": 0, "external_id": "option-a" } </code></pre></div><h3 id='noteworthy-attributes-2'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>priority</td> <td>Numeric field used for ordering in Greenhouse.</td> </tr> <tr> <td>external_id</td> <td>String field, the external_id for the custom field option.</td> </tr> </tbody></table> <h2 id='post-create-custom-field'>POST: Create Custom Field</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/custom_fields/' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "name": "Custom Field Name", "field_type": "application", "value_type": "single_select", "private": false, "generate_email_token": true, "required": false, "require_approval": false, "expose_in_job_board_api": true, "api_only": false, "trigger_new_version": false, "office_ids": [123, 456], "department_ids": [567, 890], "custom_field_options": [ { "name": "Name One", "priority": 1, "external_id": "name-one" }, { "name": "Name Two", "priority": 2, "external_id": null } ] } </code></pre></div> <blockquote> If successful, the above command returns a 201 response code along with a JSON representation of the newly created custom field. The JSON structure looks like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123456, "name": "Custom Field Name", "active": true, "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", "description": "Field description", "expose_in_job_board_api": false, "api_only": false, "offices": [], "departments": [], "template_token_string": "{{FIELD1}}", "custom_field_options": [ { "id": 123, "name": "Name One", "priority": 1, "external_id": "name-one" }, { "id": 234, "name": "Name Two", "priority": 2, "external_id": null } ] } ] </code></pre></div><h3 id='http-request-3'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/custom_fields</code> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>name</td> <td>string</td> <td>yes</td> <td>The field's name in Greenhouse</td> </tr> <tr> <td>description</td> <td>string</td> <td>no</td> <td>The field's description in Greenhouse</td> </tr> <tr> <td>field_type</td> <td>string</td> <td>yes</td> <td>One of job, candidate, application, offer, opening, rejection_question, referral_question, user_attribute.</td> </tr> <tr> <td>value_type</td> <td>string</td> <td>yes</td> <td>One of short_text, long_text, yes_no, single_select, multi_select, currency, currency_range, number, number_range, date, url, or user. For the user_attribute field type, only the following value types are supported currently: single_select, multi_select, yes_no, and user</td> </tr> <tr> <td>private</td> <td>boolean</td> <td>no</td> <td>Boolean value to say if this field is private in Greenhouse. Defaults to false if not provided for non-offer custom fields. For offer custom fields, private is always true.</td> </tr> <tr> <td>required</td> <td>boolean</td> <td>no</td> <td>Boolean value to determine if this field must be filled out in order to save the custom field. Only used for job, offer, and opening type custom fields. Defaults to false.</td> </tr> <tr> <td>require_approval</td> <td>boolean</td> <td>no</td> <td>Boolean value to determine if changes to this custom field triggers re-approvals. Only used for job and opening custom fields. Defaults to false.</td> </tr> <tr> <td>trigger_new_version</td> <td>boolean</td> <td>no</td> <td>Boolean value to determine if changes to this field triggers the automatic creation of a new offer version. Only used in offer custom fields. Defaults to false.</td> </tr> <tr> <td>expose_in_job_board_api</td> <td>boolean</td> <td>no</td> <td>Boolean value to determine if this custom field and its value will be provided in the Job Board API response for this job. These fields are included in the metadata section of the Job Board API response. Only used in job custom fields. Defaults to false.</td> </tr> <tr> <td>api_only</td> <td>boolean</td> <td>no</td> <td>Boolean value to determine if updates to this custom field may only be made via Harvest. Only used in job custom fields. Defaults to false. If this feature is not available for your organization, attempting to create a field with this set to true will return an API Error.</td> </tr> <tr> <td>office_ids</td> <td>Array of integers</td> <td>no</td> <td>If included, this custom field is only displayed on objects associated with these offices. This is only used for job, opening, and offer custom fields. If not included, custom field will be shown for all offices.</td> </tr> <tr> <td>department_ids</td> <td>Array of integers</td> <td>no</td> <td>If included, this custom field is only displayed on objects associated with these departments. This is only used for job, opening, and offer custom fields. If not included, custom field will be shown for all departments.</td> </tr> <tr> <td>custom_field_options</td> <td>array of Custom Field Options</td> <td>yes for some field_type</td> <td>For single_select and multi_select field_types, this is the list of options for that select.</td> </tr> <tr> <td>custom_field_options.name</td> <td>string</td> <td>yes</td> <td>The name of the new custom field option.</td> </tr> <tr> <td>custom_field_options.priority</td> <td>integer</td> <td>yes</td> <td>Numeric value used for ordering the custom field options.</td> </tr> <tr> <td>custom_field_options.external_id</td> <td>string</td> <td>no</td> <td>The external_id for the custom field. Used for integrating with external HRIS.</td> </tr> <tr> <td>generate_email_token</td> <td>boolean</td> <td>no</td> <td>If this is sent as true, a default <code>template_token_string</code> will be generated for the new Custom Field.</td> </tr> </tbody></table> <h2 id='patch-update-custom-field'>PATCH: Update Custom Field</h2> This endpoint updates an existing custom field. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/custom_fields/{id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkeODyN2VhZmEMWRjMzc1YZjMqmUwNjsdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "name": "New Name", "description": "New description", "private": false, "template_token_string": "token123" } </code></pre></div> <blockquote> If the update is successful, the above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123456, "name": "New Name", "active": true, "field_type": "job", "priority": 1, "value_type": "single_select", "private": false, "required": false, "require_approval": true, "trigger_new_version": false, "name_key": "custom_field_name", "description": "New description", "expose_in_job_board_api": false, "api_only": false, "offices": [], "departments": [], "template_token_string": "{{token123}}", "custom_field_options": [ { "id": 123, "name": "Name One", "priority": 1, "external_id": "name-one" }, { "id": 234, "name": "Name Two", "priority": 2, "external_id": null } ] } ] </code></pre></div><h3 id='http-request-4'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/custom_fields/{id}</code> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the custom field to update</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> This endpoint accepts the same JSON body parameters as the <a href="#post-create-custom-field">Create Custom Field endpoint</a>. There is one exception - instead of the <code>generate_email_token</code> field which is used during creation, the <code>template_token_string</code> field can be used to set or change the template token on an existing custom field. <table><thead> <tr> <th>Attribute</th> <th>Type</th> <th>Required</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>template_token_string</td> <td>string</td> <td>no</td> <td>Sets the template token which is used in email and offer document templates.</td> </tr> </tbody></table> <h2 id='delete-delete-custom-field'>DELETE: Delete Custom Field</h2> This endpoint deletes a custom field. Note that custom fields are soft-deleted in order to maintain historical data. Soft-deleted custom fields will be hidden to users but will continue to be returned in the API with their <code>active</code> flag set to <code>false</code>. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/custom_fields/{id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkeODyN2VhZmEMWRjMzc1YZjMqmUwNjsdlMjQ6" </code></pre></div> <blockquote> If the deletion is successful, the above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": "Custom Field ID 12345 has been deleted." } </code></pre></div><h3 id='http-request-5'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/custom_fields/{id}</code> <h3 id='url-parameters-4'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the custom field to delete</td> </tr> </tbody></table> <h2 id='get-list-custom-field-options'>GET: List Custom Field Options</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123456, "name": "Option A", "priority": 0, "external_id": "option-a" }, { "id": 123457, "name": "Option B", "priority": 1, "external_id": "option-b" }, { "id": 123458, "name": "Option C", "priority": 2, "external_id": null } ] </code></pre></div> Given a single select or multi select custom field, return all its options. <h3 id='http-request-6'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options</code> <h3 id='querystring-parameters-2'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>type</td> <td>One 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.</td> </tr> </tbody></table> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='post-create-custom-field-options'>POST: Create Custom Field Options</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "options": [ {"name": "Option A", "priority": 5, "external_id": "3z84k11"}, {"name": "Option B", "priority": 6, "external_id": "bmlpk1"}, {"name": "Option C", "priority": 7, "external_id": "32290"} ] } </code></pre></div> <blockquote> The above returns a success message on success with a 201 response. </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "success": true } </code></pre></div> Add additional options to a single select or multi select custom field. <h3 id='http-request-7'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-3'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>options</td> <td>Yes</td> <td>array</td> <td>An array of one or many new custom field options.</td> </tr> <tr> <td>name</td> <td>Yes</td> <td>string</td> <td>The 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.</td> </tr> <tr> <td>priority</td> <td>Yes</td> <td>integer</td> <td>This is used to order the custom fields in Greenhouse.</td> </tr> <tr> <td>external_id</td> <td>No</td> <td>string</td> <td>The external_id for the custom field. Used for integrating with external HRIS.</td> </tr> </tbody></table> **This returns a 201 on success. It does not return the objects created. <h2 id='patch-update-custom-field-options'>PATCH: Update Custom Field Options</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "options": [ { "id": 123, "name": "Option A", "priority": 5, "external_id": "3z84k11" }, { "id": 234, "name": "Option B", "priority": 6, "external_id": null }, { "id": 345, "name": "Option C", "priority": 7, "external_id": "32290" } ] } </code></pre></div> <blockquote> The above request returns a JSON success message. </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "success": true } </code></pre></div> Update the names or priorities of existing options in a single select or multi select custom field. <h3 id='http-request-8'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-4'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>options</td> <td>Yes</td> <td>array</td> <td>An array of one or many new custom field options.</td> </tr> <tr> <td>id</td> <td>Yes</td> <td>integer</td> <td>The ID of the custom field option that will be updated.</td> </tr> <tr> <td>name</td> <td>No</td> <td>string</td> <td>If 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.</td> </tr> <tr> <td>priority</td> <td>No</td> <td>integer</td> <td>If included, The custom field option with this ID will be updated with this value.</td> </tr> <tr> <td>external_id</td> <td>No</td> <td>string</td> <td>If included, the custom field option will update its external_id with this value. Passing <code>null</code> will clear the external_id.</td> </tr> </tbody></table> <h2 id='delete-remove-custom-field-options'>DELETE: Remove Custom Field Options</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>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" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "option_ids": [ 85709, 85710 ] } </code></pre></div> <blockquote> 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. </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "message": "3 option(s) deleted. 1 option(s) not found." } </code></pre></div> Destroy custom field options <h3 id='http-request-9'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/custom_field/{id}/custom_field_options</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-5'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>option_ids</td> <td>Yes</td> <td>array</td> <td>An array of the custom field option ids to be removed.</td> </tr> </tbody></table> * 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. <h1 id='demographic-data'>Demographic Data</h1> Demographic questions and answers submitted during the application process. For more information on Greenhouse Inclusion, please visit <a href="https://www.greenhouse.io/inclusion">https://www.greenhouse.io/inclusion</a>. <h2 id='the-demographic-question-set-object'>The Demographic Question Set object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 1991, "title": "Question Set", "description": "Questions for candidates", "active": true } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The demographic question set's unique identifier</td> </tr> <tr> <td>title</td> <td>The title of the demographic question set</td> </tr> <tr> <td>description</td> <td>The demographic question set's description. This is a rich text field which may contain HTML.</td> </tr> <tr> <td>active</td> <td>If <code>false</code>, the demographic question set has been deleted.</td> </tr> </tbody></table> <h2 id='the-demographic-question-object'>The Demographic Question object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123, "active": true, "demographic_question_set_id": 456, "name": "What is your favorite color?", "translations": [ { "language": "en", "name": "What is your favorite color?" } ], "required": true, "answer_type": "multi_value_multi_select" } </code></pre></div><h3 id='noteworthy-attributes-2'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The demographic question's unique identifier</td> </tr> <tr> <td>demographic_question_set_id</td> <td>The demographic question set that this belongs to</td> </tr> <tr> <td>name</td> <td>The question text</td> </tr> <tr> <td>translations.language</td> <td>Translations have been deprecated but are kept for backwards compatibility. Only <code>en</code> (English) is supported at this time.</td> </tr> <tr> <td>translations.name</td> <td>Translations have been deprecated but are kept for backwards compatibility. This value will be the same as <code>name</code> above.</td> </tr> <tr> <td>active</td> <td>If <code>false</code>, the question has been deleted.</td> </tr> <tr> <td>required</td> <td>If <code>true</code>, the question must be filled out by the applicant.</td> </tr> <tr> <td>answer_type</td> <td>The type of answer that can be provided for the question. Value will be either <code>multi_value_single_select</code> or <code>multi_value_multi_select</code>.</td> </tr> </tbody></table> <h2 id='the-demographic-answer-option-object'>The Demographic Answer Option object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 456, "free_form": false, "active": true, "name": "Blue", "demographic_question_id": 123, "translations": [ { "language": "en", "name": "Blue" } ] } </code></pre></div><h3 id='noteworthy-attributes-3'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The demographic answer option's unique identifier</td> </tr> <tr> <td>name</td> <td>The answer option text</td> </tr> <tr> <td>translations.language</td> <td>Translations have been deprecated but are kept for backwards compatibility. Only <code>en</code> (English) is supported at this time.</td> </tr> <tr> <td>translations.name</td> <td>Translations have been deprecated but are kept for backwards compatibility. This value will be the same as <code>name</code> above.</td> </tr> <tr> <td>active</td> <td>If <code>false</code>, the answer option has been deleted.</td> </tr> <tr> <td>free_form</td> <td>If <code>true</code>, the answer option allows free-form user input.</td> </tr> <tr> <td>demographic_question_id</td> <td>The demographic question for which the answer option belongs to.</td> </tr> </tbody></table> <h2 id='the-demographic-answer-object'>The Demographic Answer object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 51, "free_form_text": "12am", "application_id": 107594341, "demographic_question_id": 25, "demographic_answer_option_id": 106, "created_at": "2019-04-29T18:46:03.707Z", "updated_at": "2019-04-29T18:46:03.707Z" } </code></pre></div><h3 id='noteworthy-attributes-4'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The demographic answer's unique identifier</td> </tr> <tr> <td>free_form_text</td> <td>If the selected answer option is free-form, this is the value given by the user. Otherwise <code>null</code>.</td> </tr> <tr> <td>application_id</td> <td>The application for which the demographic question was answered</td> </tr> <tr> <td>demographic_question_id</td> <td>The demographic question which was answered.</td> </tr> <tr> <td>demographic_answer_option_id</td> <td>The demographic answer option which was selected.</td> </tr> </tbody></table> <h2 id='get-list-demographic-question-sets'>GET: List Demographic Question Sets</h2> List all of an organization's demographic question sets. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/question_sets' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 1991, "title": "Question Set A", "description": "Questions for US candidates", "active": true }, { "id": 1992, "title": "Question Set B", "description": "Questions for European candidates", "active": true } ] </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/question_sets</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> </tbody></table> <a href="#the-demographic-question-set-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-retrieve-demographic-question-set'>GET: Retrieve Demographic Question Set</h2> Retrieve a demographic question set by its <code>id</code>. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/question_sets/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 1991, "title": "Question Set", "description": "Questions for candidates", "active": true } </code></pre></div><h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/question_sets/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the demographic question set you want to retrieve.</td> </tr> </tbody></table> <a href="#the-demographic-question-set-object">See noteworthy response attributes.</a> <h2 id='get-list-demographic-questions'>GET: List Demographic Questions</h2> List all of an organization's demographic questions. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/questions' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "active": true, "demographic_question_set_id": 456, "name": "What is your favorite color?", "translations": [ { "language": "en", "name": "What is your favorite color?" } ], "required": true }, { "id": 897, "active": true, "demographic_question_set_id": 555, "name": "Pizza or pasta?", "translations": [ { "language": "en", "name": "Pizza or pasta?" } ], "required": false } ] </code></pre></div><h3 id='http-request-3'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/questions</code> <h3 id='querystring-parameters-2'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> </tbody></table> <a href="#the-demographic-question-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-list-demographic-questions-for-demographic-question-set'>GET: List Demographic Questions For Demographic Question Set</h2> List all of the demographic questions for a demographic question set. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/question_sets/{id}/questions' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "active": true, "demographic_question_set_id": 456, "name": "What is your favorite color?", "translations": [ { "language": "en", "name": "What is your favorite color?" } ], "required": true }, { "id": 897, "active": true, "demographic_question_set_id": 555, "name": "Pizza or pasta?", "translations": [ { "language": "en", "name": "Pizza or pasta?" } ], "required": false } ] </code></pre></div><h3 id='http-request-4'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/question_sets/{id}/questions</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the demographic question set for which you want to retrieve demographic questions</td> </tr> </tbody></table> <h3 id='querystring-parameters-3'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> </tbody></table> <a href="#the-demographic-question-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-retrieve-demographic-question'>GET: Retrieve Demographic Question</h2> Retrieve a demographic question by its <code>id</code>. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/questions/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123, "active": true, "demographic_question_set_id": 456, "name": "What is your favorite color?", "translations": [ { "language": "en", "name": "What is your favorite color?" } ], "required": true } </code></pre></div><h3 id='http-request-5'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/questions/{id}</code> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the demographic question you want to retrieve.</td> </tr> </tbody></table> <a href="#the-demographic-question-object">See noteworthy response attributes.</a> <h2 id='get-list-demographic-answer-options'>GET: List Demographic Answer Options</h2> List all of an organization's demographic answer options. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/answer_options' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 456, "free_form": false, "active": true, "name": "Blue", "demographic_question_id": 123, "translations": [ { "language": "en", "name": "Blue" } ] }, { "id": 789, "free_form": true, "active": true, "name": "Other", "demographic_question_id": 123, "translations": [ { "language": "en", "name": "Other" } ] } ] </code></pre></div><h3 id='http-request-6'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/answer_options</code> <h3 id='querystring-parameters-4'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> </tbody></table> <a href="#the-demographic-answer-option-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-list-demographic-answer-options-for-demographic-question'>GET: List Demographic Answer Options For Demographic Question</h2> List all of the demographic answer options for a demographic question. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/questions/{id}/answer_options' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 456, "free_form": false, "active": true, "name": "Blue", "demographic_question_id": 123, "translations": [ { "language": "en", "name": "Blue" } ] }, { "id": 789, "free_form": true, "active": true, "name": "Other", "demographic_question_id": 123, "translations": [ { "language": "en", "name": "Other" } ] } ] </code></pre></div><h3 id='http-request-7'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/questions/{id}/answer_options</code> <h3 id='url-parameters-4'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the demographic question for which you want to retrieve demographic answer options.</td> </tr> </tbody></table> <h3 id='querystring-parameters-5'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> </tbody></table> <a href="#the-demographic-answer-option-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-retrieve-demographic-answer-option'>GET: Retrieve Demographic Answer Option</h2> Retrieve a demographic answer option by its <code>id</code>. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/answer_options/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 456, "free_form": false, "active": true, "name": "Blue", "demographic_question_id": 123, "translations": [ { "language": "en", "name": "Blue" } ] } </code></pre></div><h3 id='http-request-8'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/answer_options/{id}</code> <h3 id='url-parameters-5'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the demographic answer option you want to retrieve.</td> </tr> </tbody></table> <a href="#the-demographic-answer-option-object">See noteworthy response attributes.</a> <h2 id='get-list-demographic-answers'>GET: List Demographic Answers</h2> List all of an organization's demographic answers. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/answers' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "free_form_text": "12am", "application_id": 787, "demographic_question_id": 25, "demographic_answer_option_id": 106, "created_at": "2019-04-29T18:46:03.707Z", "updated_at": "2019-04-29T18:46:03.707Z" }, { "id": 456, "free_form_text": null, "application_id": 783, "demographic_question_id": 29, "demographic_answer_option_id": 109, "created_at": "2017-01-29T15:09:46.806Z", "updated_at": "2017-01-29T15:09:46.806Z" } ] </code></pre></div><h3 id='http-request-9'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/answers</code> <h3 id='querystring-parameters-6'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*created_before</td> <td>Return only answers created before this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>*created_after</td> <td>Return only answers created at or after this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>*updated_before</td> <td>Return only answers updated before this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>*updated_after</td> <td>Return only answers updated at or after this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> </tbody></table> <a href="#the-demographic-answer-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-list-demographic-answers-for-application'>GET: List Demographic Answers For Application</h2> List all of the demographic answers for an application. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/applications/{id}/demographics/answers' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "free_form_text": "12am", "application_id": 787, "demographic_question_id": 25, "demographic_answer_option_id": 106, "created_at": "2019-04-29T18:46:03.707Z", "updated_at": "2019-04-29T18:46:03.707Z" }, { "id": 456, "free_form_text": null, "application_id": 787, "demographic_question_id": 29, "demographic_answer_option_id": 109, "created_at": "2017-01-29T15:09:46.806Z", "updated_at": "2017-01-29T15:09:46.806Z" } ] </code></pre></div><h3 id='http-request-10'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications/{id}/demographics/answers</code> <h3 id='url-parameters-6'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the application for which you want to retrieve demographic answers.</td> </tr> </tbody></table> <h3 id='querystring-parameters-7'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*created_before</td> <td>Return only answers created before this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>*created_after</td> <td>Return only answers created at or after this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>*updated_before</td> <td>Return only answers updated before this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>*updated_after</td> <td>Return only answers updated at or after this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> </tbody></table> <a href="#the-demographic-answer-object">See noteworthy response attributes.</a> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-retrieve-demographic-answer'>GET: Retrieve Demographic Answer</h2> Retrieve a demographic answer by its <code>id</code>. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/demographics/answers/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123, "free_form_text": "12am", "application_id": 787, "demographic_question_id": 25, "demographic_answer_option_id": 106, "created_at": "2019-04-29T18:46:03.707Z" } </code></pre></div><h3 id='http-request-11'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/demographics/answers/{id}</code> <h3 id='url-parameters-7'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the demographic answer you want to retrieve.</td> </tr> </tbody></table> <a href="#the-demographic-answer-object">See noteworthy response attributes.</a> <h1 id='departments'>Departments</h1><h2 id='the-department-object'>The department object</h2> An organization's departments. <blockquote> With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 12345, "name": "Technology", "parent_id": 12345, "parent_department_external_id": "parent-1", "child_ids": [ 34065, 25908 ], "child_department_external_ids": [ "child-1", "child-2" ], "external_id": "89076" } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 12345, "name": "Technology", "children": [ { "id": 34065, "name": "Design", "children": [], "external_id": "32526" }, { "id": 25908, "name": "Engineering", "children": [ { "id": 14510, "name": "Third-Level Department", "children": [ { "id": 14502, "name": "Strategy", "children": [], "external_id": null } ], "external_id": "56735" } ], "external_id": "47658" } ], "external_id": "26758" } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The department's unique identifier</td> </tr> <tr> <td>name</td> <td>The department's name</td> </tr> <tr> <td>external_id</td> <td>An arbitrary ID provided by an external source; does not map to another entity in Greenhouse.</td> </tr> <tr> <td>parent_department_external_id</td> <td>The external_id of this department's parent.</td> </tr> <tr> <td>parent_department_child_ids</td> <td>the external_ids of this department's children. Note the order of this array may not match the order of the child_ids array. If there are five children and none of them have parent ids, this array will contain five null indices.</td> </tr> </tbody></table> <h2 id='get-list-departments'>GET: List Departments</h2> List all of an organization's departments. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/departments' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this, with <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 12345, "name": "Technology", "parent_id": null, "parent_department_external_id": "", "child_ids": [ 34065, 25908 ], "child_department_external_ids": [ "child-1", "child-2" ], "external_id": "89076" }, { "id": 67890, "name": "Administration", "parent_id": 54647, "parent_department_external_id": "parent-1", "child_ids": [], "child_department_external_ids": [], "external_id": null } ] </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 12345, "name": "Technology", "children": [ { "id": 34065, "name": "Design", "children": [], "external_id": "32526" }, { "id": 25908, "name": "Engineering", "children": [ { "id": 14510, "name": "Third-Level Department", "children": [], "external_id": "56735" } ], "external_id": "47658" } ], "external_id": "26758" }, { "id": 67890, "name": "Administration", "parent_id": 54647, "child_ids": [], "external_id": null } ] </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/departments</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving departments will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>render_as</td> <td>This 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 <code>children</code>.</td> </tr> <tr> <td>external_id</td> <td>If supplied, only return department(s) with that external ID.</td> </tr> </tbody></table> <a href="#the-department-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-department'>GET: Retrieve Department</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/departments/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 12345, "name": "Technology", "parent_id": null, "parent_department_external_ids": "", "child_ids": [ 34065, 25908 ], "child_department_external_ids": [ "child-1", "child-2" ], "external_id": "89076" } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 12345, "name": "Technology", "children": [ { "id": 34065, "name": "Design", "children": [], "external_id": "32526" }, { "id": 25908, "name": "Engineering", "children": [ { "id": 14510, "name": "Third-Level Department", "children": [], "external_id": "56735" } ], "external_id": "47658" } ], "external_id": "26758" } { "id": 67890, "name": "Administration", "parent_id": 54647, "child_ids": [], "external_id": null } </code></pre></div> Retrieve a department by its <code>id</code>. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/departments/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the department to retrieve</td> </tr> </tbody></table> <h3 id='querystring-parameters-2'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>render_as</td> <td>This 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 <code>children</code>.</td> </tr> </tbody></table> <a href="#the-department-object">See noteworthy response attributes.</a> <h2 id='patch-edit-department'>PATCH: Edit Department</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/departments/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "name": "Engineering", "external_id": "EXTERNAL_ID_1234" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 45644, "name": "Engineering", "parent_id": null, "parent_department_external_id": "", "child_ids": [ 34065, 25908 ], "child_department_external_ids": [ "child-1", "child-2" ], "external_id": "EXTERNAL_ID_1234" } </code></pre></div> Edit a department's basic information. <h3 id='http-request-3'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/departments/{id}</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>name</td> <td>Yes</td> <td>string</td> <td>The department's name. If included, this cannot be blank.</td> </tr> <tr> <td>external_id*</td> <td>No</td> <td>string</td> <td>The department's external ID. If included, this must be unique to this department within the organization.</td> </tr> </tbody></table> * - If the external id feature is not enabled for your organization, attempting to edit this field will raise an API Error. <h2 id='post-add-department'>POST: Add Department</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/departments -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "name": "A New Department", "parent_id": 12345, "external_id": "456454" } or { "name": "A New Department", "external_parent_id": "parent-1", "external_id": "456454" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 34535, "name": "A New Department", "parent_id": 12345, "parent_department_external_ids": "parent-1", "child_ids": [], "child_department_external_ids": [], "external_id": "456454" } </code></pre></div> Create a new department <h3 id='http-request-4'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/departments</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes. Must be a user who can create departments.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>name</td> <td>yes</td> <td>string</td> <td>The name of your new department. Must be less than 255 characters and unique within your organization.</td> </tr> <tr> <td>parent_id*</td> <td>no</td> <td>number</td> <td>The department id for the new department to be nested under. If this isn't included, the department will be created at the top level.</td> </tr> <tr> <td>external_parent_id**</td> <td>no</td> <td>string</td> <td>The external id of the parent departments. This may be used instead of parent_id. Only one of this or parent_id may be populated. If both are included, it will raise an error.</td> </tr> <tr> <td>external_id**</td> <td>no</td> <td>string</td> <td>The external_id for the office.</td> </tr> </tbody></table> * - The tiered department feature is available only for customers with the Advanced or Expert Greenhouse Recruiting package. Use of this field will return an error for other Greenhouse Recruiting customers. ** - The external_id feature is available only for customers with the Expert Greenhouse Recruiting package. Use of this field will return an error for other Greenhouse Recruiting customers. <h1 id='education'>Education</h1> These endpoints are used to manage the list of education fields in Greenhouse. <h2 id='the-education-objects'>The education objects</h2> Each of the education objects contain an <code>id</code>, <code>name</code>, and <code>priority</code>. When ordering occurs, the items are organized by their priority number. <code> { "id": 1234, "name": "Siena College", "priority": 1 } </code> <h2 id='get-list-degrees'>GET: List Degrees</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/degrees' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "name": "Bachelor's Degree", "priority": 0 }, { "id": 234, "name": "Master's Degree", "priority": 1 } ] </code></pre></div> List all this organization's degree levels. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/degrees</code> This endpoint retrieves all the degree and/or education levels for this organization, sorted by priority. <a href="#the-education-objects">See education object.</a> <h2 id='get-list-disciplines'>GET: List Disciplines</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/disciplines' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "name": "Accounting", "priority": 0 }, { "id": 234, "name": "Biology", "priority": 1 } ] </code></pre></div> List all this organization's disciplines. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/disciplines</code> This endpoint retrieves all the disciplines for this organization, sorted by priority. <a href="#the-education-objects">See education object.</a> <h2 id='get-list-schools'>GET: List Schools</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/schools' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "name": "Siena College", "priority": 0 }, { "id": 234, "name": "Union College", "priority": 1 } ] </code></pre></div> List all this organization's schools. <h3 id='http-request-3'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/schools</code> This endpoint retrieves all the schools for this organization, sorted by priority. <a href="#the-education-objects">See education object.</a> <h1 id='eeoc'>EEOC</h1><h2 id='the-eeoc-object'>The EEOC object</h2> Every application may have zero or one EEOC object. <div class="highlight"><pre class="highlight json tab-json"><code>{ "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 have a history/record of having a disability" }, "submitted_at": "2017-01-29T15:09:46.806Z" } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>application_id</td> <td>Application ID</td> </tr> <tr> <td>candidate_id</td> <td>The ID of the <a href="#candidates">candidate</a> who is applying for the job associated with this application.</td> </tr> <tr> <td>race</td> <td>See the EEOC Reference below</td> </tr> <tr> <td>gender</td> <td>See the EEOC Reference below</td> </tr> <tr> <td>veteran_status</td> <td>See the EEOC Reference below</td> </tr> <tr> <td>disability_status</td> <td>See the EEOC Reference below</td> </tr> <tr> <td>submitted_at</td> <td>The timestamp in <a href="#general-considerations">ISO-8601</a> at which the EEOC data was submitted.</td> </tr> </tbody></table> <h3 id='eeoc-reference'>EEOC Reference</h3><h3 id='race'>Race</h3> <table><thead> <tr> <th>description</th> </tr> </thead><tbody> <tr> <td>American Indian or Alaskan Native</td> </tr> <tr> <td>Asian</td> </tr> <tr> <td>Black or African American</td> </tr> <tr> <td>Hispanic or Latino</td> </tr> <tr> <td>White</td> </tr> <tr> <td>Native Hawaiian or Other Pacific Islander</td> </tr> <tr> <td>Two or More Races</td> </tr> <tr> <td>Decline To Self Identify</td> </tr> </tbody></table> <h3 id='gender'>Gender</h3> <table><thead> <tr> <th>description</th> </tr> </thead><tbody> <tr> <td>Male</td> </tr> <tr> <td>Female</td> </tr> <tr> <td>Decline To Self Identify</td> </tr> </tbody></table> <h3 id='veteran-status'>Veteran Status</h3> <table><thead> <tr> <th>description</th> </tr> </thead><tbody> <tr> <td>I am not a protected veteran</td> </tr> <tr> <td>I identify as one or more of the classifications of a protected veteran</td> </tr> <tr> <td>I don't wish to answer</td> </tr> </tbody></table> <h3 id='disability-status'>Disability Status</h3> <table><thead> <tr> <th>description</th> </tr> </thead><tbody> <tr> <td>Yes, I have a disability, or have a history/record of having a disability</td> </tr> <tr> <td>No, I don’t have a disability, or a history/record of having a disability</td> </tr> <tr> <td>I don't wish to answer</td> </tr> </tbody></table> <h2 id='get-list-eeoc'>GET: List EEOC</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/eeoc' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "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 have a history/record of having 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 have a history/record of having a disability" }, "submitted_at": "2017-01-30T17:10:32.432Z" } ] </code></pre></div> List all of an organization's EEOC data. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/eeoc</code> <h3 id='query-string-parameters'>Query string parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*submitted_before</td> <td>Return only EEOC data submitted before this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>*submitted_after</td> <td>Return only EEOC data submitted at or after this timestamp. Timestamp must be in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> </tbody></table> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='get-retrieve-eeoc-data-for-application'>GET: Retrieve EEOC Data for Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/applications/{id}/eeoc' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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 have a history/record of having a disability" }, "submitted_at": "2017-01-29T15:09:46.806Z" } </code></pre></div> Retrieve an application's EEOC data by an application ID. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications/{id}/eeoc</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the application whose EEOC data you want to retrieve.</td> </tr> </tbody></table> <h1 id='email-templates'>Email Templates</h1> An organization's email templates. <h2 id='the-email-template-object'>The email template object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 48765, "name": "Default Scorecard Reminder", "description": "To be sent to an interviewer when their scorecard is due.", "default": true, "updated_at": "2018-06-01T17:04:13.598Z", "created_at": "2015-11-18T22:26:32.154Z", "type": "scorecard_reminder", "from": null, "cc": [ "example.user@example.com" ], "body": null, "html_body": "Hello,\r\nPlease help us keep our hiring on track!\r\nSend in your feedback now for the interview you conducted earlier today with {{CANDIDATE_NAME}}.\r\nIt's easy - just visit the following link to fill out your scorecard online: {{SCORECARD_LINK}}\r\nThanks, {{ORGANIZER_NAME}}", "user": null } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The email template's unique identifier</td> </tr> <tr> <td>type</td> <td>One of: <code>new_candidate</code>, <code>weekly_status</code>, <code>daily_recruiting</code>, <code>stage_transition</code>, <code>new_scorecard</code>, <code>new_referral</code>, <code>agency_candidate_status</code>, <code>agency_candidate_stage</code>, <code>take_home_test_email</code>, <code>candidate_auto_reply</code>, <code>candidate_rejection</code>, <code>scorecard_reminder</code>, <code>interviewer_invite</code>, <code>candidate_email</code>, <code>team_email</code>, <code>none</code>, <code>extending_offer</code>, <code>new_agency_submission</code>, <code>non_admin_welcome</code>, <code>job_admin_welcome</code>, <code>site_admin_welcome</code>, <code>prospect_referral_receipt</code>, <code>candidate_referral_receipt</code>, <code>candidate_availability_request</code>, <code>candidate_availability_confirmation</code></td> </tr> <tr> <td>from</td> <td>The user who is set to send the email. If the from address can change based on which user took an action in Greenhouse (e.g. scorecard reminders sent from the person who scheduled the interview), this field will be <code>null</code>.</td> </tr> <tr> <td>body</td> <td>The plain text body of the e-mail (may be <code>null</code>).</td> </tr> <tr> <td>user</td> <td>The user this template belongs to. If null, this is an 'organization wide' template available to everyone.</td> </tr> <tr> <td>html_body</td> <td>The body of the e-mail with html styling code (may be <code>null</code>).</td> </tr> </tbody></table> <h2 id='get-list-email-templates'>GET: List Email Templates</h2> List all of an organization's email templates. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/email_templates/' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 48765, "name": "Default Scorecard Reminder", "description": "To be sent to an interviewer when their scorecard is due.", "default": true, "updated_at": "2018-06-01T17:04:13.598Z", "created_at": "2015-11-18T22:26:32.154Z", "type": "scorecard_reminder", "from": null, "cc": [ "example.user@example.com" ], "body": null, "html_body": "Hello,\r\nPlease help us keep our hiring on track!\r\nSend in your feedback now for the interview you conducted earlier today with {{CANDIDATE_NAME}}.\r\nIt's easy - just visit the following link to fill out your scorecard online: {{SCORECARD_LINK}}\r\nThanks, {{ORGANIZER_NAME}}", "user": null }, { "id": 200008, "name": "Personal Candidate Email Template", "description": "To email candidates", "default": false, "updated_at": "2018-06-01T17:08:03.320Z", "created_at": "2018-06-01T17:08:03.320Z", "type": "candidate_email", "from": "{{MY_EMAIL_ADDRESS}}", "cc": [], "body": null, "html_body": "Hi&nbsp;{{CANDIDATE_FIRST_NAME}}, Please let me know if you're still interested in&nbsp;{{JOB_NAME}}. Thank you! {{MY_SIGNATURE}}", "user": { "id": 297349, "first_name": "Jane", "last_name": "Smith", "name": "Jane Smith", "employee_id": "12345" } } ] </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/email_templates</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving email templates will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only email templates that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only email templates that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only email templates that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only email templates that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> </tbody></table> <a href="#the-email-template-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-email-template'>GET: Retrieve Email Template</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/email_templates/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 48765, "name": "Default Scorecard Reminder", "description": "To be sent to an interviewer when their scorecard is due.", "default": true, "updated_at": "2018-06-01T17:04:13.598Z", "created_at": "2015-11-18T22:26:32.154Z", "type": "scorecard_reminder", "from": null, "cc": [ "example.user@example.com" ], "body": null, "html_body": "Hello,\r\nPlease help us keep our hiring on track!\r\nSend in your feedback now for the interview you conducted earlier today with {{CANDIDATE_NAME}}.\r\nIt's easy - just visit the following link to fill out your scorecard online: {{SCORECARD_LINK}}\r\nThanks, {{ORGANIZER_NAME}}", "user": null } </code></pre></div> Retrieve an email template by its <code>id</code>. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/email_templates/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the email template to retrieve</td> </tr> </tbody></table> <a href="#the-email-template-object">See noteworthy response attributes.</a> <h1 id='job-openings'>Job Openings</h1> This endpoint is used to managing openings on jobs. <h2 id='the-job-opening-object'>The job opening object</h2><div class="highlight"><pre class="highlight json tab-json"><code>[ { "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, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "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" }, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } } ] </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy Attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The opening's unique identifier</td> </tr> <tr> <td>opening_id</td> <td>This is a text string used to identify the opening. This is defined by the users and may be null.</td> </tr> <tr> <td>status</td> <td>Either "open" or "closed"</td> </tr> <tr> <td>opened_at</td> <td>This is the date and time this opening was opened.</td> </tr> <tr> <td>closed_at</td> <td>This is when the opening was closed; usually via the opening being filled. This should be null for opened openings.</td> </tr> <tr> <td>application_id</td> <td>The application that was used to fill this opening. This should only be set on a closed opening, null otherwise.</td> </tr> <tr> <td>custom_fields</td> <td>These are the custom fields that are specific to openings. This index, along with keyed_custom_fields, may not be included if your organization does not have access to custom fields on openings.</td> </tr> </tbody></table> <h2 id='get-list-job-openings'>GET: List Job Openings</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "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, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "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" }, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } } ] </code></pre></div> List all of a job's openings <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{job_id}/openings</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>The ID of the job for which you want to retrieve openings.</td> </tr> </tbody></table> <h3 id='querystring-parameters'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>status</td> <td>May 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.</td> </tr> </tbody></table> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <a href="#the-job-opening-object">See noteworthy response attributes.</a> <h2 id='get-single-opening-for-job'>GET: Single Opening For Job</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "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, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } } </code></pre></div> Retrieve the information for a single opening. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>The ID of the job for which you want to retrieve openings.</td> </tr> <tr> <td>id</td> <td>The ID of the opening you want to retrieve. Note: this is NOT the <code>opening_id</code> which is mutable and defined by Greenhouse users, but the <code>id</code> of an opening, which is unique to that opening and not mutable.</td> </tr> </tbody></table> <a href="#the-job-opening-object">See noteworthy response attributes.</a> <h2 id='delete-destroy-openings'>DELETE: Destroy Openings</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "ids": [123, 456, 789] } </code></pre></div><h3 id='http-request-3'>HTTP Request</h3> DEPRECATED <del><code>DELETE https://harvest.greenhouse.io/v1/jobs/{job_id}/openings</code></del> <code>DELETE https://harvest.greenhouse.io/v2/jobs/{job_id}/openings</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>ids</td> <td>yes</td> <td>Array</td> <td>An array of opening ids to delete. Important to note that these are not <code>opening_id</code> from the other endpoints, but the unique <code>id</code> identifier.</td> </tr> </tbody></table> Notes: The v1 version of this endpoint has been deprecated because it allowed integrations to delete open or filled openings that were otherwise prevented by data validations in the Greenhouse Recruiting UI. The v2 version of this endpoint only allows closed, unfilled openings to be deleted and respects data validation rules as they exist in Greenhouse Recruiting. When the v1 endpoint is deprecated, some integrations may experience errors if they relied on deleting active or filled openings. Since the behavior adheres to the data validation guidelines established in Greenhouse Recruiting, Greenhouse does not consider these issues a breaking change. In the v2 version, response messages will include both IDs that were successfully deleted and any IDs that could not be deleted. Failed deletions can occur for a number of reasons, including the following examples: - The provided ID does not exist - The provided ID leads to an opening tied to an application or offer - The opening is currently open for applications If the organization has deactivated the ability to destroy openings or if the On-Behalf-Of User does not have the ability to edit the given job, a 403 error will be returned. The v1 endpoint has been deactivated as of 11/21/2022. Customers or partners should begin using the v2 endpoint. API keys that were granted access to the v1 endpoint will automatically have access to the v2 endpoint. <blockquote> The above returns a JSON response, structured like this </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "success": true "deleted_ids": [123, 456], "failed_ids": [789] } </code></pre></div><h2 id='patch-edit-openings'>PATCH: Edit Openings</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{d}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "opening_id": "abc-123", "status": "closed", "close_reason_id": 1234, "custom_fields": [ { "id": 123, "value": "some value" } ] } </code></pre></div><h3 id='http-request-4'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/jobs/{job_id}/openings/{id}</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>The ID of the job on which to add new openings.</td> </tr> <tr> <td>id</td> <td>The ID of the opening. Note this is the immutable internal id, and not the free-text "opening_id" from the JSON body.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>opening_id</td> <td>no</td> <td>string</td> <td>This is a string that contains an opening_id. This may be a blank string. Changing an opening_id 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.</td> </tr> <tr> <td>status</td> <td>no</td> <td>string</td> <td>Accepts either "open" or "closed". This can be used to close an open opening with the word "closed" or to open a closed opening with the word "open". Official job approvals will be reset when opening a closed opening only if the Permission Policy named "Reopening a job with approval should require reapproval" is toggled on. If the last opening is closed, it will close the hiring plan.</td> </tr> <tr> <td>close_reason_id</td> <td>no</td> <td>integer</td> <td>When closing, you may provide a close_reason_id. Providing a close_reason_id without closing the opening will return an error.</td> </tr> <tr> <td>custom_fields</td> <td>no</td> <td>array</td> <td>Array of custom field objects containing updated values for custom fields on the opening. See the "Custom Field Object Parameters" section below for more details. Note: updating a custom field may reset official job approvals if this option is selected in the custom field settings page.</td> </tr> </tbody></table> Note: If the job is closed at the same time the opening_id is changed, approvals will be ignored in favor of closing the opening. <h3 id='custom-field-object-parameters'>Custom Field Object Parameters</h3> The custom field parameter structure is different in the PATCH method than in GET methods and responses. Certain types of custom fields require different elements to be included. See below for the description of each item in a custom field element and what is required depending on the type. <table><thead> <tr> <th>Parameter</th> <th>Required for</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>all</td> <td>The custom field ID for this particular custom field. One of this or <code>name_key</code> is required.</td> </tr> <tr> <td>name_key</td> <td>all</td> <td>The name key for this custom field. This can be found in Greenhouse while editing custom options as <code>Immutable Field Key</code>. One of this or <code>id</code> is required.</td> </tr> <tr> <td>value</td> <td>all</td> <td>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's name exactly. See the <a href="#the-custom-field-object">Custom Field Object for more details</a>.</td> </tr> <tr> <td>min_value</td> <td>number_range, currency range</td> <td>The minimum value for a range. Must be less than max_value.</td> </tr> <tr> <td>max_value</td> <td>number_range, currency_range</td> <td>The maximum value for a range. Must be greater than min_value</td> </tr> <tr> <td>unit</td> <td>currency</td> <td>This 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.</td> </tr> <tr> <td>delete_value</td> <td>n/a</td> <td>When 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. Required custom fields cannot be deleted and attempting to delete them will cause the request to fail.</td> </tr> </tbody></table> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "success": "true" } </code></pre></div><h2 id='post-create-new-openings'>POST: Create New Openings</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/jobs/{job_id}/openings' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "openings": [ { "opening_id": "abc-123", "custom_fields": [ { "id": 123, "value": "some value" } ] }, {"opening_id": null} ] } </code></pre></div><h3 id='http-request-5'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/jobs/{job_id}/openings</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='url-parameters-4'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>The ID of the job on which to add new openings.</td> </tr> </tbody></table> <h3 id='json-body-parameters-3'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>openings</td> <td>yes</td> <td>Array</td> <td>This an array of hashes, which can contain an opening ID and custom fields.</td> </tr> <tr> <td>openings.opening_id</td> <td>yes</td> <td>Array</td> <td>This 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.</td> </tr> <tr> <td>openings.custom_fields[]</td> <td>No</td> <td>Array</td> <td>Array of custom field objects containing new custom field values. Passing an empty array does nothing. If you have any required custom fields configured for openings, they must be supplied for each new opening, or the request will fail. See the "Custom Field Object Parameters" section below for more details.</td> </tr> </tbody></table> 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. <h3 id='custom-field-object-parameters-2'>Custom Field Object Parameters</h3> The custom field parameter structure is different in the POST method than in GET methods and responses. Certain types of custom fields require different elements to be included. See below for the description of each item in a custom field element and what is required depending on the type. <table><thead> <tr> <th>Parameter</th> <th>Required for</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>all</td> <td>The custom field ID for this particular custom field. One of this or <code>name_key</code> is required.</td> </tr> <tr> <td>name_key</td> <td>all</td> <td>The name key for this custom field. This can be found in Greenhouse while editing custom options as <code>Immutable Field Key</code>. One of this or <code>id</code> is required.</td> </tr> <tr> <td>value</td> <td>all</td> <td>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's name exactly. See the <a href="#the-custom-field-object">Custom Field Object for more details</a>.</td> </tr> <tr> <td>min_value</td> <td>number_range, currency range</td> <td>The minimum value for a range. Must be less than max_value.</td> </tr> <tr> <td>max_value</td> <td>number_range, currency_range</td> <td>The maximum value for a range. Must be greater than min_value</td> </tr> <tr> <td>unit</td> <td>currency</td> <td>This 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.</td> </tr> </tbody></table> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "openings": [ { "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" } ] } </code></pre></div><h1 id='job-posts'>Job Posts</h1> Describes the online job posts for an organization's jobs (as seen on the Job Board). <h2 id='the-job-post-object'>The job post object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123, "title": "Software Engineer", "location": { "id": 123456, "name": "New York, NY", "office_id": null, "job_post_custom_location_id": 303145, "job_post_location_type": { "id": 1, "name": "Free Text" } }, "internal": true, "external": false, "active": true, "live": true, "first_published_at": "2023-04-03T18:06:18Z", "job_id": 1234, "content": "We’re looking for the next big innovator.", "internal_content": "Apply today!", "updated_at": "2024-11-21T15:39:24Z", "created_at": "2023-04-01T17:56:19Z", "demographic_question_set_id": 999, "questions": [ { "required": true, "private": false, "label": "First Name", "name": "first_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Last Name", "name": "last_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Email", "name": "email", "type": "short_text", "values": [], "description": null }, { "required": false, "private": false, "label": "Phone", "name": "phone", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Resume", "name": "resume", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Cover Letter", "name": "cover_letter", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Have you ever worked for our organization before?", "name": "question_234567", "type": "boolean", "values": [ { "value": 0, "label": "No" }, { "value": 1, "label": "Yes" } ], "description": "Please select Yes or No." }, { "required": false, "private": true, "label": "Have you applied to this job before?", "type": "multi_select", "name": "question_345678[]", "values": [ { "value": 862, "label": "Yes" }, { "value": 863, "label": "No" }, { "value": 864, "label": "Maybe" } ], "description": null }, { "required": true, "private": false, "label": "LinkedIn Profile", "name": "question_45678", "type": "short_text", "values": [], "description": "Please enter the URL for your LinkedIn profile." }, { "required": true, "private": false, "label": "How did you hear about this job?", "name": "question_56789", "type": "short_text", "values": [], "description": null } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>Job post ID</td> </tr> <tr> <td>active</td> <td>If <code>false</code>, this job post has been deleted.</td> </tr> <tr> <td>live</td> <td>If <code>true</code>, this job post status is set to live.</td> </tr> <tr> <td>first_published_at</td> <td>Timestamp when this job post was first set to live.</td> </tr> <tr> <td>internal</td> <td>If <code>true</code>, this job post has been posted (or is to be posted) on an internal job board.</td> </tr> <tr> <td>external</td> <td>If <code>true</code>, this job post has been posted (or is to be posted) on an external job board.</td> </tr> <tr> <td>job_id</td> <td>The ID of the <a href="#jobs">job</a> that this job post is for. Indicates a prospect post if null.</td> </tr> <tr> <td>content</td> <td>The text of the job post as posted to the external job board.</td> </tr> <tr> <td>internal_content</td> <td>The text of the job post if posted to the internal job board, if different than the external job board.</td> </tr> <tr> <td>demographic_question_set_id</td> <td>The demographic question set associated with this job post</td> </tr> <tr> <td>questions</td> <td>An array of questions associated with this job post.</td> </tr> <tr> <td>questions.name</td> <td>When submitting applications through the Job Board API, this is the name of the POST parameter used to submit questions. Custom questions are prefixed with "question_" while Greenhouse standard application questions have a consistent name for every job post.</td> </tr> </tbody></table> <h2 id='get-list-job-posts'>GET: List Job Posts</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/job_posts' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "title": "Software Engineer", "location": { "id": 123456, "name": "New York, NY", "office_id": null, "job_post_custom_location_id": 303145, "job_post_location_type": { "id": 1, "name": "Free Text" } }, "internal": true, "external": false, "active": true, "live": true, "first_published_at": "2023-04-03T18:06:18Z", "job_id": 1234, "content": "We’re looking for the next big innovator.", "internal_content": "Apply today!", "updated_at": "2024-11-21T15:39:24Z", "created_at": "2023-04-01T17:56:19Z", "demographic_question_set_id": 999, "questions": [ { "required": true, "private": false, "label": "First Name", "name": "first_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Last Name", "name": "last_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Email", "name": "email", "type": "short_text", "values": [], "description": null }, { "required": false, "private": false, "label": "Phone", "name": "phone", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Resume", "name": "resume", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Cover Letter", "name": "cover_letter", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Have you ever worked for our organization before?", "name": "question_234567", "type": "boolean", "values": [ { "value": 0, "label": "No" }, { "value": 1, "label": "Yes" } ], "description": "Please select Yes or No." }, { "required": false, "private": true, "label": "Have you applied to this job before?", "type": "multi_select", "name": "question_345678[]", "values": [ { "value": 862, "label": "Yes" }, { "value": 863, "label": "No" }, { "value": 864, "label": "Maybe" } ], "description": null }, { "required": true, "private": false, "label": "LinkedIn Profile", "name": "question_45678", "type": "short_text", "values": [], "description": "Please enter the URL for your LinkedIn profile." }, { "required": true, "private": false, "label": "How did you hear about this job?", "name": "question_56789", "type": "short_text", "values": [], "description": null } ] } ] </code></pre></div> List all of an organization's job posts. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/job_posts</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving job posts will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only job posts that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only job posts that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only job posts that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only job posts that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>live</td> <td>If <code>true</code>, return only live job posts.</td> </tr> <tr> <td>active</td> <td>If <code>true</code>, only return active job posts. If <code>false</code>, only return deleted job posts. When omitted, return both active and deleted job posts.</td> </tr> <tr> <td>full_content</td> <td>If <code>true</code>, returns the board introduction, description, pay transparency ranges, and board conclusion as one <code>content</code> or <code>internal_content</code> element. When omitted, only returns the post's editable description.</td> </tr> <tr> <td>internal</td> <td>If <code>true</code>, only return internal job posts. If <code>false</code>, only return external job posts. When omitted, return both internal and external job posts.</td> </tr> </tbody></table> <a href="#the-job-post-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-job-post'>GET: Retrieve Job Post</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/job_posts/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123, "title": "Software Engineer", "location": { "id": 123456, "name": "New York, NY", "office_id": null, "job_post_custom_location_id": 303145, "job_post_location_type": { "id": 1, "name": "Free Text" } }, "internal": true, "external": false, "active": true, "live": true, "first_published_at": "2023-04-03T18:06:18Z", "job_id": 1234, "content": "We’re looking for the next big innovator.", "internal_content": "Apply today!", "updated_at": "2024-11-21T15:39:24Z", "created_at": "2023-04-01T17:56:19Z", "demographic_question_set_id": 999, "questions": [ { "required": true, "private": false, "label": "First Name", "name": "first_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Last Name", "name": "last_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Email", "name": "email", "type": "short_text", "values": [], "description": null }, { "required": false, "private": false, "label": "Phone", "name": "phone", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Resume", "name": "resume", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Cover Letter", "name": "cover_letter", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Have you ever worked for our organization before?", "name": "question_234567", "type": "boolean", "values": [ { "value": 0, "label": "No" }, { "value": 1, "label": "Yes" } ], "description": "Please select Yes or No." }, { "required": false, "private": true, "label": "Have you applied to this job before?", "type": "multi_select", "name": "question_345678[]", "values": [ { "value": 862, "label": "Yes" }, { "value": 863, "label": "No" }, { "value": 864, "label": "Maybe" } ], "description": null }, { "required": true, "private": false, "label": "LinkedIn Profile", "name": "question_45678", "type": "short_text", "values": [], "description": "Please enter the URL for your LinkedIn profile." }, { "required": true, "private": false, "label": "How did you hear about this job?", "name": "question_56789", "type": "short_text", "values": [], "description": null } ] } </code></pre></div> Get a single job post. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/job_posts/{id}</code> <h3 id='querystring-parameters-2'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>full_content</td> <td>If <code>true</code>, returns the board introduction, description, pay transparency ranges, and board conclusion as one <code>content</code> or <code>internal_content</code> element. When omitted, only returns the post's editable description.</td> </tr> </tbody></table> <a href="#the-job-post-object">See noteworthy response attributes.</a> <h2 id='get-list-job-posts-for-job'>GET: List Job Posts for Job</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{id}/job_posts' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "title": "Software Engineer", "location": { "id": 123456, "name": "New York, NY", "office_id": null, "job_post_custom_location_id": 303145, "job_post_location_type": { "id": 1, "name": "Free Text" } }, "internal": true, "external": false, "active": true, "live": true, "first_published_at": "2023-04-03T18:06:18Z", "job_id": 1234, "content": "We’re looking for the next big innovator.", "internal_content": "Apply today!", "updated_at": "2024-11-21T15:39:24Z", "created_at": "2023-04-01T17:56:19Z", "demographic_question_set_id": 999, "questions": [ { "required": true, "private": false, "label": "First Name", "name": "first_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Last Name", "name": "last_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Email", "name": "email", "type": "short_text", "values": [], "description": null }, { "required": false, "private": false, "label": "Phone", "name": "phone", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Resume", "name": "resume", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Cover Letter", "name": "cover_letter", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Have you ever worked for our organization before?", "name": "question_234567", "type": "boolean", "values": [ { "value": 0, "label": "No" }, { "value": 1, "label": "Yes" } ], "description": "Please select Yes or No." }, { "required": false, "private": true, "label": "Have you applied to this job before?", "type": "multi_select", "name": "question_345678[]", "values": [ { "value": 862, "label": "Yes" }, { "value": 863, "label": "No" }, { "value": 864, "label": "Maybe" } ], "description": null }, { "required": true, "private": false, "label": "LinkedIn Profile", "name": "question_45678", "type": "short_text", "values": [], "description": "Please enter the URL for your LinkedIn profile." }, { "required": true, "private": false, "label": "How did you hear about this job?", "name": "question_56789", "type": "short_text", "values": [], "description": null } ] }, { "id": 129548, "demographic_question_set_id": 999, "live": true, "first_published_at": "2023-04-03T18:06:18Z", "title": "Test job two", "location": { "id": 123457, "name": "Material Plane", "office_id": null, "job_post_custom_location_id": 303145, "job_post_location_type": { "id": 1, "name": "Free Text" } }, "internal": false, "external": true, "job_id": 146218, "content": "job post content two", "updated_at": "2024-11-21T15:39:24Z", "created_at": "2023-04-01T17:56:19Z", "internal_content": "", "created_at": "2023-04-01T17:56:19Z", "questions": [ { "required": true, "private": false, "label": "First Name", "name": "first_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Last Name", "name": "last_name", "type": "short_text", "values": [], "description": null } ] } ] </code></pre></div> List all the corresponding job posts for a given Job ID. <h3 id='http-request-3'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{id}/job_posts</code> <h3 id='url-parameters'>URL parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job whose job posts you want to retrieve</td> </tr> </tbody></table> <h3 id='querystring-parameters-3'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>active</td> <td>If <code>true</code>, only return active job posts. If <code>false</code>, only return deleted job posts. When omitted, return both active and deleted job posts.</td> </tr> <tr> <td>full_content</td> <td>If <code>true</code>, returns the board introduction, description, pay transparency ranges, and board conclusion as one <code>content</code> or <code>internal_content</code> element. When omitted, only returns the post's editable description.</td> </tr> </tbody></table> <a href="#the-job-post-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-job-post-for-job'>GET: Retrieve Job Post for Job</h2> <aside class="warning">As of September 2016, we introduced the ability to add multiple job posts for a single job. To list all job posts for a job, see <a href="#get-list-job-posts-for-job">here</a>.</aside> <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{id}/job_post' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123, "title": "Software Engineer", "location": { "id": 123456, "name": "New York, NY", "office_id": null, "job_post_custom_location_id": 303145, "job_post_location_type": { "id": 1, "name": "Free Text" } }, "internal": true, "external": false, "active": true, "live": true, "first_published_at": "2023-04-03T18:06:18Z", "job_id": 1234, "content": "We’re looking for the next big innovator.", "internal_content": "Apply today!", "updated_at": "2024-11-21T15:39:24Z", "created_at": "2023-04-01T17:56:19Z", "demographic_question_set_id": 999, "questions": [ { "required": true, "private": false, "label": "First Name", "name": "first_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Last Name", "name": "last_name", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Email", "name": "email", "type": "short_text", "values": [], "description": null }, { "required": false, "private": false, "label": "Phone", "name": "phone", "type": "short_text", "values": [], "description": null }, { "required": true, "private": false, "label": "Resume", "name": "resume", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Cover Letter", "name": "cover_letter", "type": "attachment", "values": [], "description": null }, { "required": false, "private": false, "label": "Have you ever worked for our organization before?", "name": "question_234567", "type": "boolean", "values": [ { "value": 0, "label": "No" }, { "value": 1, "label": "Yes" } ], "description": "Please select Yes or No." }, { "required": false, "private": true, "label": "Have you applied to this job before?", "type": "multi_select", "name": "question_345678[]", "values": [ { "value": 862, "label": "Yes" }, { "value": 863, "label": "No" }, { "value": 864, "label": "Maybe" } ], "description": null }, { "required": true, "private": false, "label": "LinkedIn Profile", "name": "question_45678", "type": "short_text", "values": [], "description": "Please enter the URL for your LinkedIn profile." }, { "required": true, "private": false, "label": "How did you hear about this job?", "name": "question_56789", "type": "short_text", "values": [], "description": null } ] } </code></pre></div> Retrieve the corresponding job post for a given Job ID. <h3 id='http-request-4'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{id}/job_post</code> <h3 id='url-parameters-2'>URL parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job whose job post you want to retrieve</td> </tr> </tbody></table> <h3 id='querystring-parameters-4'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>content</td> <td>If present, will return the text of the job post as posted to the external job board.</td> </tr> <tr> <td>questions</td> <td>If present, will return an array of questions associated with this job post.</td> </tr> <tr> <td>full_content</td> <td>If <code>true</code>, returns the board introduction, description, pay transparency ranges, and board conclusion as one <code>content</code> or <code>internal_content</code> element. When omitted, only return the post's editable description.</td> </tr> </tbody></table> <a href="#the-job-post-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-custom-locations-for-job-post'>GET: Retrieve Custom Locations for Job Post</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/job_posts/{id}/custom_locations' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 1234, "value": "Boston", "active": true, "greenhouse_job_board_id": 111, "created_at": "2019-05-15T15:19:53.617Z", "updated_at": "2019-05-15T15:19:53.617Z" }, { "id": 2321, "value": "New York", "active": true, "greenhouse_job_board_id": 111, "created_at": "2019-05-15T15:53:35.586Z", "updated_at": "2019-05-15T15:53:35.586Z" }, { "id": 4215, "value": "San Francisco", "active": true, "greenhouse_job_board_id": 111, "created_at": "2019-05-15T15:19:53.617Z", "updated_at": "2019-05-15T15:19:53.617Z" } ] </code></pre></div> List all the custom location options available for a given job post ID <h3 id='http-request-5'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/job_posts/{id}/custom_locations</code> <h3 id='url-parameters-3'>URL parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job post whose custom location options you want to retrieve</td> </tr> </tbody></table> <h2 id='patch-update-job-post'>PATCH: Update Job Post</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v2/job_posts/{id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "title": "New Job Title", "location": "NYC", "content": "\"text-align: center;\">\"font-weight: 400;\">My exciting new job post!Check it out!" } </code></pre></div> <blockquote> The above returns a JSON response on success: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true } </code></pre></div> Update some properties of a job post. <h3 id='http-request-6'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v2/job_posts/{id}</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>title</td> <td>No</td> <td>string</td> <td>The new title for this job post.</td> </tr> <tr> <td>location</td> <td>No</td> <td>string</td> <td>The new location for this job post. This is just a plain text string.</td> </tr> <tr> <td>location.office_id</td> <td>No</td> <td>integer</td> <td>The new location for this job post. This will be set by an office ID. Only acceptable if the job board location configuration is limited to offices.</td> </tr> <tr> <td>location.custom_location_id</td> <td>No</td> <td>integer</td> <td>The new location for this job post. This will be set by a custom location ID. Only acceptable if the job board location configuration is limited to a custom list.</td> </tr> <tr> <td>content</td> <td>No</td> <td>string</td> <td>The new body of the job post. This will replace the entire existing job post body.</td> </tr> </tbody></table> Important Note: Due to JSON restrictions, the HTML body of the new job post should be a single line, with no newline characters and with all double quotes escaped. If your job posts require significant formatting, we recommend using Greenhouse's job post editor to make changes. The V1 version of this endpoint was deprecated on 4/12/2020. To more correctly reflect job post permissions in Greenhouse Recruiting, updating the status of a job post was extracted into its own endpoint. We considered changing access permission to a job post a breaking change, so this V2 endpoint was created. Usage of this endpoint is the same as the V1 endpoint except it does not support updating status. To update status, use the Update Job Post Status endpoint below. The access permission in that endpoint is the same as the previous access permission in the V1 endpoint. <h2 id='patch-update-job-post-status'>PATCH: Update Job Post Status</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v2/job_posts/{id}/status' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "status": "live", (or "offline") } </code></pre></div> <blockquote> The above returns a JSON response on success: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true } </code></pre></div> Update the status of a job post to "live" or "offline." <h3 id='http-request-7'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v2/job_posts/{id}/status</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>status</td> <td>Yes</td> <td>string</td> <td>One of 'live' or 'offline'</td> </tr> </tbody></table> The ability to update a job post's status is on a different permission than the other properties of a job post. To reflect this in Harvest, status was separated into its own endpoint in V2. Updating status on the V1 endpoint is deprecated. <h1 id='job-stages'>Job Stages</h1> An organization's job stages. <h2 id='the-job-stage-object'>The job stage object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 72200, "name": "Face to Face", "created_at": "2016-10-22T05:31:37.263Z", "updated_at": "2016-10-22T05:31:37.263Z", "active": true, "job_id": 98765, "priority": 0, "interviews": [ { "id": 6001, "name": "Cultural Fit Interview", "schedulable": true, "estimated_minutes": 30, "default_interviewer_users": [ { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" } ], "interview_kit": { "id": 9123, "content": "<h5>Purpose</h5>Determine whether or not the candidate would be a strong fit.", "questions": [ { "id": 11052, "question": "Is this person really a good fit?" } ] } }, { "id": 6002, "name": "Executive Interview", "schedulable": true, "estimated_minutes": 60, "default_interviewer_users": [ { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" } ], "interview_kit": { "id": 9124, "content": "<h5>Purpose</h5>See if they can work with the boss.", "questions": [ { "id": 11053, "question": "What's their favorite color?" }, { "id": 11054, "question": "Do they really want to work here?" } ] } } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The job stage's unique identifier</td> </tr> <tr> <td>name</td> <td>The name for this job stage</td> </tr> <tr> <td>active</td> <td>One of <code>true</code> or <code>false</code>: <code>true</code> - The job stage is active <code>false</code> - The job stage was deleted</td> </tr> <tr> <td>job_id</td> <td>The job that this stage belongs to</td> </tr> <tr> <td>priority</td> <td>Numeric field used for ordering, with the lowest values ordered first. For example, priority 0 indicates the first stage on a job</td> </tr> <tr> <td>interviews</td> <td>An array of interview steps associated with this job stage. Each Step contains: <code>id</code> - The step's unique identifier <code>name</code> - The name of this interview step <code>schedulable</code> - True / False value for whether this step can be scheduled <code>interview_kit</code> - Details about the interview, including unique ID, interview prep content, and custom interview questions</td> </tr> </tbody></table> <h2 id='get-list-job-stages'>GET: List Job Stages</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/job_stages' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "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, "priority": 0, "interviews": [ { "id": 7890, "name": "Cultural Fit Interview", "schedulable": true, "estimated_minutes": 30, "default_interviewer_users": [ { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" } ], "interview_kit": { "id": 9124, "content": "<h5>Purpose</h5>Determine whether or not the candidate would be a strong fit.", "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, "priority": 1, "interviews": [ { "id": 7345, "name": "Executive Interview", "schedulable": true, "estimated_minutes": 60, "default_interviewer_users": [ { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" } ], "interview_kit": { "id": 9125, "content": "<h5>Purpose</h5>Determine whether or not the candidate would be a strong fit.", "questions": [ { "id": 11053, "question": "What's their favorite color?" }, { "id": 11054, "question": "Do they really want to work here?" } ] } } ] } ] </code></pre></div> List all of an organization's job stages. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/job_stages</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving job stages will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only job stages that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only job stages that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only job stages that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only job stages that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> </tbody></table> <a href="#the-job-stages-object">See noteworthy response attributes.</a> <h2 id='get-list-job-stages-for-job'>GET: List Job Stages for Job</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{id}/stages' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "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, "priority": 0, "interviews": [ { "id": 6001, "name": "Cultural Fit Interview", "schedulable": true, "estimated_minutes": 30, "default_interviewer_users": [ { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" } ], "interview_kit": { "id": 9128, "content": "<h5>Purpose</h5>Determine whether or not the candidate would be a strong fit.", "questions": [ { "id": 11052, "question": "Is this person really a good fit?" } ] } }, { "id": 6002, "name": "Executive Interview", "schedulable": true, "created_at": "2015-11-22T05:31:37.263Z", "updated_at": "2015-11-22T05:31:37.263Z", "job_id": 146219, "estimated_minutes": 60, "default_interviewer_users": [ { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" } ], "interview_kit": { "id": 9129, "content": "<h5>Purpose</h5>See if they can work with the boss.", "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, "priority": 1, "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, "priority": 2, "interviews": [ { "id": 8004, "name": "Application Review", "schedulable": false, "interview_kit": { "id": 9130, "content": null, "questions": [] } } ] } ] </code></pre></div> Retrieve the stages for the specified job id. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{id}/stages</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job whose job stages you want to retrieve.</td> </tr> </tbody></table> <h3 id='querystring-parameters-2'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>created_before</td> <td>Return only job stages that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only job stages that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only job stages that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only job stages that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> </tbody></table> <a href="#the-job-stage-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-job-stage'>GET: Retrieve Job Stage</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/job_stages/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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, "priority": 1, "interviews": [ { "id": 7890, "name": "Cultural Fit Interview", "schedulable": true, "estimated_minutes": 30, "default_interviewer_users": [ { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" } ], "interview_kit": { "id": 9127, "content": "<h5>Purpose</h5>Determine whether or not the candidate would be a strong fit.", "questions": [ { "id": 11052, "question": "Is this person really a good fit?" } ] } } ] } </code></pre></div> Retrieve a job stage by its <code>id</code>. <h3 id='http-request-3'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/job_stages/{id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job stage to retrieve</td> </tr> </tbody></table> <a href="#the-job-stages-object">See noteworthy response attributes.</a> <h1 id='jobs'>Jobs</h1><h2 id='the-job-object'>The job object</h2> An organization's jobs. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 6404, "name": "Archaeologist", "requisition_id": "abc123", "notes": "Resistance to electro-magnetic radiation a plus!", "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", "updated_at": "2013-12-12T14:42:58Z", "is_template": false, "copied_from_id": 2345, "departments": [ { "id": 25907, "name": "Second-Level department", "parent_id": 25908, "child_ids": [14510], "external_id": "12345" } ], "offices": [ { "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 150893, "parent_id": 50849, "child_ids": [50852, 50891], "external_id": "15679" } ], "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, "first_name": "Kaylee", "last_name": "Prime", "name": "Kaylee Prime", "employee_id": "13636" }, { "id": 169779, "first_name": "Hank", "last_name": "Hollandaise", "name": "Hank Hollandaise", "employee_id": "34537" } ], "recruiters": [ { "id": 81111, "first_name": "Samuel", "last_name": "Skateboard", "name": "Samuel Skateboard", "employee_id": "34531", "responsible": false }, { "id": 153448, "first_name": "Stegosaurus", "last_name": "Heels", "name": "Stegosaurus Heels", "employee_id": "45748", "responsible": true } ], "coordinators": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327", "responsible": true }, { "id": 177046, "first_name": "Mirandella", "last_name": "Lager", "name": "Mirandella Lager", "employee_id": "43626", "responsible": false } ], "sourcers": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327" } ] }, "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, "close_reason": { "id": 689, "name": "Hired" } } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The job's unique identifier</td> </tr> <tr> <td>requisition_id</td> <td>An arbitrary ID provided by an external source; does not map to another entity within Greenhouse.</td> </tr> <tr> <td>status</td> <td>One of <code>open</code>, <code>closed</code>, <code>draft</code>.</td> </tr> <tr> <td>confidential</td> <td>One of <code>true</code>, <code>false</code>. If the job is confidential or not.</td> </tr> <tr> <td>departments</td> <td>An array containing the <a href="#departments">department</a> which this job belongs to.</td> </tr> <tr> <td>offices</td> <td>An array containing the <a href="#offices">offices</a> this job is associated with.</td> </tr> <tr> <td>hiring_team</td> <td>Lists the names and User IDs of the hiring managers, recruiters, coordinators and sourcers associated with this job. For recruiters and coordinators, there is a <code>responsible</code> boolean flag which indicates that the user is the responsible recruiter or coordinator for this job.</td> </tr> <tr> <td>custom_fields</td> <td>Contains any custom job fields which have been defined by your organization.</td> </tr> <tr> <td>keyed_custom_fields</td> <td>This contains the same information as custom_fields but formatted in a different way that includes more information. This will tell you the type of custom field data to expect, the text name of custom field, and the value. The key of this hash is the custom field's immutable field key, which will not change even if the name of the custom field is changed in Greenhouse.</td> </tr> <tr> <td>openings</td> <td>Lists the openings associated with this job.</td> </tr> <tr> <td>openings[].opening_id</td> <td>Custom identifier set by an organization. Can be <code>null</code>.</td> </tr> <tr> <td>openings[].status</td> <td>One of: <code>["open", "closed"]</code></td> </tr> <tr> <td>openings[].opened_at</td> <td>Timestamp when the opening was opened.</td> </tr> <tr> <td>openings[].closed_at</td> <td>Timestamp when the opening was closed. An opening is closed when it is filled or removed.</td> </tr> <tr> <td>openings[].application_id</td> <td>If the opening is closed and a candidate was hired to fill the opening, this is the ID of the candidate's application. Otherwise, null.</td> </tr> <tr> <td>openings[].close_reason</td> <td>If 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.</td> </tr> <tr> <td>is_template</td> <td>Is this job designated as a template used to create other jobs. This may be true, false, or null. Null is an indication this job was created before template job feature.</td> </tr> <tr> <td></td> <td></td> </tr> <tr> <td>copied_from_id</td> <td>If this job was copied from another job, this field contains the id of the source job.</td> </tr> </tbody></table> <h2 id='get-list-jobs'>GET: List Jobs</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 6404, "name": "Archaeologist", "requisition_id": "abc123", "notes": "Resistance to electro-magnetic radiation a plus!", "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", "updated_at": "2013-12-12T14:42:58Z", "is_template": false, "copied_from_id": 2345, "departments": [ { "id": 25907, "name": "Second-Level department", "parent_id": 25908, "child_ids": [14510], "external_id": "12345" } ], "offices": [ { "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 150893, "parent_id": 50849, "child_ids": [50852, 50891], "external_id": "15679" } ], "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, "first_name": "Kaylee", "last_name": "Prime", "name": "Kaylee Prime", "employee_id": "13636" }, { "id": 169779, "first_name": "Hank", "last_name": "Hollandaise", "name": "Hank Hollandaise", "employee_id": "34537" } ], "recruiters": [ { "id": 81111, "first_name": "Samuel", "last_name": "Skateboard", "name": "Samuel Skateboard", "employee_id": "34531", "responsible": false }, { "id": 153448, "first_name": "Stegosaurus", "last_name": "Heels", "name": "Stegosaurus Heels", "employee_id": "45748", "responsible": true } ], "coordinators": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327", "responsible": true }, { "id": 177046, "first_name": "Mirandella", "last_name": "Lager", "name": "Mirandella Lager", "employee_id": "43626", "responsible": false } ], "sourcers": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327" } ] }, "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, "close_reason": { "id": 689, "name": "Hired" } } ] } ] </code></pre></div> List all of an organization's jobs. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving jobs will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only jobs that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only jobs that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only jobs that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only jobs that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>requisition_id</td> <td>If included, will return only the jobs that match the given requisition_id</td> </tr> <tr> <td>opening_id</td> <td>If included, will return only the jobs that contain at least one opening with the given opening_id.</td> </tr> <tr> <td>status</td> <td>One of 'open', 'closed', or 'draft'. If included, will only return jobs with that status.</td> </tr> <tr> <td>department_id</td> <td>If included, will return only the jobs in this specific department.</td> </tr> <tr> <td>external_department_id</td> <td>This may be used instead of department_id and represents the ID of the department in an external system.</td> </tr> <tr> <td>office_id</td> <td>If included, will return only the jobs in this specific office.</td> </tr> <tr> <td>external_office_id</td> <td>This may be used instead of office_id and represents the ID of the office in an external system.</td> </tr> <tr> <td>custom_field_option_id</td> <td>The job contains a custom field with this custom_field_option_id selected. Option IDs can be retrieved from the <a href="#the-custom-field-options-object">GET Custom Field Options endpoint</a>.</td> </tr> </tbody></table> <a href="#the-job-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-job'>GET: Retrieve Job</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 6404, "name": "Archaeologist", "requisition_id": "abc123", "notes": "Resistance to electro-magnetic radiation a plus!", "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", "updated_at": "2013-12-12T14:42:58Z", "is_template": false, "copied_from_id": 2345, "departments": [ { "id": 25907, "name": "Second-Level department", "parent_id": 25908, "child_ids": [14510], "external_id": "12345" } ], "offices": [ { "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 150893, "parent_id": 50849, "child_ids": [50852, 50891], "external_id": "15679" } ], "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, "first_name": "Kaylee", "last_name": "Prime", "name": "Kaylee Prime", "employee_id": "13636" }, { "id": 169779, "first_name": "Hank", "last_name": "Hollandaise", "name": "Hank Hollandaise", "employee_id": "34537" } ], "recruiters": [ { "id": 81111, "first_name": "Samuel", "last_name": "Skateboard", "name": "Samuel Skateboard", "employee_id": "34531", "responsible": false }, { "id": 153448, "first_name": "Stegosaurus", "last_name": "Heels", "name": "Stegosaurus Heels", "employee_id": "45748", "responsible": true } ], "coordinators": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327", "responsible": true }, { "id": 177046, "first_name": "Mirandella", "last_name": "Lager", "name": "Mirandella Lager", "employee_id": "43626", "responsible": false } ], "sourcers": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327" } ] }, "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, "close_reason": { "id": 689, "name": "Hired" } } ] } </code></pre></div><h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job to retrieve</td> </tr> </tbody></table> <a href="#the-job-object">See noteworthy response attributes.</a> <h2 id='patch-update-job'>PATCH: Update Job</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/jobs/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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], "external_office_ids": ["office-1"], "department_id": 74, "external_department_id": "dept-1", "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" } ] } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 6404, "name": "New job name", "requisition_id": "1", "notes": "Here are some notes", "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", "updated_at": "2013-12-12T14:42:58Z", "is_template": false, "copied_from_id": 2345, "departments": [ { "id": 74, "name": "Second-Level department", "parent_id": 25908, "child_ids": [14510], "external_id": "dept-1" } ], "offices": [ { "id": 1556, "name": "San Francisco", "location": { "name": "San Francisco, United States" }, "primary_contact_user_id": 150893, "parent_id": 50849, "child_ids": [50852, 50891], "external_id": "office-1" } ], "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, "first_name": "Kaylee", "last_name": "Prime", "name": "Kaylee Prime", "employee_id": "13636" }, { "id": 169779, "first_name": "Hank", "last_name": "Hollandaise", "name": "Hank Hollandaise", "employee_id": "34537" } ], "recruiters": [ { "id": 81111, "first_name": "Samuel", "last_name": "Skateboard", "name": "Samuel Skateboard", "employee_id": "34531", "responsible": false }, { "id": 153448, "first_name": "Stegosaurus", "last_name": "Heels", "name": "Stegosaurus Heels", "employee_id": "45748", "responsible": true } ], "coordinators": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327", "responsible": true }, { "id": 177046, "first_name": "Mirandella", "last_name": "Lager", "name": "Mirandella Lager", "employee_id": "43626", "responsible": false } ], "sourcers": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327" } ] }, "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" }, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "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, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "id": 125, "opening_id": null, "status": "open", "opened_at": "2016-02-03T20:00:00.000Z", "closed_at": null, "application_id": null, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "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, "close_reason": { "id": 689, "name": "Hired" }, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } } ] } </code></pre></div><h3 id='http-request-3'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/jobs/{id}</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job to retrieve</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>name</td> <td>No</td> <td>string</td> <td>The job's name</td> </tr> <tr> <td>notes</td> <td>No</td> <td>string</td> <td>Notes on the hiring plan</td> </tr> <tr> <td>anywhere</td> <td>No</td> <td>boolean</td> <td>Boolean value indicating where the job can be done anywhere</td> </tr> <tr> <td>requisition_id*</td> <td>No</td> <td>string</td> <td>The id of the requisition corresponding to this job posting, if applicable</td> </tr> <tr> <td>team_and_responsibilities</td> <td>No</td> <td>string</td> <td>A description of the team the candidate would join and their responsibilities</td> </tr> <tr> <td>how_to_sell_this_job</td> <td>No</td> <td>string</td> <td>A description for the recruiter of the desirable aspects of the job</td> </tr> <tr> <td>custom_fields</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new custom field values. Passing an empty array does nothing.</td> </tr> <tr> <td>office_ids</td> <td>No</td> <td>Array</td> <td>Replace 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.</td> </tr> <tr> <td>external_office_ids</td> <td>No</td> <td>Array</td> <td>This may be used instead of office_ids and represents the ID of the office in an external system. If this is used, office_id must be blank and vice versa.</td> </tr> <tr> <td>department_id*</td> <td>No</td> <td>number</td> <td>Replace the current department for this job with a different department.</td> </tr> <tr> <td>external_department_id*</td> <td>No</td> <td>string</td> <td>This may be used instead of department_id and represents the ID of the department in an external system. If used, department_id must be blank and vice versa.</td> </tr> </tbody></table> <ul> <li>- Updates to these fields 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.</li> </ul> <h3 id='custom-field-parameters'>Custom Field Parameters</h3> The custom field parameter structure is different in the PATCH method than 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. <table><thead> <tr> <th>Parameter</th> <th>Required for</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>all</td> <td>The custom field id for this particular custom field. One of this or name_key is required.</td> </tr> <tr> <td>name_key</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>value</td> <td>all</td> <td>The 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 user custom fields, this will be the Greenhouse user ID. Value is only not used for range type custom fields.</td> </tr> <tr> <td>min_value</td> <td>number_range, currency range</td> <td>This contains the minimum value that is allowable for this custom field. Must be less than max_value</td> </tr> <tr> <td>max_value</td> <td>number_range, currency_range</td> <td>This contains the maximum value that is allowable for this custom field. Must be greater than min_value</td> </tr> <tr> <td>unit</td> <td>currency, currency_range</td> <td>This 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.</td> </tr> <tr> <td>delete_value</td> <td>n/a</td> <td>When 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.</td> </tr> </tbody></table> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 112746, "name": "new name", "requisition_id": 2, "notes": "Looking for the best!", "confidential": false, "status": "open", "is_template": false, "copied_from_id": 2345, "created_at": "2015-09-10T19:01:46.078Z", "opened_at": "2015-09-10T19:01:46.078Z", "updated_at": "2018-12-12T14:42:58Z", "closed_at": null, "departments": [ { "id": 74, "name": "Guideshops", "parent_id": null, "child_ids": [], "external_id": "EXTERNAL_ID_1234" } ], "offices": [ { "id": 1556, "name": "San Diego", "location": { "name": "San Diego, CA, United States" }, "primary_contact_user_id": 12345, "parent_id": null, "child_ids": [], "external_id": "ABC456" } ], "hiring_team": { "hiring_managers": [ { "id": 84275, "first_name": "Kaylee", "last_name": "Prime", "name": "Kaylee Prime", "employee_id": "13636" }, { "id": 169779, "first_name": "Hank", "last_name": "Hollandaise", "name": "Hank Hollandaise", "employee_id": "34537" } ], "recruiters": [ { "id": 81111, "first_name": "Samuel", "last_name": "Skateboard", "name": "Samuel Skateboard", "employee_id": "34531", "responsible": false }, { "id": 153448, "first_name": "Stegosaurus", "last_name": "Heels", "name": "Stegosaurus Heels", "employee_id": "45748", "responsible": true } ], "coordinators": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327", "responsible": true }, { "id": 177046, "first_name": "Mirandella", "last_name": "Lager", "name": "Mirandella Lager", "employee_id": "43626", "responsible": false } ], "sourcers": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327" } ] }, "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" }, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "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, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "id": 125, "opening_id": null, "status": "open", "opened_at": "2016-02-03T20:00:00.000Z", "closed_at": null, "application_id": null, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } }, { "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, "close_reason": { "id": 689, "name": "Hired" }, "custom_fields": { "employment_type": "Full-Time", "maximum_budget": "$81.5k" }, "keyed_custom_fields": { "employment_type": { "name": "Time type", "type": "single_select", "value": "Full-Time" }, "budget": { "name": "Maximum Budget", "type": "short_text", "value": "$81.5k" } } } ] } </code></pre></div> <a href="#the-job-object">See noteworthy response attributes.</a> <h2 id='post-create-job'>POST: Create Job</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/jobs' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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"] } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 112746, "name": "Internal Name That Appears On Hiring Plans", "requisition_id": "abc-123", "notes": "Looking for the best!", "confidential": false, "status": "open", "is_template": false, "copied_from_id": 12345, "created_at": "2015-09-10T19:01:46.078Z", "opened_at": "2015-09-10T19:01:46.078Z", "updated_at": "2015-09-10T19:01:46.078Z", "closed_at": null, "departments": [ { "id": 123, "name": "Guideshops", "parent_id": null, "child_ids": [52461, 34065, 25908], "external_id": "EXTERNAL_ID_1234" } ], "offices": [ { "id": 234, "name": "San Diego", "location": { "name": "San Diego, CA, United States" }, "primary_contact_user_id": 25463, "parent_id": 50850, "child_ids": [24719], "external_id": "abc13425" }, { "id": 345, "name": "New York", "location": { "name": "New York, NY, United States" }, "parent_id": null, "child_ids": [], "external_id": "13432" } ], "hiring_team": { "hiring_managers": [ { "id": 84275, "first_name": "Kaylee", "last_name": "Prime", "name": "Kaylee Prime", "employee_id": "13636" }, { "id": 169779, "first_name": "Hank", "last_name": "Hollandaise", "name": "Hank Hollandaise", "employee_id": "34537" } ], "recruiters": [ { "id": 81111, "first_name": "Samuel", "last_name": "Skateboard", "name": "Samuel Skateboard", "employee_id": "34531", "responsible": false }, { "id": 153448, "first_name": "Stegosaurus", "last_name": "Heels", "name": "Stegosaurus Heels", "employee_id": "45748", "responsible": true } ], "coordinators": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327", "responsible": true }, { "id": 177046, "first_name": "Mirandella", "last_name": "Lager", "name": "Mirandella Lager", "employee_id": "43626", "responsible": false } ], "sourcers": [ { "id": 122635, "first_name": "Teddy", "last_name": "Pizzazz", "name": "Teddy Pizzazz", "employee_id": "47327" } ] }, "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, "close_reason": { "id": 689, "name": "Hired" } } ] } </code></pre></div><h3 id='http-request-4'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/jobs</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>template_job_id</td> <td>Yes</td> <td>Number</td> <td>This 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.</td> </tr> <tr> <td>number_of_openings</td> <td>Yes</td> <td>Number</td> <td>The number of openings that will be created for this job.</td> </tr> <tr> <td>job_post_name</td> <td>No</td> <td>String</td> <td>This 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.</td> </tr> <tr> <td>job_name</td> <td>No</td> <td>String</td> <td>This 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)"</td> </tr> <tr> <td>department_id</td> <td>No</td> <td>Number</td> <td>The 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.</td> </tr> <tr> <td>external_department_id</td> <td>No</td> <td>String</td> <td>This may be used instead of department_id and represents the ID of the department in an external system. If this is used, department_id must be blank and vice versa.</td> </tr> <tr> <td>office_ids</td> <td>No</td> <td>Array[Numbers]</td> <td>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.</td> </tr> <tr> <td>external_office_ids</td> <td>No</td> <td>Array[Srings]</td> <td>This may be used instead of office_ids and represents the IDs of the offices in an external system. If this is used, office_ids must be blank and vice versa.</td> </tr> <tr> <td>requisition_id</td> <td>No</td> <td>String</td> <td>A requisition id for this job.</td> </tr> <tr> <td>opening_ids</td> <td>No</td> <td>Array[Strings]</td> <td>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.</td> </tr> </tbody></table> <h2 id='get-hiring-team'>GET: Hiring Team</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "hiring_managers": [ { "user_id": 11, "active": true }, { "user_id": 12, "active": false } ], "recruiters": [ { "user_id": 13, "active": false, "responsible": false }, { "user_id": 14, "active": true, "responsible": false }, { "user_id": 15, "active": true, "responsible": true } ], "coordinators": [ { "user_id": 16, "active": false, "responsible": false }, { "user_id": 17, "active": true, "responsible": false }, { "user_id": 18, "active": true, "responsible": true } ], "sourcers": [ { "user_id": 19, "active": true }, { "user_id": 20, "active": false } ] } </code></pre></div><h3 id='http-request-5'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team</code> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the job to retrieve</td> </tr> </tbody></table> <h3 id='notable-response-parameters'>Notable Response Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>active</td> <td>boolean</td> <td>This flag informs you if the user still has access to the job in question. In the case where a former hiring team member loses permission to the job, that member may still have historical information related to the job so the relationship is maintained.</td> </tr> <tr> <td>responsible</td> <td>boolean</td> <td>This flag only exists for recruiters or coordinators and tells you if the team member has been designated as the "responsible" member for future candidates on the job. This is analogous to the "responsible_for_future_candidates" field on the PUT hiring team endpoint. It is unrelated to active or inactive candidates, which trigger an in the moment migration and are not stored on the hiring team.</td> </tr> </tbody></table> <h2 id='put-replace-hiring-team'>PUT: Replace Hiring Team</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/jobs/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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 } ] } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true } </code></pre></div><h3 id='http-request-6'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team</code> <h3 id='json-body-parameters-3'>JSON Body Parameters</h3> 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 an empty list is provided for any of the four types, all users will be removed. 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. This includes the removal of disabled and inactive users, who can never be re-added. For more granular control over additions and removals, use the POST or DELETE methods on this endpoint. Also, this process is transactional: if there is one failure, no elements will be updated. Finally, if you have a Hiring Team Updated webhook configured, you will receive one webhook notification per element, so you may receive up to four webhook notifications when this endpoint is used. <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>responsible_for_future_candidates</td> <td>Yes for coordinator or recruiter</td> <td>boolean</td> <td>The user becomes the responsible person for all new candidates. Only one user in the group of users may be designated as responsible.</td> </tr> <tr> <td>responsible_for_active_candidates</td> <td>Yes for coordinator or recruiter</td> <td>boolean</td> <td>The user becomes the responsible person for all existing candidates with active applications</td> </tr> <tr> <td>responsible_for_inactive_candidates</td> <td>Yes for coordinator or recruiter</td> <td>boolean</td> <td>The user becomes the responsible person for all hired and rejected candidates</td> </tr> </tbody></table> On success, this will return a 200 response code with a success message in the JSON body. <h2 id='post-add-hiring-team-members'>POST: Add Hiring Team Members</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/jobs/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "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 } ] } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true } </code></pre></div><h3 id='http-request-7'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team</code> <h3 id='json-body-parameters-4'>JSON Body Parameters</h3> This method adds new hiring team members. If a user is designated as "responsible_for_future_candidates" and a responsible user already exists, the new user will become the responsible user and the old user will no longer be responsible. This endpoint is transactional, if any items fail to add, the entire request will fail and no changes will be made. Finally, if you have a Hiring Team Updated webhook configured, you will receive one webhook notification per element, so you may receive up to four webhook notifications when this endpoint is used. <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>responsible_for_future_candidates</td> <td>Yes for coordinator or recruiter</td> <td>boolean</td> <td>The user becomes the responsible person for all new candidates. Only one user in the group of users may be designated as responsible.</td> </tr> <tr> <td>responsible_for_active_candidates</td> <td>Yes for coordinator or recruiter</td> <td>boolean</td> <td>The user becomes the responsible person for all existing candidates with active applications</td> </tr> <tr> <td>responsible_for_inactive_candidates</td> <td>Yes for coordinator or recruiter</td> <td>boolean</td> <td>The user becomes the responsible person for all hired and rejected candidates</td> </tr> </tbody></table> On success, this will return a 200 response code with a success message in the JSON body. <h2 id='delete-remove-hiring-team-member'>DELETE: Remove Hiring Team Member</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/jobs/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "hiring_managers": [1234, 2345], "sourcers": [3456, 4567], "recruiters": [5678, 6789], "coordinators": [7890, 8901] } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true } </code></pre></div><h3 id='http-request-8'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/jobs/{id}/hiring_team</code> <h3 id='json-body-parameters-5'>JSON Body Parameters</h3> This method removes hiring team members with the designated user ids from the designated type. If a user id is provided that does not exist in the hiring team of that type, it will be ignored and no error will be raised. Disabled and inactive users can be removed with this endpoint, but you will be unable to re-add them. If you have a Hiring Team Updated webhook configured, you will receive one webhook notification per element, so you may receive up to four webhook notifications when this endpoint is used. On success, this will return a 200 response code with a success message in the JSON body. <h1 id='offers'>Offers</h1><h2 id='the-offer-object'>The offer object</h2> An organization's offers. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 1142785, "version": 1, "application_id": 91081818, "job_id": 84593, "candidate_id": 7328851, "opening": { "id": 2586842, "opening_id": "4-7", "status": "open", "opened_at": "2019-05-22T20:58:51.697Z", "closed_at": null, "application_id": null, "close_reason": null }, "created_at": "2018-06-06T20:23:10.378Z", "updated_at": "2018-06-06T20:23:43.388Z", "sent_at": "2018-06-07", "resolved_at": "2018-06-06T20:23:43.387Z", "starts_at": "2018-07-20", "status": "accepted", "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" } } } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The offer's unique identifier</td> </tr> <tr> <td>version</td> <td>The version number of this offer. When an existing offer is updated, a new one is typically created with an incremented version.</td> </tr> <tr> <td>application_id</td> <td>The ID of the associated <a href="#applications">application</a>.</td> </tr> <tr> <td>created_at</td> <td>Date whe this offer was created.</td> </tr> <tr> <td>resolved_at</td> <td>Date when this offer was resolved (e.g. when it was accepted, rejected).</td> </tr> <tr> <td>sent_at</td> <td>Date when this offer was sent to the candidate.</td> </tr> <tr> <td>starts_at</td> <td>Date when the candidate starts. This is the date value entered in the default Start Date field on candidate's Offer Details. This is the first field on their Offer Details, above the custom fields.</td> </tr> <tr> <td>status</td> <td>One of: <code>unresolved</code>, <code>accepted</code>, <code>rejected</code>, <code>deprecated</code>.</td> </tr> <tr> <td>custom_fields</td> <td>Contains a hash of the custom fields configured for this resource. The properties in this hash reflect the active custom fields as of the time this method is called.</td> </tr> <tr> <td>keyed_custom_fields</td> <td>This contains the same information as custom_fields but formatted in a different way that includes more information. This will tell you the type of custom field data to expect, the text name of custom field, and the value. The key of this hash is the custom field's immutable field key, which will not change even if the name of the custom field is changed in Greenhouse.</td> </tr> <tr> <td>opening</td> <td>The <a href="#job-openings">Job Opening</a> associated with the offer. <code>null</code> if none.</td> </tr> </tbody></table> <h2 id='get-list-offers'>GET: List Offers</h2> All offers made by an organization ordered by application_id. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/offers' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 1142785, "version": 1, "application_id": 91081818, "job_id": 84593, "candidate_id": 7328851, "opening": { "id": 2586842, "opening_id": "4-7", "status": "open", "opened_at": "2019-05-22T20:58:51.697Z", "closed_at": null, "application_id": null, "close_reason": null }, "created_at": "2018-06-06T20:23:10.378Z", "updated_at": "2018-06-06T20:23:43.388Z", "sent_at": "2018-06-07", "resolved_at": "2018-06-06T20:23:43.387Z", "starts_at": "2018-07-20", "status": "accepted", "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" } } }, { "id": 1142765, "version": 1, "application_id": 91078894, "job_id": 837749, "candidate_id": 7327285, "opening": null, "created_at": "2018-06-06T20:21:15.639Z", "updated_at": "2018-06-06T20:21:29.796Z", "sent_at": null, "resolved_at": null, "starts_at": "2018-06-30", "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" } } } ] </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/offers</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving offers will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only offers that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only offers that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only offers that were updated at or before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only offers that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>resolved_after</td> <td>Return only offers that were resolved at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>resolved_before</td> <td>Return only offers that were resolved at or before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>status</td> <td>Return only offers that have a particular status. One of: <code>unresolved</code>, <code>accepted</code>, <code>rejected</code>, <code>deprecated</code>.</td> </tr> <tr> <td>sent_after</td> <td>Return only offers that have been sent on or after the provided date. Date must be in YYYY-MM-DD format.</td> </tr> <tr> <td>sent_before</td> <td>Return only offers that have been sent on or before the provided date. Date must be in YYYY-MM-DD format.</td> </tr> <tr> <td>starts_after</td> <td>Return only offers whose start date has been set to on or after the provided date. Date must be in YYYY-MM-DD format.</td> </tr> <tr> <td>starts_before</td> <td>Return only offers whose start date has been set to on or before the provided date. Date must be in the YYYY-MM-DD format.</td> </tr> </tbody></table> <a href="#the-offer-object">See noteworthy response attributes.</a> <h2 id='get-list-offers-for-application'>GET: List Offers for Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/applications/{application_id}/offers' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 1142785, "version": 1, "application_id": 91078894, "job_id": 837749, "candidate_id": 7327285, "opening": { "id": 2586842, "opening_id": "4-7", "status": "open", "opened_at": "2019-05-22T20:58:51.697Z", "closed_at": null, "application_id": null, "close_reason": null }, "created_at": "2018-06-06T20:23:10.378Z", "updated_at": "2018-06-06T20:23:43.388Z", "sent_at": "2018-06-07", "resolved_at": "2018-06-06T20:23:43.387Z", "starts_at": "2018-07-20", "status": "accepted", "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" } } }, { "id": 1142765, "version": 1, "application_id": 91078894, "job_id": 837749, "candidate_id": 7327285, "opening": null, "created_at": "2018-06-06T20:21:15.639Z", "updated_at": "2018-06-06T20:21:29.796Z", "sent_at": null, "resolved_at": null, "starts_at": "2018-06-30", "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" } } } ] </code></pre></div> List the offers associated with an application. Greenhouse keeps offer history as updates are made over time. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>application_id</td> <td>ID of the application whose offers you want to retrieve</td> </tr> </tbody></table> <h3 id='querystring-parameters-2'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving application offers will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> </tbody></table> <a href="#the-offer-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-current-offer-for-application'>GET: Retrieve Current Offer for Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/applications/{application_id}/offers/current_offer' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 1142768, "version": 2, "application_id": 91078894, "job_id": 837749, "candidate_id": 7327285, "opening": { "id": 2586842, "opening_id": "4-7", "status": "open", "opened_at": "2019-05-22T20:58:51.697Z", "closed_at": null, "application_id": null, "close_reason": null }, "created_at": "2018-06-06T20:21:29.911Z", "updated_at": "2018-06-06T20:24:30.707Z", "sent_at": "2018-06-06", "resolved_at": null, "starts_at": "2018-06-30", "status": "unresolved", "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" } } } </code></pre></div> Fetch the current offer for an application. <h3 id='http-request-3'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications/{application_id}/offers/current_offer</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>application_id</td> <td>ID of the application whose current offer you want to retrieve</td> </tr> </tbody></table> <a href="#the-offer-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-offer'>GET: Retrieve Offer</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/offers/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 1142785, "version": 1, "application_id": 91081818, "job_id": 84593, "candidate_id": 7328851, "opening": { "id": 2586842, "opening_id": "4-7", "status": "open", "opened_at": "2019-05-22T20:58:51.697Z", "closed_at": null, "application_id": null, "close_reason": null }, "created_at": "2018-06-06T20:23:10.378Z", "updated_at": "2018-06-06T20:23:43.388Z", "sent_at": "2018-06-07", "resolved_at": "2018-06-06T20:23:43.387Z", "starts_at": "2018-07-20", "status": "accepted", "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" } } } </code></pre></div> Retrieve an offer by its ID. <h3 id='http-request-4'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/offers/{id}</code> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the offer to retrieve</td> </tr> </tbody></table> <a href="#the-offer-object">See noteworthy response attributes.</a> <h2 id='patch-update-current-offer'>PATCH: Update Current Offer</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/applications/{id}/offers/current_offer' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "start_date": "2018-03-15", "sent_at": "2018-06-27", "created_at": "2017-09-29T12:56:05Z", "custom_fields": [ { "id": 1234, "value": "Some new value" }, { "name_key": "single_select_field_name", "value": 12345 }, { "id": 5678, "delete_value": "true" } ] } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true } </code></pre></div> Update the current offer on the given application. The response will only tell you if the update succeeded. Note: You can't update offers on hired candidates. <h3 id='http-request-5'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/applications/{id}/offers/current_offer</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>start_date</td> <td>No</td> <td>The day the candidate will start. A date string, formatted like "YYYY-MM-DD". For compatibility, this will also accept an ISO timestamp, but the time will be ignored.</td> </tr> <tr> <td>sent_at</td> <td>No</td> <td>The date the offer is sent. A date string, formatted like "YYYY-MM-DD". For compatibility, this will also accept an ISO timestamp, but the time will be ignored.</td> </tr> <tr> <td>created_at</td> <td>No</td> <td>The date the offer was created. An ISO time-string formatted like "YYYY-MM-DDTHH:MM:SSZ"</td> </tr> <tr> <td>custom_fields[]</td> <td>No</td> <td>Array of hashes containing new custom field values. Passing an empty array does nothing.</td> </tr> </tbody></table> <h3 id='custom-field-parameters'>Custom Field Parameters</h3> The custom field parameter structure is different in the PATCH method then in GET methods and responses. Certain types 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. <table><thead> <tr> <th>Parameter</th> <th>Required for</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>all</td> <td>The custom field id for this particular custom field. One of this or name_key is required.</td> </tr> <tr> <td>name_key</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>value</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>unit</td> <td>currency</td> <td>This 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.</td> </tr> <tr> <td>delete_value</td> <td>n/a</td> <td>When 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.</td> </tr> </tbody></table> <h1 id='offices'>Offices</h1><h2 id='the-office-object'>The office object</h2> An organization’s offices. <blockquote> With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 485538, "parent_id": 50849, "parent_office_external_id": "parent-1", "child_ids": [ 50891, 50852 ], "child_office_external_ids": [ "child-1", "child-2" ], "external_id": "12345" } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 485538, "external_id": "12345", "children": [ { "id": 50891, "name": "Utica", "location": { "name": "Utica, New York, United States" }, "primary_contact_user_id": 336474, "external_id": "45647", "children": [] }, { "id": 50852, "name": "New York City", "location": { "name": "New York, New York, United States" }, "primary_contact_user_id": 676259, "external_id": "67890", "children": [] } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The office's unique identifier</td> </tr> <tr> <td>name</td> <td>The office's name</td> </tr> <tr> <td>location</td> <td>The office's location</td> </tr> <tr> <td>external_id</td> <td>An arbitrary ID provided by an external source; does not map to another entity in Greenhouse.</td> </tr> <tr> <td>parent_office_external_id</td> <td>The external_id of this office's parent.</td> </tr> <tr> <td>parent_office_child_ids</td> <td>the external_ids of this office's children. Note the order of this array may not match the order of the child_ids array. If there are five children and none of them have parent ids, this array will contain five null indices.</td> </tr> </tbody></table> <h2 id='get-list-offices'>GET: List Offices</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/offices' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 50891, "name": "Utica", "location": { "name": "Utica, New York, United States" }, "primary_contact_user_id": 336474, "parent_id": 47012, "parent_office_external_id": "parent-1", "child_ids": [], "child_office_external_ids": [], "external_id": "45647" }, { "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 485538, "parent_id": 50849, "parent_office_external_id": "parent-2", "child_ids": [ 50891, 50852 ], "child_office_external_ids": [ "child-office-1", "" ], "external_id": "12345" }, { "id": 50852, "name": "New York City", "location": { "name": "New York, New York, United States" }, "primary_contact_user_id": 676259, "parent_id": 47012, "parent_office_external_id": "parent-1", "child_ids": [], "child_office_external_ids": [], "external_id": "67890" } ] </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 50891, "name": "Utica", "location": { "name": "Utica, New York, United States" }, "primary_contact_user_id": 336474, "external_id": "45647", "children": [ { "id": 12345, "name": "Child-office-1", "location": { "name": "Rome, New York, United States" }, "primary_contact_user_id": 95313, "external_id": "Rome-NY", "children": [ { "id": 54321, "name": "Child-office-1-2", "location": { "name": "Syracuse, New York, United States" }, "primary_contact_user_id": 95313, "external_id": "Syracuse-NY", "children": [] } ] } ] }, { "id": 50852, "name": "New York", "location": { "name": "New York City, New York, United States" }, "primary_contact_user_id": 5659415, "external_id": "NYC-123", "children": [ { "id": 4020460005, "name": "Child-office-2", "location": { "name": "New York City, New York, United States" }, "primary_contact_user_id": 567863, "external_id": "Manhattan", "children": [] } ] } ] </code></pre></div> List all of an organization's offices. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/offices</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving offices will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>render_as</td> <td>This 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 <code>children</code></td> </tr> <tr> <td>external_id</td> <td>If supplied, only return office(s) with that external ID.</td> </tr> </tbody></table> <a href="#the-office-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-office'>GET: Retrieve Office</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/offices/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 485538, "parent_id": 50849, "parent_office_external_id": "parent-1", "child_ids": [ 50891, 50852 ], "child_office_external_ids": [ "child-office-1", "" ], "external_id": "12345" } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 485538, "external_id": "12345", "children": [ { "id": 50891, "name": "Utica", "location": { "name": "Utica, New York, United States" }, "primary_contact_user_id": 336474, "external_id": "45647", "children": [] }, { "id": 50852, "name": "New York City", "location": { "name": "New York, New York, United States" }, "primary_contact_user_id": 676259, "external_id": "67890", "children": [] } ] } </code></pre></div> Retrieve an office by its ID. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/offices/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the office to retrieve</td> </tr> </tbody></table> <h3 id='querystring-parameters-2'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>render_as</td> <td>This 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 <code>children</code></td> </tr> </tbody></table> <a href="#the-office-object">See noteworthy response attributes.</a> <h2 id='patch-edit-office'>PATCH: Edit Office</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/offices/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "name": "Research and Development", "location": "New York, NY", "external_id": "1234567890" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 50891, "name": "Utica", "location": { "name": "Utica, New York, United States" }, "primary_contact_user_id": 336474, "parent_id": 47012, "parent_office_external_id": "parent-1", "child_ids": [], "child_office_external_id": [], "external_id": "45647" } </code></pre></div> Edit an office’s basic information. <h3 id='http-request-3'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/offices/{id}</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>name</td> <td>Yes</td> <td>string</td> <td>The office’s name. If included, this cannot be blank.</td> </tr> <tr> <td>location</td> <td>No</td> <td>string</td> <td>The office’s location.</td> </tr> <tr> <td>external_id*</td> <td>No</td> <td>string</td> <td>The office’s external ID. If included, this must be unique to this office within the organization.</td> </tr> </tbody></table> * - If the external id feature is not enabled for your organization, attempting to edit this field will raise an API Error. <h2 id='post-add-office'>POST: Add Office</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/offices' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "name": "Brooklyn", "parent_id": 47012, "primary_contact_user_id": 336474, "location": "Brooklyn, NY" } or { "name": "Brooklyn", "external_parent_id": "parent-1", "primary_contact_user_id": 336474, "location": "Brooklyn, NY" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 58028, "name": "Brooklyn", "location": { "name": "Brooklyn, NY" }, "primary_contact_user_id": 336474, "parent_id": 47012, "parent_office_external_id": "parent-1", "child_ids": [], "child_office_external_id": [], "external_id": null } </code></pre></div> Create a new office <h3 id='http-request-4'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/offices</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes. Must be a user who can create offices.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td><code>name</code></td> <td>yes</td> <td>string</td> <td>The name of your new office. Must be less than 255 characters and unique within your organization.</td> </tr> <tr> <td><code>location</code></td> <td>no</td> <td>string</td> <td>This is a text representation of the office's location. This is free-form text. It is not geo-located.</td> </tr> <tr> <td><code>primary_contact_user_id</code></td> <td>no</td> <td>number</td> <td>The id of the user who will be the primary in-house contact for this office. This user must be a site-admin.</td> </tr> <tr> <td><code>parent_id</code>*</td> <td>no</td> <td>number</td> <td>The office id for the new office to be nested under. If this isn't included, the office will be created at the top level.</td> </tr> <tr> <td><code>external_parent_id</code>**</td> <td>no</td> <td>string</td> <td>The external id for the parent office. This can be used instead of parent_id, but only one of this or parent_id may be included. If both are included, this will fail.</td> </tr> <tr> <td><code>external_id</code>**</td> <td>no</td> <td>string</td> <td>The external_id for the office.</td> </tr> </tbody></table> * - The tiered office feature is available only for customers with the Advanced or Expert Greenhouse Recruiting package. Use of this field will return an error for other Greenhouse Recruiting customers. ** - The external_id feature is available only for customers with the Expert Greenhouse Recruiting package. Use of this field will return an error for other Greenhouse Recruiting customers. <h1 id='prospect-pools'>Prospect Pools</h1><h2 id='the-prospect-pools-object'>The prospect pools object</h2> An organization's prospect pools. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 25, "name": "Cold Outreach: Sourced", "active": true, "prospect_stages": [ { "id": 85, "name": "Discussed" }, { "id": 86, "name": "Had email listed on their blog" } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The pool's unique identifier</td> </tr> <tr> <td>active</td> <td>true or false. False means the pool is hidden from view in Greenhouse.</td> </tr> </tbody></table> <h2 id='get-list-prospect-pools'>GET: List Prospect Pools</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/prospect_pools' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 25, "name": "Cold Outreach: Sourced", "active": true, "prospect_stages": [ { "id": 85, "name": "Discussed" }, { "id": 86, "name": "Had email listed on their business card" }, { "id": 87, "name": "Had email listed on their blog" }, { "id": 88, "name": "Not Contacted" } ] }, { "id": 26, "name": "Opted In: Referral", "active": false, "prospect_stages": [ { "id": 90, "name": "1st. Follow Up Sent" }, { "id": 91, "name": "2nd Follow Up Sent" }, { "id": 92, "name": "In Discussion" }, { "id": 93, "name": "Discussed" }, { "id": 94, "name": "Had email listed on their github profile" } ] } ] </code></pre></div> List all of an organization's prospect pools. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/prospect_pools</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving prospect pools will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> </tbody></table> <a href="#the-prospect-pool-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-prospect-pool'>GET: Retrieve Prospect Pool</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/prospect_pools/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 25, "name": "Cold Outreach: Sourced", "active": true, "prospect_stages": [ { "id": 85, "name": "Discussed" }, { "id": 86, "name": "Had email listed on their blog" } ] } </code></pre></div><h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/prospect_pools/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the prospect pool to retrieve</td> </tr> </tbody></table> <a href="#the-prospect-pool-object">See noteworthy response attributes.</a> <h1 id='rejection-reasons'>Rejection Reasons</h1><h2 id='the-rejection-reason-object'>The rejection reason object</h2> Represents rejection reasons configured by an organization under the Custom Options section of Greenhouse. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 262, "name": "Missing resume", "type": { "id": 1, "name": "We rejected them" } } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The rejection reason's unique identifier</td> </tr> <tr> <td>name</td> <td>The rejection reason's name</td> </tr> <tr> <td>type</td> <td>An object containing the type ID and the rejection reason type, which will be one of "We rejected them", "They rejected us", and "None Specified". Note that type IDs may vary across organizations.</td> </tr> </tbody></table> <h2 id='get-list-rejection-reasons'>GET: List Rejection Reasons</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/rejection_reasons' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "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" } } ] </code></pre></div> List all of an organization's rejection reasons. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/rejection_reasons</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving rejection reasons will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>include_defaults</td> <td>When included and set to true, this will also return Greenhouse's default rejection reasons which are included automatically in each account.</td> </tr> </tbody></table> <a href="#the-rejection-reason-object">See noteworthy response attributes.</a> <h1 id='scheduled-interviews'>Scheduled Interviews</h1><h2 id='the-scheduled-interview-object'>The Scheduled Interview object</h2> Interviews that have been scheduled for the specified application. Note that all-day interviews will have a start and end date with no specified time. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 9128481, "application_id": 4684156, "external_event_id": "event123", "start": { "date_time": "2014-03-26T22:15:00.000Z" }, "end": { "date_time": "2014-03-26T22:30:00.000Z" }, "location": "Big Conference Room", "video_conferencing_url": "http://example.com", "status": "awaiting_feedback", "created_at": "2016-02-10T14:31:51.019Z", "updated_at": "2016-05-23T20:43:11.679Z", "interview": { "id": 7001, "name": "Culture Fit" }, "organizer": { "id": 2000, "first_name": "Jack", "last_name": "Shepard", "name": "Jack Shepard", "employee_id": "12345" }, "interviewers": [ { "id": 4080, "employee_id": "employee123", "name": "Kate Austen", "email": "kate.austen@example.com", "response_status": "needs_action", "scorecard_id": 11274 } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The scheduled interview's unique identifier</td> </tr> <tr> <td>start</td> <td>A date_time value if this interview has a precise start time, or a date value if this is an all-day event.</td> </tr> <tr> <td>end</td> <td>A date_time value if this interview has a precise start time, or a date value if this is an all-day event.</td> </tr> <tr> <td>location</td> <td>The location of the interview.</td> </tr> <tr> <td>video_conferencing_url</td> <td>The URL used for video interviews, such as Zoom, Google Meets, or Microsoft Teams.</td> </tr> <tr> <td>status</td> <td>One of: <code>scheduled</code>, <code>awaiting_feedback</code>, <code>complete</code></td> </tr> <tr> <td>organizer</td> <td>The <a href="#users">user</a> who is the organizer for this interview</td> </tr> <tr> <td>interviewers</td> <td>An array containing the <a href="#users">users</a> who have interviews with this candidate, including, if applicable, the ID of the scorecard they completed. This object will also contain the interviewer's <code>response_status</code> which indicates how they've responded to the interview invitation (one of <code>needs_action</code>, <code>declined</code>, <code>tentative</code>, or <code>accepted</code>).</td> </tr> </tbody></table> <h2 id='get-list-scheduled-interviews'>GET: List Scheduled Interviews</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/scheduled_interviews' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code> [ { "id": 9128481, "application_id": 4684156, "external_event_id": "event123", "start": { "date_time": "2014-03-26T22:15:00.000Z" }, "end": { "date_time": "2014-03-26T22:30:00.000Z" }, "location": "Big Conference Room", "video_conferencing_url": "http://example.com", "status": "awaiting_feedback", "created_at": "2016-02-10T14:31:51.019Z", "updated_at": "2016-05-23T20:43:11.679Z", "interview": { "id": 7001, "name": "Culture Fit" }, "organizer": { "id": 2000, "first_name": "Jack", "last_name": "Shepard", "name": "Jack Shepard", "employee_id": "12345" }, "interviewers": [ { "id": 4080, "employee_id": "employee123", "name": "Kate Austen", "email": "kate.austen@example.com", "response_status": "needs_action", "scorecard_id": 11274 } ] }, { "id": 9128482, "application_id": 432905, "external_event_id": "event456", "start": { "date": "2017-08-22" }, "end": { "date": "2017-08-23" }, "location": "Small Conference Room", "video_conferencing_url": "http://example.com", "status": "complete", "interview": { "id": 7002, "name": "Whiteboarding Challenge" }, "organizer": { "id": 2000, "first_name": "Jack", "last_name": "Shepard", "name": "Jack Shepard", "employee_id": "12345" }, "interviewers": [ { "id": 3412, "employee_id": "employee456", "name": "Charlie Pace", "email": "youalleverybody@example.com", "response_status": "needs_action", "scorecard_id": null } ] } ] </code></pre></div> List all of an organization's scheduled interviews. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/scheduled_interviews</code> <h3 id='optional-querystring-parameters'>Optional querystring Parameters</h3> Timestamps must be in in <a href="#general-considerations">ISO-8601</a> format. <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving scheduled interviews will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Only return scheduled interviews that were created before this timestamp.</td> </tr> <tr> <td>created_after</td> <td>Only return scheduled interviews that were created at or after this timestamp.</td> </tr> <tr> <td>updated_before</td> <td>Only return scheduled interviews that were updated before this timestamp.</td> </tr> <tr> <td>updated_after</td> <td>Only return scheduled interviews that were updated at or after this timestamp.</td> </tr> <tr> <td>starts_before</td> <td>Only return scheduled interviews scheduled to start before this timestamp.</td> </tr> <tr> <td>starts_after</td> <td>Only return scheduled interviews scheduled to start at or after this timestamp.</td> </tr> <tr> <td>ends_before</td> <td>Only return scheduled interviews scheduled to end before this timestamp.</td> </tr> <tr> <td>ends_after</td> <td>Only return scheduled interviews scheduled to end at or after this timestamp.</td> </tr> <tr> <td>external_event_id</td> <td>Only return the scheduled interview that has the specified <code>external_event_id</code>.</td> </tr> <tr> <td>actionable</td> <td>Only certain scheduled interviews can be updated/deleted. They must have been created through Harvest, have a status of "scheduled" or "awaiting feedback," and belong to an active application. When set to true, this filter will return only scheduled interviews that meet those criteria.</td> </tr> </tbody></table> <h2 id='get-list-scheduled-interviews-for-application'>GET: List Scheduled Interviews for Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/applications/{id}/scheduled_interviews' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 9128481, "application_id": 4684156, "external_event_id": "event123", "start": { "date_time": "2014-03-26T22:15:00.000Z" }, "end": { "date_time": "2014-03-26T22:30:00.000Z" }, "location": "Big Conference Room", "video_conferencing_url": "http://example.com", "status": "awaiting_feedback", "created_at": "2016-02-10T14:31:51.019Z", "updated_at": "2016-05-23T20:43:11.679Z", "interview": { "id": 7001, "name": "Culture Fit" }, "organizer": { "id": 2000, "first_name": "Jack", "last_name": "Shepard", "name": "Jack Shepard", "employee_id": "12345" }, "interviewers": [ { "id": 4080, "employee_id": "employee123", "name": "Kate Austen", "email": "kate.austen@example.com", "response_status": "needs_action", "scorecard_id": 11274 } ] }, { "id": 9128482, "application_id": 4684156, "external_event_id": "event456", "start": { "date": "2017-08-22" }, "end": { "date": "2017-08-23" }, "location": "Small Conference Room", "video_conferencing_url": "http://example.com", "status": "complete", "interview": { "id": 7002, "name": "Whiteboarding Challenge" }, "organizer": { "id": 2000, "first_name": "Jack", "last_name": "Shepard", "name": "Jack Shepard", "employee_id": "12345" }, "interviewers": [ { "id": 3412, "employee_id": "employee456", "name": "Charlie Pace", "email": "youalleverybody@example.com", "response_status": "needs_action", "scorecard_id": null } ] } ] </code></pre></div> Interviews that have been scheduled for this application. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications/{id}/scheduled_interviews</code> <h3 id='querystring-parameters'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of the application to retrieve</td> </tr> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving application scheduled interviews will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only scheduled interviews that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only scheduled interviews that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only scheduled interviews that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only scheduled interviews that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>external_event_id</td> <td>Only return the scheduled interview that has the specified <code>external_event_id</code>.</td> </tr> <tr> <td>actionable</td> <td>Only certain scheduled interviews can be updated/deleted. They must have been created through Harvest, have a status of "scheduled" or "awaiting feedback," and belong to an active application. When set to true, this filter will return only scheduled interviews that meet those criteria.</td> </tr> </tbody></table> <a href="#the-scheduled-interview-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-scheduled-interview'>GET: Retrieve Scheduled Interview</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/scheduled_interviews/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 9128481, "application_id": 4684156, "external_event_id": "event123", "start": { "date_time": "2014-03-26T22:15:00.000Z" }, "end": { "date_time": "2014-03-26T22:30:00.000Z" }, "location": "Big Conference Room", "video_conferencing_url": "http://example.com", "status": "awaiting_feedback", "created_at": "2016-02-10T14:31:51.019Z", "updated_at": "2016-05-23T20:43:11.679Z", "interview": { "id": 7001, "name": "Culture Fit" }, "organizer": { "id": 2000, "first_name": "Jack", "last_name": "Shepard", "name": "Jack Shepard", "employee_id": "12345" }, "interviewers": [ { "id": 4080, "employee_id": "employee123", "name": "Kate Austen", "email": "kate.austen@example.com", "response_status": "needs_action", "scorecard_id": 11274 } ] } </code></pre></div> Retrieve an interview by its ID. <h3 id='http-request-3'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/scheduled_interviews/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the scheduled interview to retrieve</td> </tr> </tbody></table> <h2 id='post-create-scheduled-interview'>POST: Create Scheduled Interview</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/scheduled_interviews' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "application_id": 102717462, "interview_id": 8055374, "interviewers": [ { "user_id": 102361, "response_status": "accepted" }, { "email": "lucius.barbarossa.46444@example.com", "response_status": "declined" } ], "start": "2018-12-12T13:15:00Z", "end": "2018-12-12T14:15:00Z", "external_event_id": "external_event_id_1", "location": "Big Conference Room" } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 109170954, "application_id": 102717457, "external_event_id": "external_event_id_1", "start": { "date_time": "2018-12-12T13:15:00.000Z" }, "end": { "date_time": "2018-12-12T14:15:00.000Z" }, "location": "Big Conference Room", "video_conferencing_url": "http://example.com", "status": "scheduled", "created_at": "2018-10-17T19:22:07.302Z", "updated_at": "2018-12-03T20:45:14.320Z", "interview": { "id": 8055374, "name": "Executive Interview" }, "organizer": { "id": 102361, "first_name": "Champ", "last_name": "Telluride", "name": "Champ Telluride", "employee_id": null }, "interviewers": [ { "id": 102361, "employee_id": null, "name": "Champ Telluride", "email": "champ.telluride.102361@example.com", "response_status": "accepted", "scorecard_id": null }, { "id": 46444, "employee_id": "AAA1", "name": "Lucius Barbarossa", "email": "lucius.barbarossa.46444@example.com", "response_status": "declined", "scorecard_id": null } ] } </code></pre></div> Create a new Scheduled Interview. <a href="#the-scheduled-interview-object">See noteworthy response attributes.</a> <h3 id='http-request-4'>HTTP Request</h3> [DEPRECATED] <del><code>POST https://harvest.greenhouse.io/v1/scheduled_interviews</code></del> <code>POST https://harvest.greenhouse.io/v2/scheduled_interviews</code> Greenhouse deprecated the V1 endpoint on April 5th, 2020. The V2 endpoint was released so the validations performed by Harvest matched the validations performed when creating an interview in the Greenhouse application. Specifically, Greenhouse allows the addition of users with e-mail addresses that do not match any users in the organization and users who do not otherwise have permission to see the job, both of which Harvest prevented. Changing the validations in this way was considered a breaking change and a second version of the endpoint was released. The V1 endpoint should not be used as it is no longer supported and will be removed in a future release. <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Will become the interview organizer. The user must have permission to manage the associated application.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>application_id</td> <td>Yes</td> <td>integer</td> <td>The id of the application for which we will scheduled an interview.</td> </tr> <tr> <td>interview_id</td> <td>Yes</td> <td>integer</td> <td>The id of the interview we'd like to schedule. This id can be found in the <a href="#the-job-stage-object">job stage object</a>. It refers to an interview type (e.g. "Executive Interview" or "On-site Interview") that is associated with a hiring plan's interview step. This differs from a "Scheduled Interview" which refers to an instantiated interview that is associated with an application, interviewers, start time, etc.</td> </tr> <tr> <td>interviewers[]</td> <td>Yes</td> <td>interviewer</td> <td>Array of interviewers. Each must specify a user by user_id, email, or employee_id. Each must include a response status (one of needs_action, declined, tentative, or accepted).</td> </tr> <tr> <td>start</td> <td>Yes</td> <td>string</td> <td>A datetime specifying when the interview starts. Must be provided in <a href="#general-considerations">ISO-8601</a> format (e.g. 2018-11-05T13:12:14Z).</td> </tr> <tr> <td>end</td> <td>Yes</td> <td>string</td> <td>A datetime specifying when the interview ends. Must be provided in <a href="#general-considerations">ISO-8601</a> format (e.g. 2018-11-05T13:12:14Z).</td> </tr> <tr> <td>external_event_id</td> <td>Yes</td> <td>string</td> <td>A unique identifier for this interview.</td> </tr> <tr> <td>location</td> <td>No</td> <td>string</td> <td>A textual description of the location of the interview.</td> </tr> </tbody></table> <aside class="notice"> For the V1 endpoint only: There may be a delay between when Greenhouse receives the POST: Create Scheduled Interview request and when Greenhouse creates the full Scheduled Interview record, which will result in a truncated API response. The truncated response body will contain the id of the newly Scheduled Interview. You can retrieve the full Scheduled Interview record by requesting the Scheduled Interview ID with the GET: Scheduled Interview endpoint. If you receive a 404 error from the GET: Scheduled Interview endpoint, this indicates that the full Scheduled Interview record is still not available. Until the Scheduled Interview record has been made fully-available in the API, please continue to request the record until the API returns a successful response. Our recommendation is to perform this check every 30 seconds until the data becomes available. This issue has been resolved in V2. </aside> <h2 id='patch-update-scheduled-interview'>PATCH: Update Scheduled Interview</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/scheduled_interviews/{id}' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "interviewers": [ { "user_id": 102361, "response_status": "needs_action" }, { "email": "lucius.barbarossa.46444@example.com", "response_status": "declined" } ], "start": "2018-11-12T13:15:00Z", "end": "2018-11-12T14:15:00Z", "external_event_id": "external_event_id_0", "location": "Dunder Mifflin, Scranton" } </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 109170954, "application_id": 102717457, "external_event_id": "external_event_id_0", "start": { "date_time": "2018-12-12T13:15:00.000Z" }, "end": { "date_time": "2018-12-12T14:15:00.000Z" }, "location": "Big Conference Room", "video_conferencing_url": "http://example.com", "status": "scheduled", "created_at": "2018-10-17T19:22:07.302Z", "updated_at": "2018-12-03T20:45:14.320Z", "interview": { "id": 8055374, "name": "Executive Interview" }, "organizer": { "id": 102361, "first_name": "Champ", "last_name": "Telluride", "name": "Champ Telluride", "employee_id": null }, "interviewers": [ { "id": 102361, "employee_id": null, "name": "Champ Telluride", "email": "champ.telluride.102361@example.com", "response_status": "accepted", "scorecard_id": null }, { "id": 46444, "employee_id": "AAA1", "name": "Lucius Barbarossa", "email": "lucius.barbarossa.46444@example.com", "response_status": "declined", "scorecard_id": null } ] } </code></pre></div> Update a Scheduled Interview. Note that only Scheduled Interviews created through Harvest can be updated. Additionally, you can only update Scheduled Interviews in the following statues: Scheduled, Awaiting Feedback. <a href="#the-scheduled-interview-object">See noteworthy response attributes.</a> <h3 id='http-request-5'>HTTP Request</h3> DEPRECATED <del><code>PATCH https://harvest.greenhouse.io/v1/scheduled_interviews/{id}</code></del> <code>PATCH https://harvest.greenhouse.io/v2/scheduled_interviews/{id}</code> Greenhouse deprecated the V1 endpoint on April 5th, 2020. The V2 endpoint was released so the validations performed by Harvest matched the validations performed when updating an interview in the Greenhouse application. Specifically, Greenhouse allows the addition of users with e-mail addresses that do not match any users in the organization and users who do not otherwise have permission to see the job, both of which Harvest prevented. Changing the validations in this way was considered a breaking change and a second version of the endpoint was released. The V1 endpoint should not be used as it is no longer supported and will be removed in a future release. <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Will become the interview organizer. The user must have permission to manage the associated application.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>interviewers[]</td> <td>No</td> <td>interviewer</td> <td>Array of interviewers. Each must specify a user by user_id, email, or employee_id. Each must include a response status (one of needs_action, declined, tentative, or accepted).</td> </tr> <tr> <td>start</td> <td>No</td> <td>string</td> <td>A datetime specifying when the interview starts. Must be provided in <a href="#general-considerations">ISO-8601</a> format (e.g. 2018-11-05T13:12:14Z).</td> </tr> <tr> <td>end</td> <td>No</td> <td>string</td> <td>A datetime specifying when the interview ends. Must be provided in <a href="#general-considerations">ISO-8601</a> format (e.g. 2018-11-05T13:12:14Z).</td> </tr> <tr> <td>external_event_id</td> <td>No</td> <td>string</td> <td>A unique identifier for this interview.</td> </tr> <tr> <td>location</td> <td>No</td> <td>string</td> <td>A textual description of the location of the interview.</td> </tr> </tbody></table> <h2 id='delete-remove-scheduled-interview'>Delete: Remove Scheduled Interview</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/scheduled_interviews/{id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "message": "Interview 109170954 has been deleted." } </code></pre></div> Delete a Scheduled Interview by <code>id</code>. Note that only Scheduled Interviews created through harvest can be deleted. Additionally, you can only delete Scheduled Interviews in the following statues: Scheduled, Awaiting Feedback. <h3 id='http-request-6'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/scheduled_interviews/{id}</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h1 id='scorecards'>Scorecards</h1> All submitted scorecards ordered by candidate. <h2 id='the-scorecard-object'>The scorecard object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123, "updated_at": "2016-08-22T19:52:38.384Z", "created_at": "2016-08-22T19:52:38.384Z", "interview": "Application Review", "interview_step": { "id": 432, "name": "Application Review" }, "candidate_id": 1234, "application_id": 3456, "interviewed_at": "2016-08-18T16:00:00.000Z", "submitted_by": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "interviewer": { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" }, "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": "Qualifications", "note": null, "rating": "mixed" }, { "name": "Problem Solver", "type": "Qualifications", "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." }, { "id": 1234567, "question": "Does the candidate have experience designing APIs?", "answer": "Yes" }, { "id": 1234568, "question": "Which team would you suggest for this candidate?", "answer": "Alpha Team" }, { "id": 1234569, "question": "Where would the candidate be willing to work?", "answer": "London, Dubai, San Diego" } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The scorecard's unique identifier</td> </tr> <tr> <td>candidate_id</td> <td>The ID of the <a href="#candidates">candidate</a> whom this scorecard was written for.</td> </tr> <tr> <td>submitted_by</td> <td>The <a href="#users">user</a> who submitted this scorecard. Note that this user may not necessarily be the the interviewer, since scorecards can be submitted on behalf of other users.</td> </tr> <tr> <td>interviewer</td> <td>The <a href="#users">user</a> who interviewed the candidate.</td> </tr> <tr> <td>overall_recommendation</td> <td>One of: <code>definitely_not</code>, <code>no</code>, <code>yes</code>, <code>strong_yes</code>, <code>no_decision</code></td> </tr> <tr> <td>attributes</td> <td>Array containing the attributes of the Scorecard. Describes each attribute's name, type, rating (can be "no_decision"), and an optional note.</td> </tr> </tbody></table> <h2 id='get-list-scorecards'>GET: List Scorecards</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/scorecards' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 123, "updated_at": "2016-08-22T19:52:38.384Z", "created_at": "2016-08-22T19:52:38.384Z", "interview": "Application Review", "interview_step": { "id": 432, "name": "Application Review" }, "candidate_id": 1234, "application_id": 3456, "interviewed_at": "2016-08-18T16:00:00.000Z", "submitted_by": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "interviewer": { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" }, "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": "Qualifications", "note": null, "rating": "mixed" }, { "name": "Problem Solver", "type": "Qualifications", "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." }, { "id": 1234567, "question": "Does the candidate have experience designing APIs?", "answer": "Yes" }, { "id": 1234568, "question": "Which team would you suggest for this candidate?", "answer": "Alpha Team" }, { "id": 1234569, "question": "Where would the candidate be willing to work?", "answer": "London, Dubai, San Diego" } ] }, { "id": 3414169, "updated_at": "2016-01-08T19:07:08.295Z", "created_at": "2016-01-08T19:07:08.295Z", "interview": "Behavioral Phone Interview", "interview_step": { "id": 433, "name": "Behavioral Phone Interview" }, "candidate_id": 14271904, "application_id": 23558552, "interviewed_at": "2016-01-08T17:00:00.000Z", "submitted_by": { "id": 158104, "first_name": "Jane", "last_name": "Doe", "name": "Dane Doe", "employee_id": "034509364" }, "interviewer": { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" }, "submitted_at": "2016-01-08T19:07:08.295Z", "overall_recommendation": "no", "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": "Qualifications", "note": null, "rating": "mixed" }, { "name": "Problem Solver", "type": "Qualifications", "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." }, { "id": 1234567, "question": "Does the candidate have experience designing APIs?", "answer": "Yes" }, { "id": 1234568, "question": "Which team would you suggest for this candidate?", "answer": "Alpha Team" }, { "id": 1234569, "question": "Where would the candidate be willing to work?", "answer": "London, Dubai, San Diego" } ] } ] </code></pre></div> List all of an organization's scorecards. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/scorecards</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving scorecards will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>created_before</td> <td>Return only scorecards that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only scorecards that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only scorecards that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only scorecards that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> </tbody></table> <a href="#the-scorecard-object">See noteworthy response attributes.</a> <h2 id='get-list-scorecards-for-application'>GET: List Scorecards for Application</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/applications/{id}/scorecards' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 211231, "updated_at": "2016-08-22T19:52:38.384Z", "created_at": "2016-08-22T19:52:38.384Z", "interview": "Application Review", "interview_step": { "id": 432, "name": "Application Review" }, "candidate_id": 2131415, "application_id": 23558552, "interviewed_at": "2016-08-18T16:00:00.000Z", "submitted_by": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "interviewer": { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" }, "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": "Qualifications", "note": null, "rating": "mixed" }, { "name": "Problem Solver", "type": "Qualifications", "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." }, { "id": 1234567, "question": "Does the candidate have experience designing APIs?", "answer": "Yes" }, { "id": 1234568, "question": "Which team would you suggest for this candidate?", "answer": "Alpha Team" }, { "id": 1234569, "question": "Where would the candidate be willing to work?", "answer": "London, Dubai, San Diego" } ] }, { "id": 3414169, "updated_at": "2016-01-08T19:07:08.295Z", "created_at": "2016-01-08T19:07:08.295Z", "interview": "Behavioral Phone Interview", "interview_step": { "id": 433, "name": "Behavioral Phone Interview" }, "candidate_id": 14271904, "application_id": 23558552, "interviewed_at": "2016-01-08T17:00:00.000Z", "submitted_by": { "id": 158104, "first_name": "Jane", "last_name": "Doe", "name": "Dane Doe", "employee_id": "034509364" }, "interviewer": { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" }, "submitted_at": "2016-01-08T19:07:08.295Z", "overall_recommendation": "no", "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": "Qualifications", "note": null, "rating": "mixed" }, { "name": "Problem Solver", "type": "Qualifications", "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." }, { "id": 1234567, "question": "Does the candidate have experience designing APIs?", "answer": "Yes" }, { "id": 1234568, "question": "Which team would you suggest for this candidate?", "answer": "Alpha Team" }, { "id": 1234569, "question": "Where would the candidate be willing to work?", "answer": "London, Dubai, San Diego" } ] } ] </code></pre></div> List all submitted scorecards for the requested application. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/applications/{id}/scorecards</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>ID of application whose scorecards you want to retrieve.</td> </tr> </tbody></table> <a href="#the-scorecard-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-scorecard'>GET: Retrieve Scorecard</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/scorecards/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 211231, "updated_at": "2016-08-22T19:52:38.384Z", "created_at": "2016-08-22T19:52:38.384Z", "interview": "Application Review", "interview_step": { "id": 432, "name": "Application Review" }, "candidate_id": 2131415, "application_id": 23558552, "interviewed_at": "2016-08-18T16:00:00.000Z", "submitted_by": { "id": 4080, "first_name": "Kate", "last_name": "Austen", "name": "Kate Austen", "employee_id": "12345" }, "interviewer": { "id": 821, "first_name": "Robert", "last_name": "Robertson", "name": "Robert Robertson", "employee_id": "100377" }, "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": "Qualifications", "note": null, "rating": "mixed" }, { "name": "Problem Solver", "type": "Qualifications", "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." }, { "id": 1234567, "question": "Does the candidate have experience designing APIs?", "answer": "Yes" }, { "id": 1234568, "question": "Which team would you suggest for this candidate?", "answer": "Alpha Team" }, { "id": 1234569, "question": "Where would the candidate be willing to work?", "answer": "London, Dubai, San Diego" } ] } </code></pre></div><h3 id='http-request-3'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/scorecards/{id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the scorecard to retrieve</td> </tr> </tbody></table> <a href="#the-scorecard-object">See noteworthy response attributes.</a> <h1 id='sources'>Sources</h1><h2 id='the-source-object'>The source object</h2> An organization's sources. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 632, "name": "Other", "type": { "id": 5, "name": "Prospecting" } } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The source's unique identifier</td> </tr> <tr> <td>type.name</td> <td>One of: <code>attend_events</code>, <code>referrals</code>, <code>third_party_boards</code>, <code>candidate_search</code>, <code>other</code>, <code>social_media</code>, <code>company_marketing</code>, <code>agencies</code>, <code>prospecting</code></td> </tr> </tbody></table> <h2 id='get-list-sources'>GET: List Sources</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/sources' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 632, "name": "Other", "type": { "id": 5, "name": "Prospecting" } }, { "id": 928, "name": "Destiny", "type": { "id": 7, "name": "Supernatural Means" } } ] </code></pre></div> Lists an organization's sources, grouped by strategy. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/sources</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving sources will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> </tbody></table> <a href="#the-source-object">See noteworthy response attributes.</a> <h1 id='tags'>Tags</h1> 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. <h2 id='the-candidate-tag-object'>The candidate tag object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 230, "name": "New York" } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The candidate tag's unique identifier</td> </tr> <tr> <td>name</td> <td>The name of the tag</td> </tr> </tbody></table> <h2 id='get-list-candidate-tags'>GET: List Candidate Tags</h2> List all of an organization's candidate tags. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X GET 'https://harvest.greenhouse.io/v1/tags/candidate' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 365, "name": "Ruby" }, { "id": 366, "name": "Rails" }, { "id": 367, "name": "Junior" } ] </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/tags/candidate</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving candidate tags will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> </tbody></table> <a href="#the-candidate-tag-object">See noteworthy response attributes.</a> <h2 id='post-add-new-candidate-tag'>POST: Add New Candidate Tag</h2> Add a new candidate tag to this organization <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/tags/candidate' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "name": "New tag name" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 123456, "name": "New tag name" } </code></pre></div><h3 id='http-request-2'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/tags/candidate</code> Name is required and case insensitive. If a tag is supplied that already exists in Greenhouse with any combination of casing, a 200 response code will be returned. If the tag does not exist in Greenhouse, a 201 response code will be returned. The JSON response structure will be the same regardless of the success response code. <h2 id='delete-destroy-a-candidate-tag'>DELETE: Destroy a candidate tag</h2> Removes a candidate tag from this organization <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/tags/candidate/{tag id}' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><h3 id='http-request-3'>HTTP Request</h3> <code>DELETE 'https://harvest.greenhouse.io/v1/tags/candidate/{tag id}</code> This endpoint creates an asynchronous job to remove this tag from all candidates to whom it is applied before removing the tag itself from Greenhouse. This data cannot be recovered. Due to the number of candidates that may have any given tag, it may take up to 24 hours for this job to process completely. A success message from this endpoint only states a deletion job has been enqueued, not that the job has been completed. <h2 id='get-list-tags-applied-to-candidate'>GET: List tags applied to candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X GET 'https://harvest.greenhouse.io/v1/candidates/{id}/tags' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 239759, "name": "Don't have a job open for them now" } ] </code></pre></div> Retrieve the list of tags applied to a given candidate <h3 id='http-request-4'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/candidates/{id}/tags</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the candidate whose tags you want to retrieve</td> </tr> </tbody></table> <a href="#the-candidate-tag-object">See noteworthy response attributes.</a> <h2 id='delete-remove-tag-from-candidate'>DELETE: Remove tag from candidate</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X DELETE 'https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "message": "Tag 365 has been removed from candidate 29555013" } </code></pre></div> Remove a tag from a candidate <h3 id='http-request-5'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>candidate_id</td> <td>The ID of the candidate to whom you want to apply the tag</td> </tr> <tr> <td>tag_id</td> <td>The ID of the tag you wish to apply</td> </tr> </tbody></table> <a href="#the-candidate-tag-object">See noteworthy response attributes.</a> <h3 id='json-body-parameters'>JSON Body Parameters</h3> No body parameters. <h2 id='put-add-a-candidate-tag'>PUT: Add a candidate tag</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "message": "Tag 365, 'Ruby', has been applied to candidate 29555013" } </code></pre></div> Apply a tag to a given candidate <h3 id='http-request-6'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/candidates/{candidate_id}/tags/{tag_id}</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>candidate_id</td> <td>The ID of the candidate to whom you want to apply the tag</td> </tr> <tr> <td>tag_id</td> <td>The ID of the tag you wish to apply</td> </tr> </tbody></table> <a href="#the-candidate-tag-object">See noteworthy response attributes.</a> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> No body parameters. <h1 id='tracking-links'>Tracking Links</h1> 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. <h2 id='the-tracking-link-object'>The tracking link object</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 6004841, "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": 12314, "job_post_id": 124263, "job_board": { "id": 8578, "company_name": "Business Corp", "url_token": "businessco" }, "source": { "id": 4, "public_name": "Twitter" }, "credited_to": { "id": 1, "first_name": "Some", "last_name": "Employee", "name": "Some Employee", "employee_id": "ABC12345" } } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The tracking link's unique identifier</td> </tr> <tr> <td>token</td> <td>The token present in the url</td> </tr> <tr> <td>related_post_id</td> <td>If there is an associated social media post, the Greenhouse ID for that post</td> </tr> <tr> <td>related_post_type</td> <td>Will be "SocialMediaPost" if the link was posted through the social network sharing feature, otherwise this value will be <code>null</code></td> </tr> <tr> <td>job_id</td> <td>The job associated with this tracking link</td> </tr> <tr> <td>job_post_id</td> <td>The job post associated with this tracking link</td> </tr> <tr> <td>job_board</td> <td>The job board associated with this tracking link</td> </tr> <tr> <td>source</td> <td>The source of the job (recruiter, social media site, etc)</td> </tr> <tr> <td>credited_to</td> <td>The employee credited with a referral for this tracking link</td> </tr> </tbody></table> <h2 id='json-schema'>JSON Schema</h2> To view the JSON Schema definition for the Tracking Link object, please <a href="schemas/tracking_links.json">click here</a>. This will tell you all of the valid types and definitions, as well as expected fields in the response. <h2 id='get-tracking-link-data-for-token'>GET: Tracking Link Data for Token</h2> Retrieve the specific tracking link data for the supplied token. <div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X GET 'https://harvest.greenhouse.io/v1/tracking_links/{token}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 6004841, "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": 12314, "job_post_id": 124263, "job_board": { "id": 8578, "company_name": "Business Corp", "url_token": "businessco" }, "source": { "id": 4, "public_name": "Twitter" }, "credited_to": { "id": 1, "first_name": "Some", "last_name": "Employee", "name": "Some Employee", "employee_id": "ABC12345" } } </code></pre></div><h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/tracking_links/{token}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>token</td> <td>The token you want to retrieve the data for</td> </tr> </tbody></table> <a href="#the-tracking-link-object">See noteworthy response attributes.</a> <h1 id='users'>Users</h1><h2 id='the-user-object'>The user object</h2> An organization's Greenhouse users. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 112, "name": "Juliet Burke", "first_name": "Juliet", "last_name": "Burke", "primary_email_address": "juliet.burke@example.com", "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", "linked_candidate_ids": [123, 654], "offices": [ { "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 150893, "parent_id": 50849, "parent_office_external_id": "14679", "child_ids": [50852, 50891], "child_office_external_ids": ["13473", "123473"], "external_id": "15679" } ], "departments": [ { "id": 25907, "name": "Second-Level department", "parent_id": 25908, "parent_department_external_id": "13473", "child_ids": [50852, 50891], "child_department_external_ids": ["13473", "123473"], "external_id": "15679" } ] } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy Attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The user's unique identifier</td> </tr> <tr> <td>site_admin</td> <td>If <code>true</code>, this user is a site admin, which means the user has full permissions on all non-private jobs.</td> </tr> <tr> <td>primary_email_address</td> <td>The e-mail address this user has designated as his or her primary e-mail address. This value should always also be in the emails array.</td> </tr> <tr> <td>linked_candidate_ids[]</td> <td>Contains the IDs of candidate records containing this user's personal applications. In other words, the records containing this user's personal interview records and information.</td> </tr> <tr> <td>offices</td> <td>An array containing the <a href="#offices">offices</a> this user is associated with.</td> </tr> <tr> <td>departments</td> <td>An array containing the <a href="#departments">department</a> which this user is associated with.</td> </tr> <tr> <td>custom_fields</td> <td>Contains a hash of the custom fields configured for this resource. The properties in this hash reflect the active custom fields as of the time this method is called.</td> </tr> <tr> <td>keyed_custom_fields</td> <td>This contains the same information as custom_fields but formatted in a different way that includes more information. This will tell you the type of custom field data to expect, the text name of custom field, and the value. The key of this hash is the custom field’s immutable field key, which will not change even if the name of the custom field is changed in Greenhouse.</td> </tr> </tbody></table> <h2 id='get-list-users'>GET: List Users</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/users' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 112, "name": "Juliet Burke", "first_name": "Juliet", "last_name": "Burke", "primary_email_address": "juliet.burke@example.com", "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", "linked_candidate_ids": [123, 654], "offices": [ { "id": 47012, "name": "New York", "location": { "name": "New York, United States" }, "primary_contact_user_id": 150893, "parent_id": 50849, "parent_office_external_id": "14679", "child_ids": [50852, 50891], "child_office_external_ids": ["13473", "123473"], "external_id": "15679" } ], "departments": [ { "id": 25907, "name": "Research & Development", "parent_id": 25908, "parent_department_external_id": "13473", "child_ids": [50852, 50891], "child_department_external_ids": ["13473", "123473"], "external_id": "15679" } ] }, { "id": 712, "name": "John Doe", "first_name": "John", "last_name": "Doe", "primary_email_address": "john.doe@example.com", "updated_at": "2016-11-03T18:05:47.361Z", "created_at": "2015-11-18T22:27:11.111Z", "disabled": false, "site_admin": true, "emails": [ "john.doe@example.com" ], "employee_id": "700", "linked_candidate_ids": [789, 1022], "offices": [ { "id": 47013, "name": "San Francisco", "location": { "name": "San Francisco, California" }, "primary_contact_user_id": 150894, "parent_id": 50850, "parent_office_external_id": "14680", "child_ids": [50852, 50891], "child_office_external_ids": ["13473", "123473"], "external_id": "15679" } ], "departments": [ { "id": 25907, "name": "Marketing", "parent_id": 25908, "parent_department_external_id": "13473", "child_ids": [50852, 50891], "child_department_external_ids": ["13473", "123473"], "external_id": "15679" } ] } ] </code></pre></div> List all of an organization's Greenhouse users. If the querystring param <code>user_attributes=true</code> is passed, the response will also include custom field and keyed custom field values. If the param is not passed, these values will not be displayed. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/users</code> <h3 id='querystring-parameters'>Querystring parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*per_page</td> <td>Return up to this number of objects per response. Must be an integer between 1 and 500. Defaults to 100.</td> </tr> <tr> <td>*page</td> <td>A cursor for use in pagination. Returns the n-th chunk of <code>per_page</code> objects.</td> </tr> <tr> <td>*skip_count</td> <td>If <code>true</code>, the performance of retrieving users will improve. This will remove <code>last</code> from the <code>link</code> response header.</td> </tr> <tr> <td>employee_id</td> <td>Return only users that match this employee id.</td> </tr> <tr> <td>created_before</td> <td>Return only users that were created before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>created_after</td> <td>Return only users that were created at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_before</td> <td>Return only users that were updated before this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>updated_after</td> <td>Return only users that were updated at or after this timestamp. Timestamp must be in in <a href="#general-considerations">ISO-8601</a> format.</td> </tr> <tr> <td>email</td> <td>Return a single user who has this e-mail address as their primary e-mail or a secondary e-mail.</td> </tr> <tr> <td>user_attributes</td> <td>When <code>true</code>, include user attributes. Otherwise excludes user attributes. Defaults to <code>false</code>.</td> </tr> </tbody></table> <a href="#the-user-object">See noteworthy response attributes.</a> <h2 id='get-retrieve-user'>GET: Retrieve User</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/users/{id}' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 112, "name": "Juliet Burke", "first_name": "Juliet", "last_name": "Burke", "primary_email_address": "juliet.burke@example.com", "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", "linked_candidate_ids": [123, 654], "offices": [ { "id": 47013, "name": "San Francisco", "location": { "name": "San Francisco, California" }, "primary_contact_user_id": 150894, "parent_id": 50850, "parent_office_external_id": "14680", "child_ids": [50852, 50891], "child_office_external_ids": ["13473", "123473"], "external_id": "15679" } ], "departments": [ { "id": 25907, "name": "Marketing", "parent_id": 25908, "parent_department_external_id": "13473", "child_ids": [50852, 50891], "child_department_external_ids": ["13473", "123473"], "external_id": "15679" } ], "custom_fields": { "equipment": "Laptop", "shirt_size": "M", "hiring_specialties": [ "Engineers", "Executives" ], "trained_for_interviews": true, "recruiting_partner": { "name": "Johnny Recruiter", "email": "johnny@example.com", "user_id": 4000000000 } }, "keyed_custom_fields": { "equipment": { "name": "Equipment", "type": "short_text", "value": "Laptop" }, "shirt_size": { "name": "Shirt Size", "type": "single_select", "value": "M" }, "hiring_specialties": { "name": "Hiring Specialties", "type": "multi_select", "value": [ "Engineers", "Executives" ] }, "trained_for_interviews": { "name": "Trained for interviews", "type": "boolean", "value": true }, "recruiting_partner": { "name": "Recruiting Partner", "type": "user", "value": { "name": "Johnny Recruiter", "email": "johnny@example.com", "user_id": 4000000000 } } } } </code></pre></div><h3 id='http-request-2'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/users/{id}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the user to retrieve</td> </tr> </tbody></table> <h3 id='querystring-parameters-2'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>employee_id</td> <td>The Employee ID of the user to retrieve</td> </tr> </tbody></table> <a href="#the-user-object">See noteworthy response attributes.</a> <h2 id='patch-edit-user'>PATCH: Edit User</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v2/users/' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "user": { "email": "test@example.com" }, "payload": { "first_name": "Bob", "last_name": "Smith", "employee_id": "ABC12345", "office_ids": [12345, 67890], "department_ids": [12345, 67890], "custom_fields": [ { "id": 1234, "value": "Some new value" }, { "name_key": "custom_field_name_key", "value": "Some new value" }, { "id": 5678, "delete_value": "true" } ] } } </code></pre></div> <blockquote> The user element must contain one of 'employee_id', 'email', or 'user_id', but not more than one. The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": "true" } </code></pre></div> Edit a user's basic information. You may look up a user via their Greenhouse user id, their internal employee id, or their e-mail address in Greenhouse. Any of the e-mail addresses tied to the user's account can be used. The user information must be provided in a JSON body. Only one of user_id, employee_id (if available), or e-mail address may be provided. Employee id or e-mail address must be a string. User ID must be a number. <h3 id='http-request-3'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v2/users/</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>first_name</td> <td>No</td> <td>string</td> <td>The user's new first name. If included, this cannot be blank.</td> </tr> <tr> <td>last_name</td> <td>No</td> <td>string</td> <td>The user's new last name. If included, this cannot be blank.</td> </tr> <tr> <td>employee_id*</td> <td>No</td> <td>string</td> <td>The 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.</td> </tr> <tr> <td>office_ids</td> <td>No</td> <td>Array</td> <td>Replace the current offices for this user with new offices. An empty array will remove all offices on this user.</td> </tr> <tr> <td>external_office_ids</td> <td>No</td> <td>Array</td> <td>This may be used instead of <code>office_ids</code> and represents the ID of the office in an external system. If this is used, <code>office_ids</code> must be blank and vice versa.</td> </tr> <tr> <td>department_ids</td> <td>No</td> <td>Array</td> <td>Replace the current departments for this user with new departments. An empty array will remove all departments on this user.</td> </tr> <tr> <td>external_department_ids</td> <td>No</td> <td>Array</td> <td>This may be used instead of <code>department_ids</code> and represents the ID of the department in an external system. If used, <code>department_ids</code> must be blank and vice versa.</td> </tr> <tr> <td>custom_fields</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new custom field values. Passing an empty array does nothing.</td> </tr> </tbody></table> * - If the employee_id feature is not enabled for your organization, attempting to edit this field will raise an API Error. The "employee_id" element exists in both the "user" element as a look-up mechanism and in the "payload" element as a patching mechanism. <h3 id='custom-field-parameters'>Custom Field Parameters</h3> The custom field parameter structure is different in the PATCH method than 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. <table><thead> <tr> <th>Parameter</th> <th>Required for</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>all</td> <td>The custom field id for this particular custom field. One of this or name_key is required.</td> </tr> <tr> <td>name_key</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>value</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>delete_value</td> <td>n/a</td> <td>When this element is included with a value of <code>"true"</code> (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.</td> </tr> </tbody></table> * At this time, user attributes only supports the following field types: single_select, multi_select, yes_no, and user <h2 id='patch-disable-user'>PATCH: Disable User</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v2/users/disable' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "user": {"email": "test@example.com"} } </code></pre></div> <blockquote> or <code>json { "user": {"user_id": 11234} } </code> or <code>json { "user": {"employee_id": "user-123"} } </code> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 11234, "name": "Bob Smith", "first_name": "Bob", "last_name": "Smith", "primary_email_address": "test@example.com", "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": "user-123", "linked_candidate_ids": [123, 654], "offices": [ { "id": 47013, "name": "San Francisco", "location": { "name": "San Francisco, California" }, "primary_contact_user_id": 150894, "parent_id": 50850, "parent_office_external_id": "14680", "child_ids": [50852, 50891], "child_office_external_ids": ["13473", "123473"], "external_id": "15679" } ], "departments": [ { "id": 25907, "name": "Marketing", "parent_id": 25908, "parent_department_external_id": "13473", "child_ids": [50852, 50891], "child_department_external_ids": ["13473", "123473"], "external_id": "15679" } ], "custom_fields": { "equipment": "Laptop", "shirt_size": "M", "hiring_specialties": [ "Engineers", "Executives" ], "trained_for_interviews": true, "recruiting_partner": { "name": "Johnny Recruiter", "email": "johnny@example.com", "user_id": 4000000000 } }, "keyed_custom_fields": { "equipment": { "name": "Equipment", "type": "short_text", "value": "Laptop" }, "shirt_size": { "name": "Shirt Size", "type": "single_select", "value": "M" }, "hiring_specialties": { "name": "Hiring Specialties", "type": "multi_select", "value": [ "Engineers", "Executives" ] }, "trained_for_interviews": { "name": "Trained for interviews", "type": "boolean", "value": true }, "recruiting_partner": { "name": "Recruiting Partner", "type": "user", "value": { "name": "Johnny Recruiter", "email": "johnny@example.com", "user_id": 4000000000 } } } } </code></pre></div> Disable a user. This endpoint allows you to disable a user via their Greenhouse user id, their internal employee id, or their e-mail address in Greenhouse. Any of the e-mail addresses tied to the user's account can be used. The user information must be provided in a JSON body. Only one of user_id, employee_id (if available), or e-mail address may be provided. Employee id or e-mail address must be a string. User ID must be a number. It is safe to call this method on a user that is currently disabled. If the user is already disabled, nothing happens. <h3 id='http-request-4'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v2/users/disable</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h2 id='patch-enable-user'>PATCH: Enable User</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v2/users/enable' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "user": {"email": "test@example.com"} } </code></pre></div> <blockquote> or <code>json { "user": {"user_id": 11234} } </code> or <code>json { "user": {"employee_id": "user-123"} } </code> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 253528, "name": "Bob Smith", "first_name": "Bob", "last_name": "Smith", "primary_email_address": "bob@email.org", "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", "linked_candidate_ids": [123, 654], "offices": [ { "id": 47013, "name": "San Francisco", "location": { "name": "San Francisco, California" }, "primary_contact_user_id": 150894, "parent_id": 50850, "parent_office_external_id": "14680", "child_ids": [50852, 50891], "child_office_external_ids": ["13473", "123473"], "external_id": "15679" } ], "departments": [ { "id": 25907, "name": "Marketing", "parent_id": 25908, "parent_department_external_id": "13473", "child_ids": [50852, 50891], "child_department_external_ids": ["13473", "123473"], "external_id": "15679" } ], "custom_fields": { "equipment": "Laptop", "shirt_size": "M", "hiring_specialties": [ "Engineers", "Executives" ], "trained_for_interviews": true, "recruiting_partner": { "name": "Johnny Recruiter", "email": "johnny@example.com", "user_id": 4000000000 } }, "keyed_custom_fields": { "equipment": { "name": "Equipment", "type": "short_text", "value": "Laptop" }, "shirt_size": { "name": "Shirt Size", "type": "single_select", "value": "M" }, "hiring_specialties": { "name": "Hiring Specialties", "type": "multi_select", "value": [ "Engineers", "Executives" ] }, "trained_for_interviews": { "name": "Trained for interviews", "type": "boolean", "value": true }, "recruiting_partner": { "name": "Recruiting Partner", "type": "user", "value": { "name": "Johnny Recruiter", "email": "johnny@example.com", "user_id": 4000000000 } } } } </code></pre></div> Enable a user. You may enable a user via their Greenhouse user id, their internal employee id, or their e-mail address in Greenhouse. Any of the e-mail addresses tied to the user's account can be used. The user information must be provided in a JSON body. Only one of user_id, employee_id (if available), or e-mail address may be provided. Employee id or e-mail address must be a string. User ID must be a number. It is safe to call this method on a user that is currently enabled. If the user is already enabled, nothing happens. <h3 id='http-request-5'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v2/users/enable</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h2 id='patch-change-user-permission-level'>PATCH: Change user permission level</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PATCH 'https://harvest.greenhouse.io/v1/users/permission_level' -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "user": {"email": "test@example.com"}, "level": "basic" } </code></pre></div> <blockquote> or <code>json { "user": {"user_id": 11234}, "level": "basic" } </code> or <code>json { "user": {"employee_id": "user-123"}, "level": "basic" } </code> The above command returns JSON structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "success": true } </code></pre></div> Changes the permissions user level, i.e. Site Admin, Job Admin, Basic user This endpoint will only convert the user to a Basic user. Other permission levels are not supported due to security constraints. This means changing the user permission level is not reversible through this endpoint. When converting a user’s permission level to Basic, any previously assigned job-based, developer, or user-specific permissions will be removed. Note that this will remove the user from assigned roles on any jobs, e.g. Recruiter or Coordinator. This will also remove the user from any outstanding approval flows. <h3 id='http-request-6'>HTTP Request</h3> <code>PATCH https://harvest.greenhouse.io/v1/users/permission_level</code> <h3 id='headers-4'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>user</td> <td>Yes</td> <td>object</td> <td>An object containing one of email, user_id, or employee_id fields.</td> </tr> <tr> <td>email</td> <td>No</td> <td>string</td> <td>The email address associated with the user. One of email, user_id, or employee_id is required.</td> </tr> <tr> <td>user_id</td> <td>No</td> <td>string</td> <td>The ID of the user. One of email, user_id, or employee_id is required.</td> </tr> <tr> <td>employee_id</td> <td>No</td> <td>string</td> <td>The external employee_id of the user. One of email, user_id, or employee_id is required.</td> </tr> <tr> <td>level</td> <td>Yes</td> <td>string</td> <td>The permission level to be assigned to the user. The only accepted value is “basic”. Other permission levels are not accepted due to security constraints.</td> </tr> </tbody></table> Note: This endpoint accepts users with Job Admin or Site Admin permission levels. Basic users will be ignored and will return a 200 response. <h2 id='post-add-user'>POST: Add User</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/users' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "first_name": "Bob", "last_name": "Smith", "email": "bob@email.org", "send_email_invite": true, "employee_id": "ABC12345", "office_ids": [47013], "department_ids": [25907], "custom_fields": [ { "name_key": "shirt_size", "value": "Medium" }, { "id": 12345, "value": "Laptop" } ] } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 253818, "name": "Bob Smith", "first_name": "Bob", "last_name": "Smith", "primary_email_address": "bob@email.org", "updated_at": "2018-06-07T22:12:31.303Z", "created_at": "2016-04-28T19:10:46.688Z", "disabled": false, "site_admin": false, "emails": [ "bob@email.org" ], "employee_id": "ABC12345", "linked_candidate_ids": [123, 654], "offices": [ { "id": 47013, "name": "San Francisco", "location": { "name": "San Francisco, California" }, "primary_contact_user_id": 150894, "parent_id": 50850, "parent_office_external_id": "14680", "child_ids": [50852, 50891], "child_office_external_ids": ["13473", "123473"], "external_id": "15679" } ], "departments": [ { "id": 25907, "name": "Marketing", "parent_id": 25908, "parent_department_external_id": "13473", "child_ids": [50852, 50891], "child_department_external_ids": ["13473", "123473"], "external_id": "15679" } ], "custom_fields": { "equipment": "Laptop", "shirt_size": "Medium" }, "keyed_custom_fields": { "equipment": { "name": "Equipment", "type": "short_text", "value": "Laptop" }, "shirt_size": { "name": "Shirt Size", "type": "single_select", "value": "Medium" } } } </code></pre></div> Create a new user with Basic permissions. <h3 id='http-request-7'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/users</code> <h3 id='headers-5'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-3'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>first_name</td> <td>Yes</td> <td>string</td> <td>The user's first name</td> </tr> <tr> <td>last_name</td> <td>Yes</td> <td>string</td> <td>The user's last name</td> </tr> <tr> <td>email</td> <td>Yes</td> <td>string</td> <td>The user's email address. Must be a valid email address.</td> </tr> <tr> <td>send_email_invite*</td> <td>No</td> <td>boolean</td> <td>If 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.</td> </tr> <tr> <td>employee_id</td> <td>No</td> <td>string</td> <td>The user's external employee id.</td> </tr> <tr> <td>office_ids</td> <td>No</td> <td>Array</td> <td>The office value(s) associated with a user. Must be a valid set of office IDs. Passing an empty array does nothing.</td> </tr> <tr> <td>external_office_ids</td> <td>No</td> <td>Array</td> <td>This may be used instead of <code>office_ids</code> and represents the ID of the office in an external system. If this is used, <code>office_ids</code> must be blank and vice versa.</td> </tr> <tr> <td>department_ids</td> <td>No</td> <td>Array</td> <td>The department value(s) associated with a user. Must be a valid set of department IDs. Passing an empty array does nothing.</td> </tr> <tr> <td>external_department_ids</td> <td>No</td> <td>Array</td> <td>This may be used instead of <code>department_ids</code> and represents the ID of the department in an external system. If this is used, <code>department_ids</code> must be blank and vice versa.</td> </tr> <tr> <td>custom_fields</td> <td>No</td> <td>custom_field</td> <td>Array of hashes containing new custom field values. Passing an empty array does nothing.</td> </tr> </tbody></table> * - 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. ** - The employee_id feature is available only for customers with the Advanced and Expert Greenhouse Recruiting package. Use of this field will return an error for other Greenhouse Recruiting customers. <h3 id='custom-field-parameters-2'>Custom Field Parameters</h3> The custom field parameter structure is different in the POST method than in GET methods and responses. Certain type of custom fields require different elements to be included. What follows is the description of each item in a custom field element and what is required depending on the type. <table><thead> <tr> <th>Parameter</th> <th>Required for</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>all</td> <td>The custom field id for this particular custom field. One of this or name_key is required.</td> </tr> <tr> <td>name_key</td> <td>all</td> <td>The 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.</td> </tr> <tr> <td>value</td> <td>all</td> <td>The 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.</td> </tr> </tbody></table> * At this time, user attributes only supports the following field types: single_select, multi_select, yes_no, and user <h2 id='post-add-e-mail-address-to-user'>POST: Add E-mail Address To User</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X POST 'https://harvest.greenhouse.io/v1/users/{id}/email_addresses' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "email": "bob@email.org", "send_verification": true } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 898318, "user_id": 253818, "email": "bob@email.org", "verified": "false" } </code></pre></div> 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. <h3 id='http-request-8'>HTTP Request</h3> <code>POST https://harvest.greenhouse.io/v1/users/{id}/email_addresses</code> <h3 id='headers-6'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-4'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>email</td> <td>Yes</td> <td>string</td> <td>The user's email address. Must be a valid email address.</td> </tr> <tr> <td>send_verification</td> <td>No</td> <td>boolean</td> <td>If true, an email will be sent to the user to verify this e-mail address. If false, nothing happens. Default is false.</td> </tr> </tbody></table> There are 3 successful response states for this endpoint. <ul> <li>201: A new e-mail address was received and created. This will be the response code regardless of the verification setting.</li> <li>200: An e-mail was generated for an unverified e-mail address. This is the case if we attempt to re-send a verification e-mail to an unverified e-mail address.</li> <li>204: A request was made which caused Greenhouse to do nothing. This will occur if you attempt to re-send a verification e-mail to an address that has already been verified or if you make a follow-up request to an unverified e-mail with send_verification set to false.</li> </ul> <h1 id='user-permissions'>User Permissions</h1><h2 id='the-job-permission-object'>The job permission object</h2> The user role a user has for a job. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 382934, "job_id": 9192, "user_role_id": 123 } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy Attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The job permission's unique identifier</td> </tr> <tr> <td>job_id</td> <td>The ID of the job the user has permission for</td> </tr> <tr> <td>user_role_id</td> <td>The ID of the user role the user has for the job</td> </tr> </tbody></table> <h2 id='get-list-job-permissions'>GET: List Job Permissions</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "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 } ] </code></pre></div> List the job permissions for a given user. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the user whose job permissions to retrieve</td> </tr> </tbody></table> 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 <a href="#pagination">Pagination</a> section for more detail. <h2 id='delete-remove-a-job-permission'>DELETE: Remove a Job Permission</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "job_permission_id": 27207466 } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "message": "Job Permission 321231 has been deleted." } </code></pre></div> Removes a user's job permission. <h3 id='http-request-2'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs</code> <h3 id='headers'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_permission_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job permission</td> </tr> </tbody></table> <h2 id='put-add-a-job-permission'>PUT: Add a Job Permission</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "job_id": "150056", "user_role_id": "16229" } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 42906871, "job_id": 150056, "user_role_id": 16229 } </code></pre></div> Creates a job permission with a specific user role for a given user. <h3 id='http-request-3'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/users/{id}/permissions/jobs</code> <h3 id='headers-2'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-2'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>job_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the job</td> </tr> <tr> <td>user_role_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the user role</td> </tr> </tbody></table> Note: This endpoint does not support assigning a user role to a user for a confidential job. <h3 id='response'>Response</h3> Adding a job permission to a regular user returns status 201. Adding a job permission to a site admin user has no effect, and returns 204. <h2 id='the-future-job-permission-object'>The future job permission object</h2> The user role a user will get when a job with the specified criteria is created. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 87819, "office_id": 29192, "external_office_id": "ex-office-1", "department_id": 23425, "external_department_id": "ex-dept-1", "user_role_id": 4730 } </code></pre></div><h3 id='noteworthy-attributes-2'>Noteworthy Attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The future job permission's unique identifier</td> </tr> <tr> <td>office_id</td> <td>The ID of the office of the job</td> </tr> <tr> <td>external_office_id</td> <td>The ID of the office in an external system. This is set by users and has no bearing on any other object in Greenhouse. If not set in Greenhouse, this will be null.</td> </tr> <tr> <td>department_id</td> <td>The ID of the department of the job</td> </tr> <tr> <td>external_department_id</td> <td>The ID of the department in an external system. This is set by users and has no bearing on any other object in Greenhouse. If not set in Greenhouse, this will be null.</td> </tr> <tr> <td>user_role_id</td> <td>The ID of the user role that will be granted</td> </tr> </tbody></table> <h2 id='get-list-future-job-permissions'>GET: List Future Job Permissions</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 87819, "office_id": 24141, "external_office_id": "ex-office-1", "department_id": 12315, "external_department_id": "ex-dept-1", "user_role_id": 4730 }, { "id": 92834, "office_id": 8232, "external_office_id": "ex-office-2", "department_id": 12315, "external_department_id": "ex-dept-2", "user_role_id": 4730 }, { "id": 82129, "office_id": 8232, "external_office_id": "ex-office-2", "department_id": 92921, "external_department_id": null, "user_role_id": 4730 } ] </code></pre></div> List the permissions that will be granted to the user when a job is created in a particular Department/Office combination. <h3 id='http-request-4'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The ID of the user whose future job permissions to retrieve</td> </tr> </tbody></table> This endpoint supports pagination. See the <a href="#pagination">Pagination</a> section for more detail. <h2 id='delete-remove-a-future-job-permission'>DELETE: Remove a Future Job Permission</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "future_job_permission_id": 427600 } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "message": "Future Job Permission 639234 has been deleted." } </code></pre></div> Removes a user's future job permission. <h3 id='http-request-5'>HTTP Request</h3> <code>DELETE https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs</code> <h3 id='headers-3'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-3'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>future_job_permission_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the future job permission</td> </tr> </tbody></table> <h2 id='put-add-a-future-job-permission'>PUT: Add a Future Job Permission</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl -X PUT 'https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs' -H "Content-Type: application/json" -H "On-Behalf-Of: {greenhouse user ID}" -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div> <blockquote> The above command takes a JSON request, structured like this: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "office_id": 58028, "department_id": 45644, "user_role_id": 7607 } </code></pre></div> <blockquote> The above command returns a JSON response, structured like this: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>{ "id": 9283, "office_id": 281921, "external_office_id": "ex-office-1", "department_id": 61921, "external_department_id": "ex-dept-1", "user_role_id": 91821 } </code></pre></div> Creates a future job permission with a specific user role for a given user. <h3 id='http-request-6'>HTTP Request</h3> <code>PUT https://harvest.greenhouse.io/v1/users/{id}/permissions/future_jobs</code> <h3 id='headers-4'>Headers</h3> <table><thead> <tr> <th>Header</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>On-Behalf-Of</td> <td>ID of the user issuing this request. Required for auditing purposes.</td> </tr> </tbody></table> <h3 id='json-body-parameters-4'>JSON Body Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>office_id</td> <td>No</td> <td>integer</td> <td>The ID of the office. Set to null to include all offices.</td> </tr> <tr> <td>external_office_id</td> <td>No</td> <td>string</td> <td>An ID that represents the office in an external system. This may be used instead of office_id. If included, office_id must be blank, and vice versa.</td> </tr> <tr> <td>department_id</td> <td>No</td> <td>integer</td> <td>The ID of the department. Set to null to include all departments.</td> </tr> <tr> <td>external_department_id</td> <td>No</td> <td>string</td> <td>This may be used instead of department_id. If included, department_id must be blank, and vice versa.</td> </tr> <tr> <td>user_role_id</td> <td>Yes</td> <td>integer</td> <td>The ID of the user role</td> </tr> </tbody></table> <h3 id='response-2'>Response</h3> Adding a future job permission to a regular user returns status 201. Adding a future job permission to a site admin user has no effect, and returns 204. <h1 id='user-roles'>User Roles</h1><h2 id='the-user-role-object'>The user role object</h2> The roles that can be assigned to a user. <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 4729, "type": "interviewer", "name": "Interviewer" } </code></pre></div><h3 id='noteworthy-attributes'>Noteworthy Attributes</h3> <table><thead> <tr> <th>Attribute</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td>The user role ID</td> </tr> <tr> <td>type</td> <td>The type of role. Will be <code>interviewer</code> or <code>job_admin</code>.</td> </tr> <tr> <td>name</td> <td>The name of the role</td> </tr> </tbody></table> <h2 id='get-list-user-roles'>GET: List User Roles</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>curl 'https://harvest.greenhouse.io/v1/user_roles' -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>[ { "id": 4729, "type": "interviewer", "name": "Interviewer" }, { "id": 4730, "type": "job_admin", "name": "Standard" }, { "id": 4731, "type": "job_admin", "name": "Private" } ] </code></pre></div> List the organization's roles that can be assigned to a user. <h3 id='http-request'>HTTP Request</h3> <code>GET https://harvest.greenhouse.io/v1/user_roles</code> </div> <div class="dark-box"> <div class="lang-selector"> <a href="#" data-language-name="shell">shell</a> <a href="#" data-language-name="ruby">ruby</a> </div> </div> </div> </body> </html>