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>Job Board 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_job-board.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="job-board" data-languages="["json"]"> <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="json">json</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="#jsonp" class="toc-h2 toc-link" data-title="JSONP">JSONP</a> </li> <li> <a href="#authentication" class="toc-h2 toc-link" data-title="Authentication">Authentication</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="#list-jobs" class="toc-h2 toc-link" data-title="List jobs">List jobs</a> </li> <li> <a href="#retrieve-a-job" class="toc-h2 toc-link" data-title="Retrieve a job">Retrieve a job</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="#list-offices" class="toc-h2 toc-link" data-title="List offices">List offices</a> </li> <li> <a href="#retrieve-an-office" class="toc-h2 toc-link" data-title="Retrieve an office">Retrieve an office</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="#list-departments" class="toc-h2 toc-link" data-title="List departments">List departments</a> </li> <li> <a href="#retrieve-a-department" class="toc-h2 toc-link" data-title="Retrieve a department">Retrieve a department</a> </li> </ul> </li> <li> <a href="#prospect-post-sections" class="toc-h1 toc-link" data-title="Prospect Post Sections">Prospect Post Sections</a> <ul class="toc-list-h2"> <li> <a href="#list-sections" class="toc-h2 toc-link" data-title="List sections">List sections</a> </li> <li> <a href="#retrieve-a-section" class="toc-h2 toc-link" data-title="Retrieve a section">Retrieve a section</a> </li> </ul> </li> <li> <a href="#educations" class="toc-h1 toc-link" data-title="Educations">Educations</a> <ul class="toc-list-h2"> <li> <a href="#list-degrees" class="toc-h2 toc-link" data-title="List Degrees">List Degrees</a> </li> <li> <a href="#list-disciplines" class="toc-h2 toc-link" data-title="List Disciplines">List Disciplines</a> </li> <li> <a href="#list-schools" class="toc-h2 toc-link" data-title="List Schools">List Schools</a> </li> </ul> </li> <li> <a href="#job-boards" class="toc-h1 toc-link" data-title="Job Boards">Job Boards</a> <ul class="toc-list-h2"> <li> <a href="#retrieve-job-board" class="toc-h2 toc-link" data-title="Retrieve job board">Retrieve job board</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="#submit-an-application" class="toc-h2 toc-link" data-title="Submit an application">Submit an application</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/job-board" 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="/harvest.html" title="Harvest API">Harvest API</a></li> <li><a href='/candidate-ingestion.html' title="Ingestion API">Ingestion 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> With our Job Board API, you will have easy access to a simple JSON representation of your company's offices, departments, and published jobs. Since we give you access to the raw data, you can build careers pages with a unique look and feel, construct department-level pages, and more! We support JSONP callbacks, and have a POST method which can be used to build your own online job application form. <h2 id='jsonp'>JSONP</h2><div class="highlight"><pre class="highlight html tab-html"><code><script type="text/javascript" src="https://boards-api.greenhouse.io/v1/example/method/url?callback="> </script> </code></pre></div> To call a method via JSONP (http://en.wikipedia.org/wiki/JSONP), insert the script tag below into your HTML document with an appropriate method URL and provide your own method name in the "callback" querystring parameter. NOTE: The callback name may only contain numbers, letters, underscore, and period. <h2 id='authentication'>Authentication</h2> <aside class="success"> Job Board data is publicly available, so authentication is not required for any GET endpoints. </aside> Only the application submission endpoint (<code>POST https://boards-api.greenhouse.io/v1/boards/{board_token}/jobs/{id}</code>) requires Basic Auth. The Job Board API Key must be Base64 encoded before it can be used to post applications. <a href="#submit-an-application">Read more</a>. <h1 id='jobs'>Jobs</h1><h2 id='list-jobs'>List jobs</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "jobs": [ { "id":127817, "internal_job_id":144381, "title":"Vault Designer", "updated_at":"2016-01-14T10:55:28-05:00", "requisition_id": "50", "location":{ "name":"NYC" }, "absolute_url":"https://boards.greenhouse.io/vaulttec/jobs/127817", "metadata":null } ], "meta": { "total": 1 } } </code></pre></div> <blockquote> When <code>?content=true</code>: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "jobs": [ { "id":127817, "internal_job_id":144381, "title":"Vault Designer", "updated_at":"2016-01-14T10:55:28-05:00", "requisition_id": "50", "location":{ "name":"NYC" }, "absolute_url":"https://boards.greenhouse.io/vaulttec/jobs/127817", "metadata":null, "content":"This is the job description. &amp;lt;p&amp;gt;Any HTML included through the hosted job application editor will be automatically converted into corresponding HTML entities.&amp;lt;/p&amp;gt;", "departments":[ { "id":13583, "name":"Department of Departments", "parent_id":null, "child_ids":[ 13585 ] } ], "offices":[ { "id":8304, "name":"East Coast", "location":"United States", "parent_id":null, "child_ids":[ 8787 ] }, { "id":8787, "name":"New York City", "location":"New York, NY, United States", "parent_id":8304, "child_ids":[ ] } ] } ], "meta": { "total": 1 } } </code></pre></div> Returns the list of all job posts. The <code>id</code> field contains the unique identifier for the job post, while <code>internal_job_id</code> contains the unique identifier for the job itself. Any job custom fields you have selected to be exposed in the job board API will be shown in the <code>metadata</code> attribute. <aside class="warning"> When submitting a job application, you will use the <code>id</code> field to specify the application's target job post. </aside> Prospect posts include a null value for <code>internal_job_id</code> <h3 id='http-request'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/jobs</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> </tbody></table> <h3 id='optional-querystring-parameters'>Optional Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>content</td> <td>If set to <code>true</code>, include the full post description, department, and office of each job post.</td> </tr> </tbody></table> <h2 id='retrieve-a-job'>Retrieve a job</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id":44444, "title":"Product Engineer", "updated_at":"2013-07-02T19:39:23Z", "requisition_id": "50", "location":{ "name":"San Francisco, CA" }, "content":"This is the job description. &amp;lt;p&amp;gt;Any HTML included through the hosted job application editor will be automatically converted into corresponding HTML entities.&amp;lt;/p&amp;gt;", "absolute_url":"http://your.co/careers?gh_jid=444444", "internal_job_id":55555, "location_questions": [ { "label": "Location", "fields": [ { "name": "location", "type": "input_text", "values": [] } ], "required": true }, { "label": "Latitude", "fields": [ { "name": "latitude", "type": "input_hidden", "values": [] } ], "required": true }, { "label": "Longitude", "fields": [ { "name": "longitude", "type": "input_hidden", "values": [] } ], "required": true } ], "questions":[ { "required":true, "label":"First Name", "fields":[ { "name":"first_name", "type":"input_text" } ] }, { "required":true, "label":"Resume", "fields":[ { "name":"resume", "type":"input_file" }, { "name":"resume_text", "type":"textarea" } ] }, { "required":false, "label":"Do you like apples?", "fields":[ { "name":"question_2222", "type":"multi_value_single_select", "values":[ { "value":0, "label":"No" }, { "value":1, "label":"Yes" } ] } ] } ], "metadata":[ { "id":12345, "name":"Field Name", "value_type":"text", "value":"Some value" } ], "data_compliance": [ { "type": "gdpr", "requires_consent": true, // To be deprecated. Use if your organization doesn't have single-purpose consent configured, otherwise use separate values for processing and retention "requires_processing_consent": true, "requires_retention_consent": true, "retention_period": 12345 } ], "pay_input_ranges": [ { "min_cents":5000000, "max_cents":7500000, "currency_type":"USD", "title":"NYC Salary Range", "blurb":"In order to provide transparency..." } ] } </code></pre></div> <blockquote> When demographic questions are enabled: </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id": 44444, "title": "Product Engineer", ... "demographic_questions": { "header": "Diversity and Inclusion at Acme Corp.", "description": "Acme Corp. is dedicated to...", "questions": [ { "id": 1, "label": "Favorite Color", "required": false, "type":"multi_value_multi_select", "answer_options": [ { "id": 100, "label": "Red", "free_form": false }, { "id": 101, "label": "Green", "free_form": false }, { "id": 102, "label": "Blue", "free_form": false }, { "id": 102, "label": "Prefer to Type My Own", "free_form": true } ] } ] } } </code></pre></div> Returns a job post. Setting the questions querystring parameter to <code>"true"</code> will include the list of job application fields; these fields can be used to dynamically construct your own job application form. Any job custom fields you have selected to be exposed in the job board API will be shown in the <code>metadata</code> attribute. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/jobs/{job_id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> <tr> <td>job_id</td> <td>ID of the job to retrieve</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>*questions</td> <td>If set to <code>true</code>, include additional fields in the response: - <code>questions</code>: An array of custom questions defined for this job post - <code>location_questions</code>: An array of questions used to capture the applicant's location (included only if the job post has the location configured as "optional" or "required") - <code>compliance</code>: An array of questions used by government contractors to capture applicant information to comply with EEOC regulations (included only if the job post has EEOC questions enabled) - <code>demographic_questions</code>: An object containing demographic questions and related information (included only if your organization has Greenhouse Inclusion, and the job post has demographic questions enabled)</td> </tr> <tr> <td>*pay_transparency</td> <td>If set to <code>true</code>, include an array of <code>pay_input_ranges</code> with the pay range information defined for this job post.</td> </tr> </tbody></table> <h3 id='questions-location-questions-compliance'>Questions / Location Questions / Compliance</h3> Possible field types: <table><thead> <tr> <th>Type</th> <th>How to represent</th> </tr> </thead><tbody> <tr> <td>input_file</td> <td>Represent with an input of type file</td> </tr> <tr> <td>input_text</td> <td>Represent with an input of type text</td> </tr> <tr> <td>input_hidden</td> <td>Represent with an input of type hidden</td> </tr> <tr> <td>textarea</td> <td>Represent with a textarea</td> </tr> <tr> <td>multi_value_single_select</td> <td>Can be represented as either a set of radio buttons or a select</td> </tr> <tr> <td>multi_value_multi_select</td> <td>Can be represented as either a set of checkboxes or a multi-select</td> </tr> </tbody></table> Please note that it is possible for multiple fields to be aggregated beneath a single question. The "Resume" field is a prime example, with both an input_file and textarea type accepted. If marked as required, then we expect at least one of these fields to contain a valid value when your form is submitted to the <a href="#applications">application submission</a> endpoint. <h3 id='demographic-questions'>Demographic Questions</h3> <table><thead> <tr> <th>Type</th> <th>How to represent</th> </tr> </thead><tbody> <tr> <td>multi_value_single_select</td> <td>Can be represented as either a set of radio buttons or a select</td> </tr> <tr> <td>multi_value_multi_select</td> <td>Can be represented as either a set of checkboxes or a multi-select</td> </tr> </tbody></table> For organizations using Greenhouse Inclusion, the response may contain demographic questions. Each question contains an array of answer options that may be rendered based on the question 'type' defined in the table above. The candidate must select an answer option for questions with <code>required</code> set to <code>true</code>. If an answer option is selected that has <code>free_form</code> set to <code>true</code>, the candidate must be allowed to type a free-form response. This free-form response is only required if no other answer options have been selected by the candidate. <h3 id='data-compliance'>Data Compliance</h3> For organizations with GDPR rules configured and operating with a legal basis of explicit consent, the response may contain data_compliance objects. These objects will include whether a response is required and the data retention period in days as configured by the appropriate rule. <h3 id='board-level-introductions-and-conclusions'>Board-level Introductions and Conclusions</h3> For organizations with Default Descriptions authored on the Job Board, the <code>content</code> field will include the Board-level Introduction, Post-level Description, and Board-level Conclusion as a single concatenated string. <h1 id='offices'>Offices</h1><h2 id='list-offices'>List offices</h2> <blockquote> With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "offices":[ { "id":10201, "name":"West Coast", "departments":[ ], "child_ids":[ 11111 ] }, { "id":11111, "name":"San Francisco", "departments":[ { "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ], "parent_id":null, "child_ids":[ ] }, { "id":22222, "name":"Account Management", "jobs":[ ], "parent_id":null, "child_ids":[ ] } ], "parent_id":10201, "child_ids":[ ] } ] } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "offices":[ { "id":10201, "name":"West Coast", "departments":[ ], "children":[ { "id":11111, "name":"San Francisco", "departments":[ { "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ], "children":[ ] }, { "id":22222, "name":"Account Management", "jobs":[ ], "children":[ ] } ], "children":[ ] } ] } ] } </code></pre></div> Returns a list of all of your organization's departments and jobs, grouped by office. <h3 id='http-request'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/offices</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> </tbody></table> <h3 id='querystring-parameters'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>render_as</td> <td>No</td> <td>string</td> <td>This parameter defines how to represent the list of offices. The default value is 'list'.</td> </tr> </tbody></table> Allowed <code>render_as</code> values: <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>list</td> <td>(Default). The offices are returned as a list of objects and they include <code>parent_id</code> and <code>child_ids</code>.</td> </tr> <tr> <td>tree</td> <td>The offices are returned as a list of trees with <code>children</code>.</td> </tr> </tbody></table> <h2 id='retrieve-an-office'>Retrieve an office</h2> <blockquote> With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id":11111, "name":"San Francisco", "departments":[ { "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ] }, { "id":22222, "name":"Account Management", "jobs":[] } ], "parent_id":10201, "child_ids":[ ] } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id":11111, "name":"San Francisco", "departments":[ { "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ] }, { "id":22222, "name":"Account Management", "jobs":[] } ], "children":[ ] } </code></pre></div> Returns a list of your organization's departments and jobs for the given <code>office_id</code>. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/offices/{office_id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> <tr> <td>office_id</td> <td>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>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>render_as</td> <td>No</td> <td>string</td> <td>This parameter defines how to represent the list of offices. The default value is 'list'.</td> </tr> </tbody></table> Allowed <code>render_as</code> values: <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>list</td> <td>(Default).</td> </tr> <tr> <td>tree</td> <td>The children offices are returned as a tree.</td> </tr> </tbody></table> <h1 id='departments'>Departments</h1><h2 id='list-departments'>List departments</h2> <blockquote> With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "departments":[ { "id":77777, "name":"R & D", "jobs":[ ], "parent_id":null, "child_ids":[ 33333 ] }, { "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ], "parent_id":77777, "child_ids":[ ] }, { "id":22222, "name":"Account Management", "jobs":[ ], "parent_id":null, "child_ids":[ ] } ] } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "departments":[ { "id":77777, "name":"R & D", "jobs":[ ], "children":[ { "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ], "children":[ ] } ] }, { "id":22222, "name":"Account Management", "jobs":[ ], "children":[ ] } ] } </code></pre></div> Returns a list of your organization's departments and jobs. <h3 id='http-request'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/departments</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> </tbody></table> <h3 id='querystring-parameters'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>render_as</td> <td>No</td> <td>string</td> <td>This parameter defines how to represent the list of departments. The default value is 'list'.</td> </tr> </tbody></table> Allowed <code>render_as</code> values: <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>list</td> <td>(Default). The departments are returned as a list of objects and they include <code>parent_id</code> and <code>child_ids</code>.</td> </tr> <tr> <td>tree</td> <td>The departments are returned as a list of trees with <code>children</code>.</td> </tr> </tbody></table> <h2 id='retrieve-a-department'>Retrieve a department</h2> <blockquote> With <code>render_as=list</code> (default) </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ], "parent_id":null, "child_ids":[ 77777 ] } </code></pre></div> <blockquote> With <code>render_as=tree</code> </blockquote> <div class="highlight"><pre class="highlight json tab-json"><code>{ "id":33333, "name":"Engineering", "jobs":[ { "id":44444, "title":"Product Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Mobile Engineer - iOS", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ], "children":[ { "id":77777, "name":"Mobile Development", "jobs":[ ], "children":[ ] } ] } </code></pre></div> Returns a list of jobs for a given <code>department_id</code>. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/departments/{department_id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> <tr> <td>department_id</td> <td>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>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>render_as</td> <td>No</td> <td>string</td> <td>This parameter defines how to represent the list of departments. The default value is 'list'.</td> </tr> </tbody></table> Allowed <code>render_as</code> values: <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>list</td> <td>(Default).</td> </tr> <tr> <td>tree</td> <td>The children departments are returned as a tree.</td> </tr> </tbody></table> <h1 id='prospect-post-sections'>Prospect Post Sections</h1><h2 id='list-sections'>List sections</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "sections":[ { "id":14128, "name":"Don't see a job you like?", "jobs":[ { "id":44444, "title":"Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Product Manager", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ] }, { "id":85764, "name":"General Application", "jobs":[ { "id":888888, "title":"Prospect", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=888888" } ] } ] } </code></pre></div> Returns a list of your organization鈥檚 sections and prospect posts. Prospect posts can be listed under a specific department or section. To view all prospect posts, list jobs and filter results by null <code>internal_job_id</code> <h3 id='http-request'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/sections</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> </tbody></table> <h2 id='retrieve-a-section'>Retrieve a section</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "id":14128, "name":"Don't see a job you like?", "jobs":[ { "id":44444, "title":"Engineer", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=444444" }, { "id":55555, "title":"Product Manager", "location":{ "name":"San Francisco, CA" }, "updated_at":"2013-07-02T19:39:23Z", "absolute_url":"http://your.co/careers?gh_jid=55555" } ] } </code></pre></div> Returns a list of prospect posts for a given <code>section_id</code> <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/sections/{section_id}</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> <tr> <td>section_id</td> <td>ID of the section to retrieve</td> </tr> </tbody></table> <h1 id='educations'>Educations</h1> This is a list of endpoints which can be used to populate Education data for candidate applications. Instructions for posting applications that include Education information can be found under <a href="#submit-an-application">Applications</a>. <h2 id='list-degrees'>List Degrees</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "items": [ { "id": 5494452, "text": "High School" }, { "id": 5494478, "text": "Associate's Degree" }, { "id": 5494516, "text": "Bachelor's Degree" }, { "id": 5494551, "text": "Master's Degree" }, { "id": 5494580, "text": "Master of Business Administration (M.B.A.)" }, { "id": 5494607, "text": "Juris Doctor (J.D.)" }, { "id": 5494638, "text": "Doctor of Medicine (M.D.)" }, { "id": 5494662, "text": "Doctor of Philosophy (Ph.D.)" }, { "id": 5494689, "text": "Engineer's Degree" }, { "id": 5494710, "text": "Other" } ], "meta": { "total_count": 10, "per_page": 100 } } </code></pre></div> Returns a list of all of your organization's degrees. <h3 id='http-request'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/education/degrees</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> </tbody></table> <h3 id='querystring-parameters'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>term</td> <td>No</td> <td>string</td> <td>Returns any degrees containing this string in their name.</td> </tr> <tr> <td>page</td> <td>No</td> <td>string</td> <td>A cursor for use in pagination. Returns the n-th chunk of objects (100 per page).</td> </tr> </tbody></table> <h2 id='list-disciplines'>List Disciplines</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "items": [ { "id": 5494865, "text": "Accounting" }, { "id": 5494892, "text": "African Studies" }, { "id": 5494917, "text": "Agriculture" }, { "id": 5494940, "text": "Anthropology" }, { "id": 5494964, "text": "Applied Health Services" }, { "id": 5495009, "text": "Architecture" }, { "id": 5495033, "text": "Art" }, { "id": 5495051, "text": "Asian Studies" }, { "id": 5495074, "text": "Biology" }, { "id": 5495101, "text": "Business" } ], "meta": { "total_count": 71, "per_page": 100 } } </code></pre></div> Returns a list of all of your organization's disciplines. <h3 id='http-request-2'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/education/disciplines</code> <h3 id='url-parameters-2'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</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>term</td> <td>No</td> <td>string</td> <td>Returns any disciplines containing this string in their name.</td> </tr> <tr> <td>page</td> <td>No</td> <td>string</td> <td>A cursor for use in pagination. Returns the n-th chunk of objects (100 per page).</td> </tr> </tbody></table> <h2 id='list-schools'>List Schools</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "items": [ { "id": 5417077, "text": "Abraham Baldwin Agricultural College" }, { "id": 5417117, "text": "Academy of Art University" }, { "id": 5417156, "text": "Acadia University" }, { "id": 5417194, "text": "Adams State University" }, { "id": 5417217, "text": "Adelphi University" }, { "id": 5417245, "text": "Adrian College" }, { "id": 5417295, "text": "Adventist University of Health Sciences" }, { "id": 5417331, "text": "Agnes Scott College" }, { "id": 5417366, "text": "AIB College of Business" }, { "id": 5417384, "text": "Alaska Pacific University" } ], "meta": { "total_count": 2464, "per_page": 100 } } </code></pre></div> Returns a list of all of your organization's schools. <h3 id='http-request-3'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}/education/schools</code> <h3 id='url-parameters-3'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> </tbody></table> <h3 id='querystring-parameters-3'>Querystring Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Required</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>term</td> <td>No</td> <td>string</td> <td>Returns any schools containing this string in their name.</td> </tr> <tr> <td>page</td> <td>No</td> <td>string</td> <td>A cursor for use in pagination. Returns the n-th chunk of objects (100 per page).</td> </tr> </tbody></table> <h1 id='job-boards'>Job Boards</h1><h2 id='retrieve-job-board'>Retrieve job board</h2><div class="highlight"><pre class="highlight json tab-json"><code>{ "name": "Your Organization", "content": "..." } </code></pre></div> Returns your organization's name and job board content. <h3 id='http-request'>HTTP Request</h3> <code>GET https://boards-api.greenhouse.io/v1/boards/{board_token}</code> <h3 id='url-parameters'>URL Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token</td> </tr> </tbody></table> <h1 id='applications'>Applications</h1><h2 id='submit-an-application'>Submit an application</h2> <blockquote> This endpoint can take a multipart form-data POST. You should use this if you need to upload a resume or cover letter. </blockquote> <div class="highlight"><pre class="highlight html tab-html"><code> <form method="POST" action="!!REQUEST MUST BE PROXIED ON YOUR SERVERS!!" enctype='multipart/form-data'>  <input type="hidden" name="id" value="55555" />  <input type="hidden" name="mapped_url_token" value="token12345" /> <label>First Name <input type="text" name="first_name" /></label> <label>Last Name <input type="text" name="last_name" /></label> <label>Email <input type="text" name="email" /></label> <label>Phone <input type="text" name="phone" /></label> <label>Resume <input type="file" name="resume" /></label> <label>Cover Letter <input type="file" name="cover_letter" /></label> <label>LinkedIn Profile <input type="text" name="question_5555" /></label> <label>Some dropdown <select name="question_3333"> <option></option> <option value="1">Yes</option> <option value="0">No</option> </select> </label> <label>Multi select with checkboxes <label><input type="checkbox" name="question_2222[]" value="2" /> Red</label> <label><input type="checkbox" name="question_2222[]" value="5" /> Orange</label> </label> <label> <input type="checkbox" name="data_compliance[gdpr_consent_given]" value="1" />  <input type="checkbox" name="data_compliance[gdpr_processing_consent_given]" value="1" /> <input type="checkbox" name="data_compliance[gdpr_retention_consent_given]" value="1" /> {{ORGANIZATION}} has my consent to collect, store, and process my data for the purpose of considering me for employment. </label> <input type="submit" /> </form> </code></pre></div> <blockquote> cURL equivalent: </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>curl -X POST \ -H "Content-Type: multipart/form-data" \ -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" \ -F "first_name=Sammy" \ -F "last_name=McSamson" \ -F "email=sammy@example.com" \ -F "phone=3337778888" \ -F "location=110 5th Ave New York, NY, 10011" \ -F "latitude=40.7376671" \ -F "longitude=-73.9929196" \ -F "resume=@/path/to/resume/ADA084551.pdf" \ -F "cover_letter=@/path/to/coverletter/blah.pdf" \ -F "educations[][school_name_id]=5417077" \ -F "educations[][degree_id]=5494452"\ -F "educations[][discipline_id]=5494865" \ -F "educations[][start_date][month]=8" \ -F "educations[][start_date][year]=2012" \ -F "educations[][end_date][month]=5" \ -F "educations[][end_date][year]=2016" \ -F "employments[][company_name]=Business Co" \ -F "employments[][title]=Sales Manager" \ -F "employments[][start_date][month]=1" \ -F "employments[][start_date][year]=2016" \ -F "employments[][end_date][month]=2" \ -F "employments[][end_date][year]=2018" \ -F "employments[][current]=false" -F "mapped_url_token=token12345" \ -F "question_12349_url=http://dropbox.com/dl/attachment.pdf" \ -F "question_12349_url_filename=attachment.pdf" \ -F "question_12350_content=SGVsbG8sIHdvcmxkIQo=" \ -F "question_12350_content_filename=something_else.txt" \ -F "demographic_answers[][question_id]=87" \ -F "demographic_answers[][answer_options][][answer_option_id]=194" \ -F "demographic_answers[][question_id]=88" \ -F "demographic_answers[][answer_options][][answer_option_id]=212" \ -F "demographic_answers[][answer_options][][text]=Free-form Answer" \ -F "data_compliance[gdpr_consent_given]=true" \ # `gdpr_consent_given` to be deprecated. Use if your organization doesn't have single-purpose consent configured, otherwise use separate values for processing and retention -F "data_compliance[gdpr_processing_consent_given]=true" \ -F "data_compliance[gdpr_retention_consent_given]=true" \ "https://boards-api.greenhouse.io/v1/boards/very_awesome_inc/jobs/127817" </code></pre></div> <blockquote> or, you can POST a JSON encoded body (with <code>Content-Type: application/json</code>): </blockquote> <div class="highlight"><pre class="highlight plaintext"><code>curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Basic MGQwMzFkODIyN2VhZmE2MWRjMzc1YTZjMmUwNjdlMjQ6" \ -d '{ "first_name": "Sammy", "last_name": "McSamson", "email": "sammy@example.com", "phone": "3337778888", "location": "110 5th Ave New York, NY, 10011", "latitude": "40.7376671", "longitude": "-73.9929196", "resume_text": "I have many years of experience as an expert basket weaver...", "cover_letter_text": "I have a very particular set of skills, skills I have acquired over a very long career. Skills that make me...", "gender": 2, "race": 4, "veteran_status": 3, "disability_status": 3, "question_12345": "Here is some short text for the first question", "question_12346": 1, "question_12347": 5869311, "question_12348": [5869319,5869317], "question_12349_url": "http://dropbox.com/dl/attachment.pdf", "question_12349_url_filename": "attachment.pdf", "question_12350_content": "SGVsbG8sIHdvcmxkIQo=", "question_12350_content_filename": "something_else.txt", "educations": [ { "school_name_id" : "1403524", "degree_id": "1403534", "discipline_id": "1403605", "start_date": { "month": "1", "year": "1989"}, "end_date": { "month": "2", "year": "1990"} }, { "school_name_id" : "1401063", "degree_id": "1403525", "discipline_id": "1403608", "start_date": { "month": "1", "year": "2011"}, "end_date": { "month": "2", "year": "2012"} } ], "employments": [ { "company_name": "Business Co.", "title": "Sales Manager", "start_date": { "month": "1", "year": "2016" }, "end_date": { "month": "2", "year": "2018" }, "current": "false" } ], "mapped_url_token":"token12345", "demographic_answers":[ { "question_id": 87, "answer_options": [ { "answer_option_id": 194 } ] }, { "question_id": 88, "answer_options": [ { "answer_option_id": 212, "text": "Free-form Answer" } ] } ] }, "data_compliance": { "gdpr_consent_given": true, // To be deprecated. Use if your organization doesn't have single-purpose consent configured, otherwise use separate values for processing and retention "gdpr_processing_consent_given": true "gdpr_retention_consent_given": true }' \ "https://boards-api.greenhouse.io/v1/boards/very_awesome_inc/jobs/127817" </code></pre></div> Use this endpoint to submit a new application. This endpoint accepts a multipart form POST representing a job application. Application forms are job-specific and will be constructed via the "questions" array available via the <a href="#retrieve-a-job">Job method</a>. Please see the <a href="#retrieve-a-job">Job method</a> documentation for instructions on submitting location information through the API. Note that when submitting an application through this method, Greenhouse will not confirm the inclusion of required fields. Validation for required fields must be done on the client side, as Greenhouse will not reject applications that are missing required fields. <aside class="warning"> This method requires HTTP Basic Auth over SSL/TLS: the Basic Auth username is your API key (found on the API Credentials page). No password is required. </aside> <aside class="notice"> In general, we would encourage customers to make use of the Embedded Job Application before going to the trouble of building their own form. Our application form is well tested, validated, battle-hardened, and has built-in spam protection measures. Building your own form can introduce a number of challenges which are typically not worth the additional effort. </aside> <h3 id='http-request'>HTTP Request</h3> <code>POST https://boards-api.greenhouse.io/v1/boards/{board_token}/jobs/{id}</code> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>board_token</td> <td>Job Board URL token. If you're submitting an application for a job post on an internal job board, use <code>"internal"</code>.</td> </tr> <tr> <td>id</td> <td>Job post ID. Both internal and external job posts are allowed.</td> </tr> </tbody></table> <h3 id='request-headers'>Request Headers</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>Authorization</td> <td>This header should include a basic authorization with a Base64 encoded API key</td> </tr> <tr> <td>Content-Type</td> <td>Required if the request contains an attachment</td> </tr> </tbody></table> <h3 id='request-parameters'>Request Parameters</h3> <table><thead> <tr> <th>Parameter</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>*mapped_url_token</td> <td>If present, the <code>gh_src</code> URL parameter, which is used to indicate the referral source of this application.</td> </tr> <tr> <td>first_name</td> <td>Applicant's first name</td> </tr> <tr> <td>last_name</td> <td>Applicant's last name</td> </tr> <tr> <td>email</td> <td>Applicant's email address</td> </tr> <tr> <td>*phone</td> <td>Applicant's phone number</td> </tr> <tr> <td>*location</td> <td>Applicant's street address</td> </tr> <tr> <td>*latitude</td> <td>Applicant's home latitude. This is a hidden field and should not be exposed directly to the applicant.</td> </tr> <tr> <td>*longitude</td> <td>Applicant's home longitude. This is a hidden field and should not be exposed directly to the applicant.</td> </tr> <tr> <td>*resume</td> <td>Please see below for details.</td> </tr> <tr> <td>*cover_letter</td> <td>Please see below for details.</td> </tr> <tr> <td>*educations</td> <td>An array of education objects. Each education object should have five fields: <code>school_name_id</code>, <code>degree_id</code>, <code>discipline_id</code>, <code>start_date</code>, and <code>end_date</code>. You can get the <code>school_name_id</code>, <code>degree_id</code>, <code>discipline_id</code> from our <a href="#list-schools">List Schools</a>, <a href="#list-degrees">List Degrees</a>, and <a href="#list-disciplines">List Disciplines</a> endpoints. <code>start_date</code> and <code>end_date</code> will use a hash of month and year.</td> </tr> <tr> <td>*employments</td> <td>An array of employments objects. Each employment object should have: <code>company_name</code>, <code>title</code>, <code>start_date</code>, and <code>current</code> (must be <code>true</code> or <code>false</code>). If <code>current</code> is <code>false</code>, must have <code>end_date</code>. <code>start_date</code> and <code>end_date</code> will use a hash of month and year.</td> </tr> <tr> <td>*demographic_answers</td> <td>An array of demographic answer objects, applicable only if your organization has Greenhouse Inclusion and demographic questions are enabled on the job post. Each object must have a <code>question_id</code> field. The <code>answer_options</code> field is an array of objects, one for each <code>answer_option_id</code> the candidate selected. For answer options which support free-form responses, a <code>text</code> field may also be supplied with the candidate's hand-typed answer. Note that these questions are always optional, so the <code>answer_options</code> array may be empty, null, or omitted if the candidate did not make any selections.</td> </tr> <tr> <td>*data_compliance</td> <td>An object representing a candidate鈥檚 answers to required data compliance questions. This field is dependent on your organization鈥檚 <a href="https://support.greenhouse.io/hc/en-us/articles/360061849112-GDPR-features-overview">privacy and compliance configuration</a>. If your organization doesn't have single-purpose consent configured, use <code>{"gdpr_consent_given": true}</code>. Otherwise use separate consent values, like <code>{"gdpr_processing_consent_given":true}</code> or <code>{gdpr_retention_consent_given":false.}</code>.</td> </tr> </tbody></table> <h3 id='submitting-attachments'>Submitting Attachments</h3> We support 4 methods of uploading attachments when submitting a candidate application: <ol> <li>Submit the attachment via direct upload using multipart/form-data.</li> <li>Submit the attachment via direct upload using application/json. </li> <li>Submit a path to the attachment on an external server.</li> <li>Submit the plaintext file contents.</li> </ol> Resume Attachments <table><thead> <tr> <th>Method</th> <th>Content-Type</th> <th>Required Fields</th> <th>Example</th> </tr> </thead><tbody> <tr> <td>Direct upload</td> <td>multipart/form-data</td> <td>"resume"</td> <td>"resume": "@/Users/UserName/Documents/resume.pdf" (this example is specific to cURL)</td> </tr> <tr> <td>Direct upload</td> <td>application/json</td> <td>"resume_content", "resume_content_filename"</td> <td>"resume_content": "SGVsbG8sIHdvcmxkIQo=", "resume_content_filename": "resume.pdf"</td> </tr> <tr> <td>Path to file on external server</td> <td>multipart/form-data or application/json</td> <td>"resume_url", "resume_url_filename"</td> <td>"resume_url": "https://example.com/resume.pdf", "resume_url_filename": "resume.pdf"</td> </tr> <tr> <td>Plaintext file contents</td> <td>multipart/form-data or application/json</td> <td>"resume_text"</td> <td>"resume_text": "This is my awesome resume!"</td> </tr> </tbody></table> Cover Letter Attachments <table><thead> <tr> <th>Method</th> <th>Content-Type</th> <th>Required Fields</th> <th>Example</th> </tr> </thead><tbody> <tr> <td>Direct upload</td> <td>multipart/form-data</td> <td>"cover_letter"</td> <td>"cover_letter": "@/Users/UserName/Documents/coverletter.pdf" (this example is specific to cURL)</td> </tr> <tr> <td>Direct upload</td> <td>application/json</td> <td>"cover_letter_content", "cover_letter_content_filename"</td> <td>"cover_letter_content": "SGVsbG8sIHdvcmxkIQo=", "cover_letter_content_filename": "coverletter.pdf"</td> </tr> <tr> <td>Path to file on external server</td> <td>multipart/form-data or application/json</td> <td>"cover_letter_url", "cover_letter_url_filename"</td> <td>"cover_letter_url": "https://example.com/coverletter.pdf", "cover_letter_url_filename": "coverletter.pdf"</td> </tr> <tr> <td>Plaintext file contents</td> <td>multipart/form-data or application/json</td> <td>"cover_letter_text"</td> <td>"cover_letter_text": "This is my awesome cover letter!"</td> </tr> </tbody></table> Custom Question Attachments <table><thead> <tr> <th>Method</th> <th>Content-Type</th> <th>Required Fields</th> <th>Example</th> </tr> </thead><tbody> <tr> <td>Direct upload</td> <td>multipart/form-data</td> <td>"question_12345"</td> <td>"question_12345": "@/Users/UserName/Documents/attachment.pdf" (this example is specific to cURL)</td> </tr> <tr> <td>Direct upload</td> <td>application/json</td> <td>"question_12345_content", "question_12345_content_filename"</td> <td>"question_12345_content": "SGVsbG8sIHdvcmxkIQo=", "question_12345_content_filename": "attachment.pdf"</td> </tr> <tr> <td>Path to file on external server</td> <td>multipart/form-data or application/json</td> <td>"question_12345_url", "question_12345_url_filename"</td> <td>"question_12345_url": "https://example.com/attachment.pdf", "question_12345_url_filename": "attachment.pdf"</td> </tr> </tbody></table> <h3 id='collecting-applicant-location'>Collecting Applicant Location</h3> Here is the suggested workflow for populating <code>location</code>, <code>latitude</code> and <code>longitude</code>: <ol> <li>The applicant begins typing a location in your <code>location</code> text box.</li> <li>As the applicant types, your app makes a call to the <a href="https://developers.google.com/maps/documentation/javascript/places-autocomplete">Google Places Autocomplete API</a> to retrieve suggested location names (e.g. New York, NY, United States) and the <code>place_id</code> associated with each location (e.g. <code>ChIJOwg_06VPwokRYv534QaPC8g</code>).</li> <li>Your app displays the suggested location names to the applicant.</li> <li>The applicant selects a suggested location.</li> <li>Your app uses the <code>place_id</code> from the previous API call to retrieve the latitude and longitude for the selected location using the <a href="https://developers.google.com/maps/documentation/javascript/places#place_details">Google Place Details API</a>.</li> <li>Your app populates the hidden <code>latitude</code> and <code>longitude</code> fields with the result of this API call.</li> </ol> Note that all 3 fields must be included. If only <code>location</code> is sent and <code>latitude</code> and <code>longitude</code> are omitted, <code>location</code> will be ignored entirely. <h3 id='validations-on-post-requests'>Validations on POST Requests</h3> Job validations: <ul> <li>The job must be live and published</li> <li>The job board must be live and published</li> <li>The job post ID must exist on the job board with the supplied board_token</li> </ul> Field validations: <ul> <li><code>first_name</code>, <code>last_name</code>, and <code>email</code> fields are required </li> <li><code>first_name</code>, <code>last_name</code>, and <code>email</code> fields cannot be greater than 255 characters long</li> <li><code>first_name</code>, <code>last_name</code>, and <code>phone</code> fields must not contain a URL</li> <li><code>email</code> field must contain a valid email address</li> <li><code>educations</code> object must contain valid <code>school_name_id</code>, <code>degree_id</code>, <code>discipline_id</code>, <code>start_date</code>, and <code>end_date</code></li> <li><code>employments</code> object must contain <code>company_name</code>, <code>title</code>, <code>start_date</code> and <code>current</code> (must be <code>true</code> or <code>false</code>). If current=false, must contain <code>end_date</code></li> <li><code>start_date</code> must be before <code>end_date</code></li> <li>Field values must match the field type specified on the job post question</li> </ul> Attachments: <ul> <li>Must be a supported file type (pdf, doc, docx, txt, rtf)</li> <li>File size must be > 0 bytes</li> </ul> </div> <div class="dark-box"> <div class="lang-selector"> <a href="#" data-language-name="json">json</a> </div> </div> </div> </body> </html>