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>Greenhouse Onboarding 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_gho.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="gho" data-languages="["Examples"]"> <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="Examples">Examples</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="#graphql" class="toc-h2 toc-link" data-title="GraphQL">GraphQL</a> </li> <li> <a href="#general-concepts" class="toc-h2 toc-link" data-title="General Concepts">General Concepts</a> </li> <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="#a-basic-request" class="toc-h2 toc-link" data-title="A Basic Request">A Basic Request</a> </li> <li> <a href="#pagination" class="toc-h2 toc-link" data-title="Pagination">Pagination</a> </li> <li> <a href="#errors-and-validation" class="toc-h2 toc-link" data-title="Errors and Validation">Errors and Validation</a> </li> </ul> </li> <li> <a href="#queries" class="toc-h1 toc-link" data-title="Queries">Queries</a> <ul class="toc-list-h2"> <li> <a href="#complexityinfo-complexityinfo" class="toc-h2 toc-link" data-title="complexityInfo (ComplexityInfo)">complexityInfo (ComplexityInfo)</a> </li> <li> <a href="#contactrelationships-string" class="toc-h2 toc-link" data-title="contactRelationships ([String])">contactRelationships ([String])</a> </li> <li> <a href="#countries-country" class="toc-h2 toc-link" data-title="countries ([Country])">countries ([Country])</a> </li> <li> <a href="#customfield-customfield" class="toc-h2 toc-link" data-title="customField (CustomField)">customField (CustomField)</a> </li> <li> <a href="#customfields-customfieldconnection" class="toc-h2 toc-link" data-title="customFields (CustomFieldConnection)">customFields (CustomFieldConnection)</a> </li> <li> <a href="#department-department" class="toc-h2 toc-link" data-title="department (Department)">department (Department)</a> </li> <li> <a href="#departments-departmentconnection" class="toc-h2 toc-link" data-title="departments (DepartmentConnection)">departments (DepartmentConnection)</a> </li> <li> <a href="#employee-employee" class="toc-h2 toc-link" data-title="employee (Employee)">employee (Employee)</a> </li> <li> <a href="#employees-employeeconnection" class="toc-h2 toc-link" data-title="employees (EmployeeConnection)">employees (EmployeeConnection)</a> </li> <li> <a href="#employmentstatuses-string" class="toc-h2 toc-link" data-title="employmentStatuses ([String])">employmentStatuses ([String])</a> </li> <li> <a href="#location-location" class="toc-h2 toc-link" data-title="location (Location)">location (Location)</a> </li> <li> <a href="#locations-locationconnection" class="toc-h2 toc-link" data-title="locations (LocationConnection)">locations (LocationConnection)</a> </li> <li> <a href="#othercriteria-othercriterionconnection" class="toc-h2 toc-link" data-title="otherCriteria (OtherCriterionConnection)">otherCriteria (OtherCriterionConnection)</a> </li> <li> <a href="#othercriterion-othercriterion" class="toc-h2 toc-link" data-title="otherCriterion (OtherCriterion)">otherCriterion (OtherCriterion)</a> </li> <li> <a href="#ratelimit-ratelimit" class="toc-h2 toc-link" data-title="rateLimit (RateLimit)">rateLimit (RateLimit)</a> </li> <li> <a href="#team-team" class="toc-h2 toc-link" data-title="team (Team)">team (Team)</a> </li> <li> <a href="#teamcategories-teamcategoryconnection" class="toc-h2 toc-link" data-title="teamCategories (TeamCategoryConnection)">teamCategories (TeamCategoryConnection)</a> </li> <li> <a href="#teamcategory-teamcategory" class="toc-h2 toc-link" data-title="teamCategory (TeamCategory)">teamCategory (TeamCategory)</a> </li> <li> <a href="#teams-teamconnection" class="toc-h2 toc-link" data-title="teams (TeamConnection)">teams (TeamConnection)</a> </li> </ul> </li> <li> <a href="#mutations" class="toc-h1 toc-link" data-title="Mutations">Mutations</a> <ul class="toc-list-h2"> <li> <a href="#adddepartment-adddepartmentpayload" class="toc-h2 toc-link" data-title="addDepartment (AddDepartmentPayload)">addDepartment (AddDepartmentPayload)</a> </li> <li> <a href="#addlocation-addlocationpayload" class="toc-h2 toc-link" data-title="addLocation (AddLocationPayload)">addLocation (AddLocationPayload)</a> </li> <li> <a href="#addpendinghire-pendinghire" class="toc-h2 toc-link" data-title="addPendingHire (PendingHire)">addPendingHire (PendingHire)</a> </li> <li> <a href="#deletedepartment-deletedepartmentpayload" class="toc-h2 toc-link" data-title="deleteDepartment (DeleteDepartmentPayload)">deleteDepartment (DeleteDepartmentPayload)</a> </li> <li> <a href="#deletelocation-deletelocationpayload" class="toc-h2 toc-link" data-title="deleteLocation (DeleteLocationPayload)">deleteLocation (DeleteLocationPayload)</a> </li> <li> <a href="#updatedepartment-updatedepartmentpayload" class="toc-h2 toc-link" data-title="updateDepartment (UpdateDepartmentPayload)">updateDepartment (UpdateDepartmentPayload)</a> </li> <li> <a href="#updateemployeeprofile-employee" class="toc-h2 toc-link" data-title="updateEmployeeProfile (Employee)">updateEmployeeProfile (Employee)</a> </li> <li> <a href="#updatelocation-updatelocationpayload" class="toc-h2 toc-link" data-title="updateLocation (UpdateLocationPayload)">updateLocation (UpdateLocationPayload)</a> </li> </ul> </li> <li> <a href="#types" class="toc-h1 toc-link" data-title="Types">Types</a> <ul class="toc-list-h2"> <li> <a href="#adddepartmentpayload" class="toc-h2 toc-link" data-title="AddDepartmentPayload">AddDepartmentPayload</a> </li> <li> <a href="#addlocationpayload" class="toc-h2 toc-link" data-title="AddLocationPayload">AddLocationPayload</a> </li> <li> <a href="#complexityinfo" class="toc-h2 toc-link" data-title="ComplexityInfo">ComplexityInfo</a> </li> <li> <a href="#country" class="toc-h2 toc-link" data-title="Country">Country</a> </li> <li> <a href="#customfield" class="toc-h2 toc-link" data-title="CustomField">CustomField</a> </li> <li> <a href="#customfieldconnection" class="toc-h2 toc-link" data-title="CustomFieldConnection">CustomFieldConnection</a> </li> <li> <a href="#customfieldedge" class="toc-h2 toc-link" data-title="CustomFieldEdge">CustomFieldEdge</a> </li> <li> <a href="#customfieldgroup" class="toc-h2 toc-link" data-title="CustomFieldGroup">CustomFieldGroup</a> </li> <li> <a href="#customfieldvalue" class="toc-h2 toc-link" data-title="CustomFieldValue">CustomFieldValue</a> </li> <li> <a href="#deletedepartmentpayload" class="toc-h2 toc-link" data-title="DeleteDepartmentPayload">DeleteDepartmentPayload</a> </li> <li> <a href="#deletelocationpayload" class="toc-h2 toc-link" data-title="DeleteLocationPayload">DeleteLocationPayload</a> </li> <li> <a href="#department" class="toc-h2 toc-link" data-title="Department">Department</a> </li> <li> <a href="#departmentconnection" class="toc-h2 toc-link" data-title="DepartmentConnection">DepartmentConnection</a> </li> <li> <a href="#departmentedge" class="toc-h2 toc-link" data-title="DepartmentEdge">DepartmentEdge</a> </li> <li> <a href="#document" class="toc-h2 toc-link" data-title="Document">Document</a> </li> <li> <a href="#employee" class="toc-h2 toc-link" data-title="Employee">Employee</a> </li> <li> <a href="#employeeconnection" class="toc-h2 toc-link" data-title="EmployeeConnection">EmployeeConnection</a> </li> <li> <a href="#employeeedge" class="toc-h2 toc-link" data-title="EmployeeEdge">EmployeeEdge</a> </li> <li> <a href="#file" class="toc-h2 toc-link" data-title="File">File</a> </li> <li> <a href="#greenhouserecruitingdata" class="toc-h2 toc-link" data-title="GreenhouseRecruitingData">GreenhouseRecruitingData</a> </li> <li> <a href="#location" class="toc-h2 toc-link" data-title="Location">Location</a> </li> <li> <a href="#locationconnection" class="toc-h2 toc-link" data-title="LocationConnection">LocationConnection</a> </li> <li> <a href="#locationedge" class="toc-h2 toc-link" data-title="LocationEdge">LocationEdge</a> </li> <li> <a href="#mutation" class="toc-h2 toc-link" data-title="Mutation">Mutation</a> </li> <li> <a href="#othercriterion" class="toc-h2 toc-link" data-title="OtherCriterion">OtherCriterion</a> </li> <li> <a href="#othercriterionconnection" class="toc-h2 toc-link" data-title="OtherCriterionConnection">OtherCriterionConnection</a> </li> <li> <a href="#othercriterionedge" class="toc-h2 toc-link" data-title="OtherCriterionEdge">OtherCriterionEdge</a> </li> <li> <a href="#pageinfo" class="toc-h2 toc-link" data-title="PageInfo">PageInfo</a> </li> <li> <a href="#pendinghire" class="toc-h2 toc-link" data-title="PendingHire">PendingHire</a> </li> <li> <a href="#ratelimit" class="toc-h2 toc-link" data-title="RateLimit">RateLimit</a> </li> <li> <a href="#signaturerequest" class="toc-h2 toc-link" data-title="SignatureRequest">SignatureRequest</a> </li> <li> <a href="#signaturerequesttemplate" class="toc-h2 toc-link" data-title="SignatureRequestTemplate">SignatureRequestTemplate</a> </li> <li> <a href="#state" class="toc-h2 toc-link" data-title="State">State</a> </li> <li> <a href="#team" class="toc-h2 toc-link" data-title="Team">Team</a> </li> <li> <a href="#teamcategory" class="toc-h2 toc-link" data-title="TeamCategory">TeamCategory</a> </li> <li> <a href="#teamcategoryconnection" class="toc-h2 toc-link" data-title="TeamCategoryConnection">TeamCategoryConnection</a> </li> <li> <a href="#teamcategoryedge" class="toc-h2 toc-link" data-title="TeamCategoryEdge">TeamCategoryEdge</a> </li> <li> <a href="#teamconnection" class="toc-h2 toc-link" data-title="TeamConnection">TeamConnection</a> </li> <li> <a href="#teamedge" class="toc-h2 toc-link" data-title="TeamEdge">TeamEdge</a> </li> <li> <a href="#updatedepartmentpayload" class="toc-h2 toc-link" data-title="UpdateDepartmentPayload">UpdateDepartmentPayload</a> </li> <li> <a href="#updatelocationpayload" class="toc-h2 toc-link" data-title="UpdateLocationPayload">UpdateLocationPayload</a> </li> </ul> </li> <li> <a href="#input-objects" class="toc-h1 toc-link" data-title="Input Objects">Input Objects</a> <ul class="toc-list-h2"> <li> <a href="#adddepartmentinput" class="toc-h2 toc-link" data-title="AddDepartmentInput">AddDepartmentInput</a> </li> <li> <a href="#addlocationinput" class="toc-h2 toc-link" data-title="AddLocationInput">AddLocationInput</a> </li> <li> <a href="#addpendinghireinput" class="toc-h2 toc-link" data-title="AddPendingHireInput">AddPendingHireInput</a> </li> <li> <a href="#customfieldvaluesinput" class="toc-h2 toc-link" data-title="CustomFieldValuesInput">CustomFieldValuesInput</a> </li> <li> <a href="#datefilter" class="toc-h2 toc-link" data-title="DateFilter">DateFilter</a> </li> <li> <a href="#dateofbirthfilter" class="toc-h2 toc-link" data-title="DateOfBirthFilter">DateOfBirthFilter</a> </li> <li> <a href="#datetimefilter" class="toc-h2 toc-link" data-title="DateTimeFilter">DateTimeFilter</a> </li> <li> <a href="#deletedepartmentinput" class="toc-h2 toc-link" data-title="DeleteDepartmentInput">DeleteDepartmentInput</a> </li> <li> <a href="#deletelocationinput" class="toc-h2 toc-link" data-title="DeleteLocationInput">DeleteLocationInput</a> </li> <li> <a href="#departmentfilter" class="toc-h2 toc-link" data-title="DepartmentFilter">DepartmentFilter</a> </li> <li> <a href="#emailfilter" class="toc-h2 toc-link" data-title="EmailFilter">EmailFilter</a> </li> <li> <a href="#employmentstatusfilter" class="toc-h2 toc-link" data-title="EmploymentStatusFilter">EmploymentStatusFilter</a> </li> <li> <a href="#hrmanagerfilter" class="toc-h2 toc-link" data-title="HrManagerFilter">HrManagerFilter</a> </li> <li> <a href="#locationfilter" class="toc-h2 toc-link" data-title="LocationFilter">LocationFilter</a> </li> <li> <a href="#managerfilter" class="toc-h2 toc-link" data-title="ManagerFilter">ManagerFilter</a> </li> <li> <a href="#personalemailfilter" class="toc-h2 toc-link" data-title="PersonalEmailFilter">PersonalEmailFilter</a> </li> <li> <a href="#startdatefilter" class="toc-h2 toc-link" data-title="StartDateFilter">StartDateFilter</a> </li> <li> <a href="#titlefilter" class="toc-h2 toc-link" data-title="TitleFilter">TitleFilter</a> </li> <li> <a href="#updatecustomfieldvalue" class="toc-h2 toc-link" data-title="UpdateCustomFieldValue">UpdateCustomFieldValue</a> </li> <li> <a href="#updatedepartmentinput" class="toc-h2 toc-link" data-title="UpdateDepartmentInput">UpdateDepartmentInput</a> </li> <li> <a href="#updateemployee" class="toc-h2 toc-link" data-title="UpdateEmployee">UpdateEmployee</a> </li> <li> <a href="#updatelocationinput" class="toc-h2 toc-link" data-title="UpdateLocationInput">UpdateLocationInput</a> </li> <li> <a href="#workcountrycodefilter" class="toc-h2 toc-link" data-title="WorkCountryCodeFilter">WorkCountryCodeFilter</a> </li> </ul> </li> <li> <a href="#scalars" class="toc-h1 toc-link" data-title="Scalars">Scalars</a> <ul class="toc-list-h2"> <li> <a href="#boolean" class="toc-h2 toc-link" data-title="Boolean">Boolean</a> </li> <li> <a href="#date" class="toc-h2 toc-link" data-title="Date">Date</a> </li> <li> <a href="#datetime" class="toc-h2 toc-link" data-title="DateTime">DateTime</a> </li> <li> <a href="#float" class="toc-h2 toc-link" data-title="Float">Float</a> </li> <li> <a href="#id" class="toc-h2 toc-link" data-title="ID">ID</a> </li> <li> <a href="#int" class="toc-h2 toc-link" data-title="Int">Int</a> </li> <li> <a href="#json" class="toc-h2 toc-link" data-title="JSON">JSON</a> </li> <li> <a href="#string" class="toc-h2 toc-link" data-title="String">String</a> </li> <li> <a href="#url" class="toc-h2 toc-link" data-title="URL">URL</a> </li> <li> <a href="#value" class="toc-h2 toc-link" data-title="Value">Value</a> </li> </ul> </li> <li> <a href="#enums" class="toc-h1 toc-link" data-title="Enums">Enums</a> <ul class="toc-list-h2"> <li> <a href="#customfieldtype" class="toc-h2 toc-link" data-title="CustomFieldType">CustomFieldType</a> </li> <li> <a href="#signaturerequeststatus" class="toc-h2 toc-link" data-title="SignatureRequestStatus">SignatureRequestStatus</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/gho" 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="/job-board.html" title="Job Board API">Job Board 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> Our Greenhouse Onboarding API allows you to query and modify your employee, and query company information. If you are not using our Onboarding product and would like to know more, <a href="https://greenhouse.io/onboarding">please visit our site.</a> 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='graphql'>GraphQL</h2> Greenhouse Onboarding only supports <a href="http://graphql.org/">GraphQL</a>; we do not have a traditional REST API. We made the decision to use GraphQL because it allows you to: <ul> <li>Increase throughput by requesting only the data you are interested in.</li> <li>Use introspection to know precisely what our schema looks like. Tools like <a href="https://github.com/skevy/graphiql-app">GraphiQL</a> will allow you to quickly and easily explore our entire API. It even supports autocomplete!</li> <li>Program against an industry-wide standard supported by a variety of tools and organizations.</li> </ul> <h2 id='general-concepts'>General Concepts</h2> <table><thead> <tr> <th>Term</th> <th>Meaning</th> </tr> </thead><tbody> <tr> <td>Query</td> <td>Similar to GET requests, queries return data (the return type is in parentheses). They can take arguments (listed in a table under the Query name).</td> </tr> <tr> <td>Mutations</td> <td>Mutate data (similar to POST, PUT, PATCH, DELETE). They also return data (type in parentheses). They can also take arguments (listed in table under the Mutation name).</td> </tr> <tr> <td>Type</td> <td>Each type describes an object in GHO (e.g. Employee or Department). Each type has its own set of fields which contain the information (e.g. Employee has a first name, Department contains a name).</td> </tr> <tr> <td>Input Objects</td> <td>Queries and Mutations take input objects as arguments. These arguments have names and values. The value will either be a scalar or a more complex structured input.</td> </tr> <tr> <td>Scalars</td> <td>The most basic data type. All types (e.g. Employee) have fields that contain scalars or other types that eventually boil down to scalars.</td> </tr> <tr> <td>Enums</td> <td>ENUMs are hard-coded values. They are strings that must be a certain value. E.g. a Signature Request's "status" can only be one of [BEING_PROCESSED CANCELED COMPLETED ERROR WAITING_FOR_COUNTER_SIGNATURE WAITING_FOR_SIGNATURE].</td> </tr> </tbody></table> <h2 id='authentication'>Authentication</h2><div class="highlight"><pre class="highlight shell tab-shell"><code>$ curl https://onboarding-api.greenhouse.io/graphql \ -X POST \ -u your_access_key:your_secret_key \ -d '{"query":"{\n rateLimit {\n limit\n }\n}"}' \ -H "Content-Type: application/json" ... > GET /graphql HTTP/1.1 > Host: onboarding-api.greenhouse.io > Authorization: Basic eW91cl9hY2Nlc3Nfa2V5OnlvdXJfdmFsdWU= </code></pre></div> The Greenhouse Onboarding API is secured with HTTP Basic Authentication over HTTPS. Clients are required to supply both a username and password. Credentials can be generated inside of the Greenhouse Onboarding product on the <a href="https://onboarding.greenhouse.io/settings/api_management">Settings > API Management screen</a>. Only Super Admins can generate or revoke API keys. Use the <code>Access Key</code> field as the username and the <code>Secret Key</code> field as the password. <img src="images/gho/api-management.png" alt="API Management"> Using the Greenhouse Onboarding API provides access to all of your company's information. There is no way to limit the scope of an API key. Only share your API key with people that you trust. API keys can be revoked at any time on the API Management screen. <h2 id='rate-limiting'>Rate Limiting</h2><div class="highlight"><pre class="highlight plaintext"><code># When the rate limit is reached, ensuing requests will result # in the following response (until the next time period begins): { "errors": [ { "message": "Rate limit reached.", "limit": 100, "remaining": 0, "resetAt": "2018-01-01T01:00:00Z" } ] } </code></pre></div> The Greenhouse Onboarding API imposes limits on the amount of data a single client can request over time, as well as the complexity of individual requests. This is done to ensure our servers can always service requests as quickly as possible. <h3 id='request-limits'>Request Limits</h3><div class="highlight"><pre class="highlight plaintext"><code># To request the current rate limit information: { rateLimit { resetAt limit remaining } } # rateLimit response: { "data": { "rateLimit": { "resetAt": "2018-09-12T18:00:00Z", "limit": 100, "remaining": 99 } } } </code></pre></div> In order to ensure API stability, we limit the number of requests that can made within a given time window. Consumers can access this rate limit information by querying the <code>rateLimit</code> type (see example to the right). The number of remaining requests is indicated by the value in the <code>remaining</code> field. When this request limit has been reached, every ensuing request will fail until the next time window begins (indicated by the <code>resetAt</code> field). Then, once the next time window starts, the number of requests will be replenished (to the number indicated by the <code>limit</code> property). <h3 id='maximum-complexity'>Maximum Complexity</h3><div class="highlight"><pre class="highlight plaintext"><code># Say we had the following query: { employee(id: 25) { email } } # To request the complexity score of this query, simply # include complexityInfo as such: { employee(id: 25) { email } complexityInfo { score maximum } } # The response: { "data": { "employee": { "email": "email_address@example.com" }, "complexityInfo": { "score": 1, "maximum": 2500 } } } </code></pre></div> In addition to limiting the number of requests used in a given time period, we limit the "complexity" of any given request. If this score exceeds our maximum, the request will be rejected and an error response will be returned. We reserve the right to adjust the complexity score of any given field at any time. However, for the time being, a query's complexity score can be estimated like so: <ul> <li>For non-connections (e.g. an employee or a department query): simply add up each field being requested.</li> <li>For connections (e.g an employees or departments query): add up all requested fields and multiply by the number of requested records (e.g. the <code>first</code> or <code>last</code> argument)</li> </ul> Clients can also determine a query's complexity score by requesting the <code>complexityInfo</code> object (see example to the right). <h2 id='a-basic-request'>A Basic Request</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># If we wanted to retrieve the email address of the employee # with ID 25, the GraphQL query would look like this: { employee(id: 25) { email } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># We then pack this query into a JSON object as a string { "query": "{\n employee(id: 25) {\n email\n }\n}" } </code></pre></div><div class="highlight"><pre class="highlight shell tab-shell"><code># Here's what the final cURL request would look like curl 'https://onboarding-api.greenhouse.io/graphql' \ -X POST \ -u your_access_key:your_secret_key \ -d '{"query":"{\n employee(id: 25) {\n email\n }\n}"}' \ -H 'content-type: application/json' # and here's what the response would look like {"data":{"employee":{"email":"employee_25_email@example.com"}}} </code></pre></div> GraphQL requests are simply POSTs made to our API endpoint. In its most simple form, the request payload consists of a JSON object with a single key: "query". The corresponding value for the "query" key is the GraphQL query itself, and it is expressed as a string. <h2 id='pagination'>Pagination</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ employees(first: 2, after: "NQ==") { # Please fetch the next 2 records, starting after the "NQ==" cursor pageInfo { endCursor hasNextPage } edges { node { email } } } } # Returns: { "data": { "employees": { "pageInfo": { "endCursor": "MTA=", "hasNextPage": true }, "edges": [ { "node": { "email": "kima@example.com" } }, { "node": { "email": "omar@example.com" } } ] } } } </code></pre></div> For performance reasons, some result sets will be limited in size. For example, when requesting employee profile information we limit the number of employees returned in a single query. The API will return a "page" of records along with an object that describes how to get the next page. We are using the pagination system recommended by the <a href="http://graphql.org/learn/pagination/">GraphQL documentation</a>. Paginated connections return the following pieces of information: <ul> <li><code>edges</code>: You'll find your records in here.</li> <li><code>pageInfo</code>: This has information about the current page.</li> </ul> To fetch the next page of information, pass the <code>endCursor</code> value into the <code>after</code> filter on the connection. To the right you can see an example on how to fetch employees via the <a href="#employees-employeeconnection">employees</a> connection. When requesting a paginated resource, you will always need to provide a value for either the <code>first</code> or <code>last</code> arguments. You'll use these arguments to specify the number of records that should be included on a page. If you provide a value larger than our maximum of 25, you will receive the maximum of 25 records. As a general rule, we attempt to avoid nested sets of pagination. For example, the list of CustomFieldValue records for each employee will be a simple array instead of another paginated connection. <h2 id='errors-and-validation'>Errors and Validation</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ employee(id: 100000000) { email } } </code></pre></div><div class="highlight"><pre class="highlight json tab-json"><code>{ "data": { "employee": null }, "errors": [ { "message": "Unable to find Employee with id 100000000", "locations": [ { "line": 2, "column": 3 } ], "path": [ "employee" ], "errorCode": "NotFound" } ] } </code></pre></div> Unlike REST APIs, GraphQL will return an HTTP status of 200, even in cases where there are errors. You can see an example of an error message to the right. The <code>data</code> and <code>errors</code> properties are siblings. It's possible for a request to generate a response that has both <code>data</code> and <code>errors</code>. However, if there is ever an <code>errors</code> key in the response, the request failed (despite the return code of 200). The <code>message</code> will let you know what's wrong. The <code>locations</code> property has the line number and column where the error starts. In this example, it's the 2nd line, 3rd column, which is the start of the word <code>employee</code>. The <code>fields</code> property is a breadcrumb trail of how to get to the problem. Here, the problem can be found on the top-most <code>employee</code> selection. When we can, we'll also provide an <code>errorCode</code> key for every entry in the <code>errors</code> list. Here's a table of current errorCodes: <table><thead> <tr> <th>Error Scenario</th> <th>Error Code</th> </tr> </thead><tbody> <tr> <td>Authentication Failure</td> <td>Authentication</td> </tr> <tr> <td>Validation Failure</td> <td>Validation</td> </tr> <tr> <td>Resource Not Found</td> <td>NotFound</td> </tr> <tr> <td>Server Error</td> <td>Server</td> </tr> <tr> <td>Rate Limit Exceeded</td> <td>RateLimit</td> </tr> </tbody></table> There are undefined error scenarios in which we're unable to provide a code. In these cases, refer to the contents of the error list. <h1 id='queries'>Queries</h1><h2 id='complexityinfo-complexityinfo'>complexityInfo (<a href="#complexityinfo">ComplexityInfo</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># the basic structure of the complexityInfo query { complexityInfo { score maximum } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Example of retriving complexity information from the employee query { employee(id: 20) { email lastName } complexityInfo { score maximum } } </code></pre></div> The complexity information for the current query. By itself it doesn't tell us anything. This really comes in handy when paired with other queries. <h2 id='contactrelationships-string'>contactRelationships (<a href="#string">[String]</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ contactRelationships } </code></pre></div> The list of valid options for the 'Contact' custom field type <h2 id='countries-country'>countries (<a href="#country">[Country]</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request all country information for North America { countries(countryCodes: ["USA", "CAN", "MEX"]) { countryCode name states { name stateCode country { name } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request all country information for all countries { countries { countryCode name states { name stateCode country { name } } } } </code></pre></div> The list of countries <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>countryCodes</td> <td><a href="#string">[String]</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='customfield-customfield'>customField (<a href="#customfield">CustomField</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request custom field information for a custom field { customField(id: "system.pronouns") { id name fieldType multipleChoiceOptions customFieldGroup { id name } teamCategory { id name } createdAt updatedAt } } </code></pre></div> Information about a custom field. The argument must be the permanent field id of the custom field. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='customfields-customfieldconnection'>customFields (<a href="#customfieldconnection">CustomFieldConnection</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request the first 5 custom fields after the cursor "NQ==" { customFields(first: 5, after: "NQ==") { edges { node { name id teamCategory { id name } fieldType customFieldGroup { id name } multipleChoiceOptions } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request the first 5 custom fields before the cursor "MTA=" { customFields(first: 5, before: "MTA=") { edges { node { name id teamCategory { id name } fieldType customFieldGroup { id name } multipleChoiceOptions } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request the first 10 custom fields with the field type 'text' { customFields(first: 10, fieldTypes: [TEXT]) { edges { node { name id teamCategory { id name } fieldType customFieldGroup { id name } multipleChoiceOptions } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request the first 10 customFields in the list { customFields(first: 10) { edges { node { name id teamCategory { id name } fieldType customFieldGroup { id name } multipleChoiceOptions } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request the last 10 customFields in the list { customFields(last: 10) { edges { node { name id teamCategory { id name } fieldType customFieldGroup { id name } multipleChoiceOptions } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request custom fields with permanent field ids "department" and "location" { customFields(first: 2, ids: ["department", "location"]) { edges { node { name id teamCategory { id name } fieldType customFieldGroup { id name } multipleChoiceOptions } cursor } } } </code></pre></div> A collection of custom fields <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come after the specified cursor.</td> <td></td> </tr> <tr> <td>before</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come before the specified cursor.</td> <td></td> </tr> <tr> <td>fieldTypes</td> <td><a href="#customfieldtype">[CustomFieldType]</a></td> <td></td> <td></td> </tr> <tr> <td>first</td> <td><a href="#int">Int</a></td> <td>Returns the first n elements from the list.</td> <td></td> </tr> <tr> <td>ids</td> <td><a href="#id">[ID]</a></td> <td></td> <td></td> </tr> <tr> <td>last</td> <td><a href="#int">Int</a></td> <td>Returns the last n elements from the list.</td> <td></td> </tr> </tbody></table> <h2 id='department-department'>department (<a href="#department">Department</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ department(id: 1) { id name externalId } } </code></pre></div> A single department <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#int">Int</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='departments-departmentconnection'>departments (<a href="#departmentconnection">DepartmentConnection</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for the first 5 departments after cursor "NQ==" { departments(first: 5, after: "NQ==") { edges { node { id name externalId } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for the first 5 departments before cursor "NQ==" { departments(first: 5, before: "NQ==") { edges { node { id name externalId } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 departments in the list { departments(first: 10) { edges { node { id name externalId } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for the last 10 departments in the list { departments(last: 10) { edges { node { id name externalId } cursor } } } </code></pre></div> All departments <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come after the specified cursor.</td> <td></td> </tr> <tr> <td>before</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come before the specified cursor.</td> <td></td> </tr> <tr> <td>first</td> <td><a href="#int">Int</a></td> <td>Returns the first n elements from the list.</td> <td></td> </tr> <tr> <td>last</td> <td><a href="#int">Int</a></td> <td>Returns the last n elements from the list.</td> <td></td> </tr> </tbody></table> <h2 id='employee-employee'>employee (<a href="#employee">Employee</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for an employee { employee(id: 5) { about createdAt dateOfBirth dateOfTermination department { id name externalId } documents { id file { fileUrl fileName fileSize } } email employmentStatus firstName greenhouseRecruitingData { applicationId } hrManager { id email } id lastName location { id name address externalId } manager { id email } middleName otherCriteria { id name } personalEmail phoneNumber preferredFirstName preferredLastName profileImage { fileUrl fileName fileSize } requiredFieldsCompletedAt startDate suffix title updatedAt workCountryCode } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request an employee but limit their customFieldValues to those of specific customFields. # The customFieldIds argument can be used when you are interested in only getting a specific # customFieldValues for the employee. { employee(id: 20) { customFieldValues(customFieldIds: ["emergency_contact", "favorite_food"]) { customField { id fieldType } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request an employee and limit their signatureRequests to those that are waiting on a signature or being processed { employee(id: 20) { signatureRequests(statuses: [WAITING_FOR_SIGNATURE, BEING_PROCESSED]) { counterSigner { id email } file { fileUrl } status signatureRequestTemplate { publicName counterSigner { id email } } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request an employee, limit their signatureRequests to those that are completed an request the formFields { employee(id: 20) { signatureRequests(statuses: [COMPLETED]) { formFields(fieldNames: ["first_name", "last_name"]) } } } </code></pre></div> An Onboarding employee record <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#int">Int</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='employees-employeeconnection'>employees (<a href="#employeeconnection">EmployeeConnection</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request employees after the cursor "NQ==" { employees(first: 25, after: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id email } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request employees before the cursor "MTM=" { employees(first: 25, before: "MTM=") { pageInfo { hasNextPage endCursor } edges { nodes { id email } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that were createed before 12-13-2021 and after 10-01-2021. For each employee that # fits that criteria, return their id and work email { employees(first: 25, createdAt: {after: "2021-10-01T00:00:00+00:00", before: "2021-12-31T00:00:00+00:00" }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a value (ANY value) set for the "favorite_food" Custom Field. For these employees, return # ALL of their customFieldValues. { employees(first: 25, customFieldValues: [{id: "favorite_food"}]) { pageInfo { hasNextPage endCursor } edges { node { id } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have "Hot Dogs" or "Chicken Nuggets" set for their "favorite_food" Custom Field. # Because the "favorite_food" Custom Field is of type text, we provide the "textValues" argument (as opposed to # dateValues or idValues) { employees( first: 25, customFieldValues: [{id: "favorite_food", textValues: ["Hot Dogs", "Chicken Nuggets"]}] ) { pageInfo { hasNextPage endCursor } edges { node { customFieldValues { customField { id } value } } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a value set for their "favorite_food" Custom Field and "Blue" for their # "favorite_color" Custom Field. For each of these employees, return their ID and work email address. { employees( first: 25, customFieldValues: [{id: "favorite_food"}, {id: "favorite_color", textValues: ["Blue"]}] ) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request employees that have a value set for the "favorite_food" Custom Field. Return each employee's ID and # customFieldValues, but only return the customFieldValue for the "favorite_food" customField. { employees( first: 25, customFieldValues: [{ id: "favorite_food" }] ) { pageInfo { hasNextPage endCursor } edges { node { id customFieldValues(customFieldIds: ["favorite_food"]) { customField { id } value } } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request employees that have a date value between "2017-04-13" and "2018-04-13" (exclusive) for the # "1_year_anniversary" Custom Field. For each of these employees, return their ID and # the value for the "1_year_anniversary" Custom Field (and only the value for this Custom Field). { employees( first: 25, customFieldValues: [{ id: "1_year_anniversary", dateValue: { after: "2017-04-13", before: "2018-04-13" } }] ) { pageInfo { hasNextPage endCursor } edges { node { id customFieldValues(customFieldIds: ["1_year_anniversary"]) { customField { id } value } } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request employees that have Employee 35 or Employee 40 set as the value for the "mentor" Custom Field. For each of # these employees, return their id, work email address, and "about me" text. { employees( first: 25, customFieldValues: [{id: "mentor", idValues: [35, 40]}] ) { pageInfo { hasNextPage endCursor } edges { node { id email about } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a dateOfBirth between 1989-12-31 and 2000-01-01. # These dates are exclusive (e.g. someone who was born on 1989-12-31 or 2000-01-01 would not be included. { employees(first: 25, dateOfBirthFilter: { dateFilter: { after: "1989-12-31", before: "2000-01-01" } }) { pageInfo { hasNextPage endCursor } edges { node { id email startDate } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a department set (department is not null). For each employee that fits the criteria, # return their id and work email { employees(first: 25, departmentFilter: { anyValue: true }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that lack a department (department is null). For each employee that fits the criteria, # return their id and work email { employees(first: 25, departmentFilter: { noValue: true }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that are in specific departments. For each employee that fits the criteria, # return their id and work email { employees(first: 25, departmentFilter: { departmentIds: [1, 3] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have specific emails. For each employee that fits the criteria, # return their id and work email { employees(first: 25, emailFilter: { emails: ["john.doe@example.com"] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have specific employment statuses. For each employee that fits the criteria, # return their id and work email { employees(first: 25, employmentStatusFilter: { employmentStatuses: ["Full-time", "Part-time"] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request the first 10 employees in the list, For each employee return their id and work email { employees(first: 10) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a specific hr manager or managers. For each employee that fits the criteria, # return their id and work email { employees(first: 25, hrManagerFilter: { hrManagerIds: [1, 2] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request the last 10 employees in the list, For each employee return their id and work email { employees(last: 10) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that are in a specific location or locations. For each employee that fits the criteria, # return their id and work email { employees(first: 25, locationFilter: { locationIds: [1, 2] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a specific manager or managers. For each employee that fits the criteria, # return their id and work email { employees(first: 25, managerFilter: { managerIds: [1, 2] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a specific personal email or emails. For each employee that fits the criteria, # return their id and work email { employees(first: 25, personalEmailFilter: { personalEmails: ["john.doe@example.com", "jon.doe2@example.com"] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have a startDate between 2017-03-25 and 2018-03-25. # These dates are exclusive (e.g. someone who started on 2017-03-25 or 2018-03-25 would not be included. { employees(first: 25, startDateFilter: { dateFilter: { after: "2017-03-25", before: "2018-03-25" } }) { pageInfo { hasNextPage endCursor } edges { node { id email startDate } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that have title "Account Manager". For each employee that fits the criteria, # return their id and work email { employees(first: 25, titleFilter: { titles: ["Account Manager"] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees in a specific country or countries (using workCountryCode). For each employee that fits the criteria, # return their id and work email { employees(first: 25, workCountryCodeFilter: { workCountryCodes: ["USA", "CAN"] }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request only those employees that were updated before 12-13-2021 and after 10-01-2021. For each employee that # fits that criteria, return their id and work email { employees(first: 25, updatedAt: {after: "2021-10-01T00:00:00+00:00", before: "2021-12-31T00:00:00+00:00" }) { pageInfo { hasNextPage endCursor } edges { node { id email } } } } </code></pre></div> A collection of Onboarding employee records. The following arguments are deprecated and should be avoided as support for them will be dropped: dateOfBirth, departmentIds, emails, employmentStatuses, hrManagerIds, locationIds, managerIds, personalEmails, startDate, titles, and workCountryCodes. Each of these arguments has a newer, more powerful companion named *Filter. For example, departmentIds has been replaced by the argument departmentFilter - which allows for the specification of department IDs, but also allows for more flexibility (e.g. filtering by lack/presence of a given field - as opposed to filtering by specific values). <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come after the specified cursor.</td> <td></td> </tr> <tr> <td>before</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come before the specified cursor.</td> <td></td> </tr> <tr> <td>createdAt</td> <td><a href="#datetimefilter">DateTimeFilter</a></td> <td>filter employees based on when they were created</td> <td></td> </tr> <tr> <td>customFieldValues</td> <td><a href="#customfieldvaluesinput">[CustomFieldValuesInput]</a></td> <td>filter employees by their custom field values</td> <td></td> </tr> <tr> <td>dateOfBirthFilter</td> <td><a href="#dateofbirthfilter">DateOfBirthFilter</a></td> <td>filter employees by their date of birth</td> <td></td> </tr> <tr> <td>departmentFilter</td> <td><a href="#departmentfilter">DepartmentFilter</a></td> <td>filter employees by their department</td> <td></td> </tr> <tr> <td>emailFilter</td> <td><a href="#emailfilter">EmailFilter</a></td> <td>filter employees by their email</td> <td></td> </tr> <tr> <td>employmentStatusFilter</td> <td><a href="#employmentstatusfilter">EmploymentStatusFilter</a></td> <td>filter employees by their employment status</td> <td></td> </tr> <tr> <td>first</td> <td><a href="#int">Int</a></td> <td>Returns the first n elements from the list.</td> <td></td> </tr> <tr> <td>hrManagerFilter</td> <td><a href="#hrmanagerfilter">HrManagerFilter</a></td> <td>filter employees by their hr manager</td> <td></td> </tr> <tr> <td>last</td> <td><a href="#int">Int</a></td> <td>Returns the last n elements from the list.</td> <td></td> </tr> <tr> <td>locationFilter</td> <td><a href="#locationfilter">LocationFilter</a></td> <td>filter employees by their location</td> <td></td> </tr> <tr> <td>managerFilter</td> <td><a href="#managerfilter">ManagerFilter</a></td> <td>filter employees by their manager</td> <td></td> </tr> <tr> <td>personalEmailFilter</td> <td><a href="#personalemailfilter">PersonalEmailFilter</a></td> <td>filter employees by their personal email</td> <td></td> </tr> <tr> <td>startDateFilter</td> <td><a href="#startdatefilter">StartDateFilter</a></td> <td>filter employees by their start date</td> <td></td> </tr> <tr> <td>titleFilter</td> <td><a href="#titlefilter">TitleFilter</a></td> <td>filter employees by their title</td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetimefilter">DateTimeFilter</a></td> <td>filter employees based on when they were last updated</td> <td></td> </tr> <tr> <td>workCountryCodeFilter</td> <td><a href="#workcountrycodefilter">WorkCountryCodeFilter</a></td> <td>filter employees by their work country code</td> <td></td> </tr> </tbody></table> <h2 id='employmentstatuses-string'>employmentStatuses (<a href="#string">[String]</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ employmentStatuses } </code></pre></div> The list of valid options for Employment Status <h2 id='location-location'>location (<a href="#location">Location</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ location(id: 1) { id name address externalId } } </code></pre></div> A single location <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#int">Int</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='locations-locationconnection'>locations (<a href="#locationconnection">LocationConnection</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 locations after cursor "NQ==" { locations(first: 10, after: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name address externalId } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 locations before cursor "NQ==" { locations(first: 10, before: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name address externalId } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 locations in the list { locations(first: 10) { pageInfo { hasNextPage endCursor } edges { node { id name address externalId } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for last 10 locations in the list { locations(last: 10) { pageInfo { hasNextPage endCursor } edges { node { id name address externalId } cursor } } } </code></pre></div> All locations <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come after the specified cursor.</td> <td></td> </tr> <tr> <td>before</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come before the specified cursor.</td> <td></td> </tr> <tr> <td>first</td> <td><a href="#int">Int</a></td> <td>Returns the first n elements from the list.</td> <td></td> </tr> <tr> <td>last</td> <td><a href="#int">Int</a></td> <td>Returns the last n elements from the list.</td> <td></td> </tr> </tbody></table> <h2 id='othercriteria-othercriterionconnection'>otherCriteria (<a href="#othercriterionconnection">OtherCriterionConnection</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 other criteria after cursor "NQ==" { otherCriteria(first: 10, after: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name createdAt updatedAt } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 other criteria before cursor "NQ==" { otherCriteria(first: 10, before: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name createdAt updatedAt } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 other criteria in the list { otherCriteria(first: 10) { pageInfo { hasNextPage endCursor } edges { node { id name createdAt updatedAt } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for last 10 other criteria in the list { otherCriteria(last: 10) { pageInfo { hasNextPage endCursor } edges { node { id name createdAt updatedAt } cursor } } } </code></pre></div> All other criteria <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come after the specified cursor.</td> <td></td> </tr> <tr> <td>before</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come before the specified cursor.</td> <td></td> </tr> <tr> <td>first</td> <td><a href="#int">Int</a></td> <td>Returns the first n elements from the list.</td> <td></td> </tr> <tr> <td>last</td> <td><a href="#int">Int</a></td> <td>Returns the last n elements from the list.</td> <td></td> </tr> </tbody></table> <h2 id='othercriterion-othercriterion'>otherCriterion (<a href="#othercriterion">OtherCriterion</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ otherCriterion(id: 1) { id name createdAt updatedAt } } </code></pre></div> A single other criterion <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#int">Int</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='ratelimit-ratelimit'>rateLimit (<a href="#ratelimit">RateLimit</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ rateLimit { cost limit remaining resetAt } } </code></pre></div> Information about your current API quota <h2 id='team-team'>team (<a href="#team">Team</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ team(id: 1) { id name description email location name teamCategory { id name } } } </code></pre></div> A single team <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#int">Int</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='teamcategories-teamcategoryconnection'>teamCategories (<a href="#teamcategoryconnection">TeamCategoryConnection</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 5 team categories after cursor "NQ==" { teamCategories(first: 5, after: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 5 team categories before cursor "NQ==" { teamCategories(first: 5, before: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 5 team categories in the list { teamCategories(first: 5) { pageInfo { hasNextPage endCursor } edges { node { id name } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for last 5 team categories in the list { teamCategories(last: 10) { pageInfo { hasNextPage endCursor } edges { node { id name } cursor } } } </code></pre></div> All team categories <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come after the specified cursor.</td> <td></td> </tr> <tr> <td>before</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come before the specified cursor.</td> <td></td> </tr> <tr> <td>first</td> <td><a href="#int">Int</a></td> <td>Returns the first n elements from the list.</td> <td></td> </tr> <tr> <td>last</td> <td><a href="#int">Int</a></td> <td>Returns the last n elements from the list.</td> <td></td> </tr> </tbody></table> <h2 id='teamcategory-teamcategory'>teamCategory (<a href="#teamcategory">TeamCategory</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code>{ teamCategory(id: 1) { id name } } </code></pre></div> A single team category <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#int">Int</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='teams-teamconnection'>teams (<a href="#teamconnection">TeamConnection</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 teams after cursor "NQ==" { teams(first: 10, after: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name description email location name teamCategory { id name } } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 teams before cursor "NQ==" { teams(first: 10, before: "NQ==") { pageInfo { hasNextPage endCursor } edges { node { id name description email location name teamCategory { id name } } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for first 10 teams in the list { teams(first: 10) { pageInfo { hasNextPage endCursor } edges { node { id name description email location name teamCategory { id name } } cursor } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Request for last 10 teams in the list { teams(last: 10) { pageInfo { hasNextPage endCursor } edges { node { id name description email location name teamCategory { id name } } cursor } } } </code></pre></div> All teams <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come after the specified cursor.</td> <td></td> </tr> <tr> <td>before</td> <td><a href="#string">String</a></td> <td>Returns the elements in the list that come before the specified cursor.</td> <td></td> </tr> <tr> <td>first</td> <td><a href="#int">Int</a></td> <td>Returns the first n elements from the list.</td> <td></td> </tr> <tr> <td>last</td> <td><a href="#int">Int</a></td> <td>Returns the last n elements from the list.</td> <td></td> </tr> </tbody></table> <h1 id='mutations'>Mutations</h1><h2 id='adddepartment-adddepartmentpayload'>addDepartment (<a href="#adddepartmentpayload">AddDepartmentPayload</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a Department mutation { addDepartment( addDepartmentInput: { name: "Engineering" externalId: "123" } ) { department { id name externalId } } } </code></pre></div> Add a new Department <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>addDepartmentInput</td> <td><a href="#adddepartmentinput">AddDepartmentInput!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='addlocation-addlocationpayload'>addLocation (<a href="#addlocationpayload">AddLocationPayload</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a Location mutation { addLocation( addLocationInput: { name: "Denver, CO" address: "1801 Broadway, 13th Floor, Denver, CO 80202" externalId: "123" } ) { location { id name address externalId } } } </code></pre></div> Add a new Location <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>addLocationInput</td> <td><a href="#addlocationinput">AddLocationInput!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='addpendinghire-pendinghire'>addPendingHire (<a href="#pendinghire">PendingHire</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a PendingHire with required information as well as a value for a text Custom Field (long text, confirmable, # and multiple_choice Custom Fields also take Strings as the "value"). mutation { addPendingHire( pendingHireInfo: { firstName: "Joe" lastName: "Schmoe" email: "joe123@example.com" workCountryCode: "USA" customFieldValues: [ { customFieldId: "favorite_food", value: "Egg McMuffins" } ] } ) { firstName lastName email workCountryCode customFieldValues(customFieldIds: ["favorite_food"]) { customField { id } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a PendingHire with required information as well as a value for a Multiple Select Custom Field. These Custom # Fields require a JSON Array-formatted string (including escaped quotes) for the "value". Also of note, each of the # elements in the array must be a valid option for the given Custom Field. mutation { addPendingHire( pendingHireInfo: { firstName: "Joe" lastName: "Schmoe" email: "joe123@example.com" workCountryCode: "USA" customFieldValues: [ { customFieldId: "required_equipment", value: "[\"Ergonomic Keyboard\", \"Standing Desk\"]" } ] } ) { firstName lastName email workCountryCode customFieldValues(customFieldIds: ["required_equipment"]) { customField { id } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a PendingHire with required information as well as a value for a Team Custom Field. These Custom Fields # require an ID for the "value." mutation { addPendingHire( pendingHireInfo: { firstName: "Joe" lastName: "Schmoe" email: "joe123@example.com" workCountryCode: "USA" customFieldValues: [ { customFieldId: "primary_social_club", value: 14 } ] } ) { firstName lastName email workCountryCode customFieldValues { customField { id } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a PendingHire with required information as well as a value for an Address Custom Field. These Custom # Fields require a JSON Object-formatted string (including escaped quotes) for the "value". mutation { addPendingHire( pendingHireInfo: { firstName: "Joe" lastName: "Schmoe" email:"joe123@example.com" workCountryCode: "USA" customFieldValues: [ { customFieldId: "address", value: "{\"address_line_1\":\"123 Test Street\",\"address_line_2\":\"Apartment 1\",\"city\":\"Pawnee\", \"state\":\"IN\", \"zipcode\":\"12345\",\"country\":\"USA\"}" } ] } ) { firstName lastName email workCountryCode customFieldValues(customFieldIds: ["address"]) { customField { id } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a PendingHire with required information as well as a value for a Contact Custom Field. These Custom # Fields require a JSON Object-formatted string (including escaped quotes) for the "value". mutation { addPendingHire( pendingHireInfo: { firstName: "Joe" lastName: "Schmoe" email:"joe123@example.com" workCountryCode: "USA" customFieldValues: [ { customFieldId: "emergency_contact", value: "{\"first_name\": \"Joe\", \"last_name\": \"Schmoe\", \"email\":\"jschmoe@aol.com\", \"phone\": \"123.456.7890\", \"relationship\": \"Other\"}" } ] } ) { firstName lastName email workCountryCode customFieldValues(customFieldIds: ["emergency_contact"]) { customField { id } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Create a PendingHire with required information as well as a value for a Date Custom Field. These Custom Fields # require a String formatted as such: YYYY-MM-DD. mutation { addPendingHire( pendingHireInfo: { firstName: "Joe" lastName: "Schmoe" email:"joe123@example.com" workCountryCode: "USA" customFieldValues: [ { customFieldId: "fully_vested", value: "2019-12-12" } ] } ) { firstName lastName email workCountryCode customFieldValues(customFieldIds: ["fully_vested"]) { customField { id } value } } } </code></pre></div> Add a Pending Hire to Greenhouse Onboarding <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>pendingHireInfo</td> <td><a href="#addpendinghireinput">AddPendingHireInput!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='deletedepartment-deletedepartmentpayload'>deleteDepartment (<a href="#deletedepartmentpayload">DeleteDepartmentPayload</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Delete a department by the department id mutation { deleteDepartment(deleteDepartmentInput: {id: 1}) { deletedDepartmentId } } </code></pre></div> Delete a Department <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>deleteDepartmentInput</td> <td><a href="#deletedepartmentinput">DeleteDepartmentInput!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='deletelocation-deletelocationpayload'>deleteLocation (<a href="#deletelocationpayload">DeleteLocationPayload</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Delete a location by the location id mutation { deleteLocation(deleteLocationInput: {id: 1}) { deletedLocationId } } </code></pre></div> Delete a Location <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>deleteLocationInput</td> <td><a href="#deletelocationinput">DeleteLocationInput!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='updatedepartment-updatedepartmentpayload'>updateDepartment (<a href="#updatedepartmentpayload">UpdateDepartmentPayload</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update a department's name. Must provide the id of an existing department mutation { updateDepartment( updateDepartmentInput: { id: 1 name: "Data Science" externalId: "123" } ) { department { id name externalId } } } </code></pre></div> Update a Department <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>updateDepartmentInput</td> <td><a href="#updatedepartmentinput">UpdateDepartmentInput!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='updateemployeeprofile-employee'>updateEmployeeProfile (<a href="#employee">Employee</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update an employee's work email address, date of birth, and department. Return these fields to confirm the change. mutation { updateEmployeeProfile( id: 25, employeeUpdates: { email: "new_email_address@example.com" dateOfBirth: "1985-04-07" department: 1 } ) { email dateOfBirth department { id } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update/create the value for a text, long text, confirmable, or multiple_choice Custom Field. For Custom Fields of # these types, provide a string for the value. Here we update the "favorite_food" Custom Field Value (a text Custom # Field) to "Egg McMuffins". We ask for the employee's customFieldValues, but we limit them to those that # belong to the "favorite_food" Custom Field. E.g. we filter out the irrelevant customFieldValues. mutation { updateEmployeeProfile( id: 20, employeeUpdates: { customFieldValues: [ { customFieldId: "favorite_food", value: "Egg McMuffins" } ] } ) { customFieldValues(customFieldIds: ["favorite_food"]) { customField { id } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update/create the value for a Multiple Select Custom Field. For these Custom Fields, "value" must be a string # representing a JSON Array (including escaped quotation marks). Also of note, each of the values of this array must # be one of the pre-defined values for the given Custom Field. Here, we set the "required_equipment" Custom Field Value # to contain "Ergonomic Keyboard" and "Standing Desk". We then request the updated Employee's value for this Custom Field # to confirm the change. mutation { updateEmployeeProfile( id: 20, employeeUpdates: { customFieldValues: [ { customFieldId: "required_equipment", value: "[\"Ergonomic Keyboard\", \"Standing Desk\"]" } ] } ) { customFieldValues(customFieldIds: ["required_equipment"]) { customField { id fieldType } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update/create the value for a Team Custom Field. For Custom Fields of type "Team" we provide an ID as the # value. This value represents the ID of the new Team. Here we change the this employees "primary_social_club" to be # Team 14. These Team IDs can be found by utilizing the team query. mutation { updateEmployeeProfile( id: 20, employeeUpdates: { customFieldValues: [ { customFieldId: "primary_social_club", value: 14 } ] } ) { customFieldValues(customFieldIds: ["primary_social_club"]) { customField { id fieldType } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update/create the value for an Address Custom Field. These Custom Fields require a String value. This String value # must be a JSON Object (with quotes escaped accordingly). mutation { updateEmployeeProfile( id: 20, employeeUpdates: { customFieldValues: [ { customFieldId: "address", value: "{\"address_line_1\":\"123 Test Street\",\"address_line_2\":\"Apartment 1\",\"city\":\"Pawnee\", \"state\":\"IN\", \"zipcode\":\"12345\",\"country\":\"USA\"}" } ] } ) { customFieldValues(customFieldIds: ["address"]) { customField { id } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update/create the value for a Contact Custom Field. These Custom Fields require a String value. This String value # must be a JSON Object (with quotes escaped accordingly). mutation { updateEmployeeProfile( id: 20, employeeUpdates: { customFieldValues: [ { customFieldId: "emergency_contact", value: "{\"first_name\": \"Joe\", \"last_name\": \"Schmoe\", \"email\":\"jschmoe@aol.com\", \"phone\": \"123.456.7890\", \"relationship\": \"Other\"}" } ] } ) { customFieldValues(customFieldIds: ["emergency_contact"]) { customField { id fieldType } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update/create the value for a date Custom Field. These Custom Fields require a String formatted as such: YYYY-MM-DD mutation { updateEmployeeProfile( id: 20, employeeUpdates: { customFieldValues: [ { customFieldId: "fully_vested", value: "2019-12-12" } ] } ) { customFieldValues(customFieldIds: ["fully_vested"]) { customField { id fieldType } value } } } </code></pre></div><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Terminate an employee. Both employment status and date of termination are required. # Date of termination can be in the past for immediate termination or in the future. mutation { updateEmployeeProfile( id: 20, employeeUpdates: { employmentStatus: "Terminated" customFieldValues: { customFieldId: "system.date_of_termination" value: "2020-01-01" } } ) { id employmentStatus dateOfTermination } } </code></pre></div> Update an employee's profile <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>employeeUpdates</td> <td><a href="#updateemployee">UpdateEmployee!</a></td> <td></td> <td>Required</td> </tr> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='updatelocation-updatelocationpayload'>updateLocation (<a href="#updatelocationpayload">UpdateLocationPayload</a>)</h2><div class="highlight"><pre class="highlight graphql tab-graphql"><code># Update a location. Must provide the id of an existing location. mutation { updateLocation( updateLocationInput: { id: 22 name: "San Francisco, CA" address: "575 Market Street, Suite #1750, San Francisco, CA 94105" externalId: "123" } ) { location { id name address externaId } } } </code></pre></div> Update a Location <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>updateLocationInput</td> <td><a href="#updatelocationinput">UpdateLocationInput!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h1 id='types'>Types</h1><h2 id='adddepartmentpayload'>AddDepartmentPayload</h2> The result of running an addDepartment mutation <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>department</td> <td><a href="#department">Department</a></td> <td>The new department</td> </tr> </tbody></table> <h2 id='addlocationpayload'>AddLocationPayload</h2> The result of running an addLocation mutation <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>location</td> <td><a href="#location">Location</a></td> <td>The new location</td> </tr> </tbody></table> <h2 id='complexityinfo'>ComplexityInfo</h2> Information about the current request's complexity. If the complexity exceeds the maximum, the request will fail <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>maximum</td> <td><a href="#int">Int!</a></td> <td></td> </tr> <tr> <td>score</td> <td><a href="#int">Int!</a></td> <td></td> </tr> </tbody></table> <h2 id='country'>Country</h2> A country <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>countryCode</td> <td><a href="#string">String!</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String!</a></td> <td></td> </tr> <tr> <td>states</td> <td><a href="#state">[State!]!</a></td> <td></td> </tr> </tbody></table> <h2 id='customfield'>CustomField</h2> Represents a single CustomField record for your company. CustomFields can be stored and displayed in a variety of ways. The types are described via the <a href="#customfieldtypes">CustomFieldTypes</a> enum. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> <tr> <td>customFieldGroup</td> <td><a href="#customfieldgroup">CustomFieldGroup</a></td> <td></td> </tr> <tr> <td>fieldType</td> <td><a href="#customfieldtype">CustomFieldType!</a></td> <td>The field type determines how users input and view the data for this field.</td> </tr> <tr> <td>id</td> <td><a href="#string">String!</a></td> <td>A unique identifier for this CustomField.</td> </tr> <tr> <td>multipleChoiceOptions</td> <td><a href="#string">[String!]</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String!</a></td> <td>The name of this custom field as users would see it inside Greenhouse Onboarding.</td> </tr> <tr> <td>teamCategory</td> <td><a href="#teamcategory">TeamCategory</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> </tbody></table> <h2 id='customfieldconnection'>CustomFieldConnection</h2> The connection type for CustomField. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>edges</td> <td><a href="#customfieldedge">[CustomFieldEdge]</a></td> <td>A list of edges.</td> </tr> <tr> <td>nodes</td> <td><a href="#customfield">[CustomField]</a></td> <td>A list of nodes.</td> </tr> <tr> <td>pageInfo</td> <td><a href="#pageinfo">PageInfo!</a></td> <td>Information to aid in pagination.</td> </tr> </tbody></table> <h2 id='customfieldedge'>CustomFieldEdge</h2> An edge in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cursor</td> <td><a href="#string">String!</a></td> <td>A cursor for use in pagination.</td> </tr> <tr> <td>node</td> <td><a href="#customfield">CustomField</a></td> <td>The item at the end of the edge.</td> </tr> </tbody></table> <h2 id='customfieldgroup'>CustomFieldGroup</h2> A Group of Custom Field <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String!</a></td> <td></td> </tr> </tbody></table> <h2 id='customfieldvalue'>CustomFieldValue</h2> A Custom Field Value Record <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> <tr> <td>customField</td> <td><a href="#customfield">CustomField!</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> <tr> <td>value</td> <td><a href="#value">Value</a></td> <td>A different type of value will be stored based upon the field type of the <a href="#customfield">CustomField</a>. Some types have the data stored as a nested object. Note that the type is a scalar named <a href="#value">Value</a>. Even though it appears to be an object, you are not able to use GraphQL to determine its shape.</td> </tr> <tr> <td>valueUpdatedAt</td> <td><a href="#datetime">DateTime!</a></td> <td>The time of the most recent update to this field.</td> </tr> </tbody></table> <h2 id='deletedepartmentpayload'>DeleteDepartmentPayload</h2> The result of running an deleteDepartment mutation <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>deletedDepartmentId</td> <td><a href="#id">ID</a></td> <td>The ID of the department that was just deleted</td> </tr> </tbody></table> <h2 id='deletelocationpayload'>DeleteLocationPayload</h2> The result of running an deleteLocation mutation <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>deletedLocationId</td> <td><a href="#id">ID</a></td> <td>The ID of the location that was just deleted</td> </tr> </tbody></table> <h2 id='department'>Department</h2> Represents a single department in your company. Employees may belong to zero or one department. Departments are used in a variety of ways in Greenhouse Onboarding, including permissions and onboarding plans. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> <tr> <td>externalId</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String!</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> </tbody></table> <h2 id='departmentconnection'>DepartmentConnection</h2> The connection type for Department. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>edges</td> <td><a href="#departmentedge">[DepartmentEdge]</a></td> <td>A list of edges.</td> </tr> <tr> <td>nodes</td> <td><a href="#department">[Department]</a></td> <td>A list of nodes.</td> </tr> <tr> <td>pageInfo</td> <td><a href="#pageinfo">PageInfo!</a></td> <td>Information to aid in pagination.</td> </tr> </tbody></table> <h2 id='departmentedge'>DepartmentEdge</h2> An edge in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cursor</td> <td><a href="#string">String!</a></td> <td>A cursor for use in pagination.</td> </tr> <tr> <td>node</td> <td><a href="#department">Department</a></td> <td>The item at the end of the edge.</td> </tr> </tbody></table> <h2 id='document'>Document</h2> Represents a single document attached to an <a href="#employee">Employee</a>. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>assignedTaskName</td> <td><a href="#string">String!</a></td> <td>Name of the task the document is attached to.</td> </tr> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> <tr> <td>file</td> <td><a href="#file">File</a></td> <td>Contains the file payload.</td> </tr> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> </tbody></table> <h2 id='employee'>Employee</h2> A single Employee that works for your company. Employees have first class fields (e.g. title, start_date, email), and they also hold custom_field_values for user defined custom fields. These secondary values are held within the customFieldValues array. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>about</td> <td><a href="#string">String</a></td> <td>A brief description of the employee. This information is displayed on both the employee's profile and is also featured prominently in the Welcome Experience for any new hires that report to this employee.</td> </tr> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> <tr> <td>customFieldValues</td> <td><a href="#customfieldvalue">[CustomFieldValue!]</a></td> <td>A list of all other profile information for this employee. Administrators can configure these fields on the <a href="https://onboarding.greenhouse.io/settings/fields">Settings > Custom Fields</a> page.</td> </tr> <tr> <td>dateOfBirth</td> <td><a href="#date">Date</a></td> <td>Note that only administrators can see the birth year for employees</td> </tr> <tr> <td>dateOfTermination</td> <td><a href="#date">Date</a></td> <td>This information is only available on terminated employees</td> </tr> <tr> <td>department</td> <td><a href="#department">Department</a></td> <td></td> </tr> <tr> <td>documents</td> <td><a href="#document">[Document!]</a></td> <td>These are documents that came over from Greenhouse Recruiting or were attached directly to the employee profile. This does not include E-Signature requests.</td> </tr> <tr> <td>email</td> <td><a href="#string">String</a></td> <td>The employee's work email. They need this in order to sign in.</td> </tr> <tr> <td>employmentStatus</td> <td><a href="#string">String</a></td> <td><a href="#employmentstatuses-string">Valid options</a></td> </tr> <tr> <td>firstName</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>greenhouseRecruitingData</td> <td><a href="#greenhouserecruitingdata">GreenhouseRecruitingData</a></td> <td>The Greenhouse Recruiting 'hired' webhook data</td> </tr> <tr> <td>hrManager</td> <td><a href="#employee">Employee</a></td> <td>The employee's HR Manager.</td> </tr> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> </tr> <tr> <td>lastName</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>location</td> <td><a href="#location">Location</a></td> <td></td> </tr> <tr> <td>manager</td> <td><a href="#employee">Employee</a></td> <td>This employee's direct manager.</td> </tr> <tr> <td>middleName</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>otherCriteria</td> <td><a href="#othercriterion">[OtherCriterion!]</a></td> <td></td> </tr> <tr> <td>personalEmail</td> <td><a href="#string">String</a></td> <td>The employee's personal email.</td> </tr> <tr> <td>phoneNumber</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>preferredFirstName</td> <td><a href="#string">String</a></td> <td>This is the name that your employee prefers to go by. If this value is set, Greenhouse Onboarding will display this name everywhere in the product instead of the employee's legal name.</td> </tr> <tr> <td>preferredLastName</td> <td><a href="#string">String</a></td> <td>This is the name that your employee prefers to go by. If this value is set, Greenhouse Onboarding will display this name everywhere in the product instead of the employee's legal name.</td> </tr> <tr> <td>profileImage</td> <td><a href="#file">File</a></td> <td>A file containing the employee's profile image. This image is displayed in emails, reports and directory pages.</td> </tr> <tr> <td>signatureRequests</td> <td><a href="#signaturerequest">[SignatureRequest!]</a></td> <td>These are E-Signature requests initiated through Greenhouse Onboarding. Keep in mind that these requests can be in a number of different states in their lifecycle and may not always have a signed document available to download.</td> </tr> <tr> <td>startDate</td> <td><a href="#date">Date</a></td> <td></td> </tr> <tr> <td>suffix</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>title</td> <td><a href="#string">String</a></td> <td>The employee's job title.</td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime!</a></td> <td></td> </tr> <tr> <td>workCountryCode</td> <td><a href="#string">String!</a></td> <td></td> </tr> </tbody></table> <h2 id='employeeconnection'>EmployeeConnection</h2> The connection type for Employee. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>edges</td> <td><a href="#employeeedge">[EmployeeEdge]</a></td> <td>A list of edges.</td> </tr> <tr> <td>nodes</td> <td><a href="#employee">[Employee]</a></td> <td>A list of nodes.</td> </tr> <tr> <td>pageInfo</td> <td><a href="#pageinfo">PageInfo!</a></td> <td>Information to aid in pagination.</td> </tr> </tbody></table> <h2 id='employeeedge'>EmployeeEdge</h2> An edge in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cursor</td> <td><a href="#string">String!</a></td> <td>A cursor for use in pagination.</td> </tr> <tr> <td>node</td> <td><a href="#employee">Employee</a></td> <td>The item at the end of the edge.</td> </tr> </tbody></table> <h2 id='file'>File</h2> A File record <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>expiresAt</td> <td><a href="#datetime">DateTime</a></td> <td>The time when the URL will expire. After this time, you will need to generate a new URL.</td> </tr> <tr> <td>fileName</td> <td><a href="#string">String</a></td> <td>The original name of the file.</td> </tr> <tr> <td>fileSize</td> <td><a href="#int">Int</a></td> <td>The file size, in bytes</td> </tr> <tr> <td>fileUrl</td> <td><a href="#string">String</a></td> <td>An expiring URL you can use to download the file.</td> </tr> </tbody></table> <h2 id='greenhouserecruitingdata'>GreenhouseRecruitingData</h2> Greenhouse Recruiting 'Candidate hired' webhook data <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>applicationId</td> <td><a href="#id">ID!</a></td> <td>Greenhouse Recruiting application ID</td> </tr> <tr> <td>rawData</td> <td><a href="#string">String!</a></td> <td>Greenhouse Recruiting 'Candidate hired' webhook payload</td> </tr> </tbody></table> <h2 id='location'>Location</h2> Represents a single location in your company. Employees may belong to zero or one location. Locations are used in a variety of ways in Greenhouse Onboarding, including permissions and onboarding plans. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>address</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> <tr> <td>externalId</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#id">ID</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> </tbody></table> <h2 id='locationconnection'>LocationConnection</h2> The connection type for Location. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>edges</td> <td><a href="#locationedge">[LocationEdge]</a></td> <td>A list of edges.</td> </tr> <tr> <td>pageInfo</td> <td><a href="#pageinfo">PageInfo!</a></td> <td>Information to aid in pagination.</td> </tr> </tbody></table> <h2 id='locationedge'>LocationEdge</h2> An edge in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cursor</td> <td><a href="#string">String!</a></td> <td>A cursor for use in pagination.</td> </tr> <tr> <td>node</td> <td><a href="#location">Location</a></td> <td>The item at the end of the edge.</td> </tr> </tbody></table> <h2 id='mutation'>Mutation</h2> <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>addDepartment</td> <td><a href="#adddepartmentpayload">AddDepartmentPayload</a></td> <td>Add a new Department</td> </tr> <tr> <td>addLocation</td> <td><a href="#addlocationpayload">AddLocationPayload</a></td> <td>Add a new Location</td> </tr> <tr> <td>addPendingHire</td> <td><a href="#pendinghire">PendingHire</a></td> <td>Add a Pending Hire to Greenhouse Onboarding</td> </tr> <tr> <td>deleteDepartment</td> <td><a href="#deletedepartmentpayload">DeleteDepartmentPayload</a></td> <td>Delete a Department</td> </tr> <tr> <td>deleteLocation</td> <td><a href="#deletelocationpayload">DeleteLocationPayload</a></td> <td>Delete a Location</td> </tr> <tr> <td>updateDepartment</td> <td><a href="#updatedepartmentpayload">UpdateDepartmentPayload</a></td> <td>Update a Department</td> </tr> <tr> <td>updateEmployeeProfile</td> <td><a href="#employee">Employee</a></td> <td>Update an employee's profile</td> </tr> <tr> <td>updateLocation</td> <td><a href="#updatelocationpayload">UpdateLocationPayload</a></td> <td>Update a Location</td> </tr> </tbody></table> <h2 id='othercriterion'>OtherCriterion</h2> A tag that can be used to refine on onboarding plan <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#id">ID</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> </tbody></table> <h2 id='othercriterionconnection'>OtherCriterionConnection</h2> The connection type for OtherCriterion. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>edges</td> <td><a href="#othercriterionedge">[OtherCriterionEdge]</a></td> <td>A list of edges.</td> </tr> <tr> <td>pageInfo</td> <td><a href="#pageinfo">PageInfo!</a></td> <td>Information to aid in pagination.</td> </tr> </tbody></table> <h2 id='othercriterionedge'>OtherCriterionEdge</h2> An edge in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cursor</td> <td><a href="#string">String!</a></td> <td>A cursor for use in pagination.</td> </tr> <tr> <td>node</td> <td><a href="#othercriterion">OtherCriterion</a></td> <td>The item at the end of the edge.</td> </tr> </tbody></table> <h2 id='pageinfo'>PageInfo</h2> Information about pagination in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>endCursor</td> <td><a href="#string">String</a></td> <td>When paginating forwards, the cursor to continue.</td> </tr> <tr> <td>hasNextPage</td> <td><a href="#boolean">Boolean!</a></td> <td>When paginating forwards, are there more items?</td> </tr> <tr> <td>hasPreviousPage</td> <td><a href="#boolean">Boolean!</a></td> <td>When paginating backwards, are there more items?</td> </tr> <tr> <td>startCursor</td> <td><a href="#string">String</a></td> <td>When paginating backwards, the cursor to continue.</td> </tr> </tbody></table> <h2 id='pendinghire'>PendingHire</h2> A Pending Hire Record <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>about</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> <tr> <td>customFieldValues</td> <td><a href="#customfieldvalue">[CustomFieldValue]</a></td> <td></td> </tr> <tr> <td>dateOfBirth</td> <td><a href="#date">Date</a></td> <td></td> </tr> <tr> <td>department</td> <td><a href="#department">Department</a></td> <td></td> </tr> <tr> <td>email</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>employmentStatus</td> <td><a href="#string">String</a></td> <td><a href="#employmentstatuses-string">Valid options</a></td> </tr> <tr> <td>firstName</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>hrManager</td> <td><a href="#employee">Employee</a></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#id">ID</a></td> <td></td> </tr> <tr> <td>lastName</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>location</td> <td><a href="#location">Location</a></td> <td></td> </tr> <tr> <td>manager</td> <td><a href="#employee">Employee</a></td> <td></td> </tr> <tr> <td>personalEmail</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>phoneNumber</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>preferredFirstName</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>preferredLastName</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>startDate</td> <td><a href="#date">Date</a></td> <td></td> </tr> <tr> <td>title</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> <tr> <td>workCountryCode</td> <td><a href="#string">String</a></td> <td></td> </tr> </tbody></table> <h2 id='ratelimit'>RateLimit</h2> Information about your current API quota <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cost</td> <td><a href="#int">Int</a></td> <td>The cost of this query. This amount was deducted from your previous quota.</td> </tr> <tr> <td>limit</td> <td><a href="#int">Int</a></td> <td>Your quota for the given period.</td> </tr> <tr> <td>remaining</td> <td><a href="#int">Int</a></td> <td>The remaining balance for your quota. Any calls that exceed this value will be throttled.</td> </tr> <tr> <td>resetAt</td> <td><a href="#datetime">DateTime</a></td> <td>The time when your quota is reset to its maximum value.</td> </tr> </tbody></table> <h2 id='signaturerequest'>SignatureRequest</h2> An E-Signature Request for assigned to an <a href="#employee">Employee</a>. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>counterSigner</td> <td><a href="#employee">Employee</a></td> <td>The employee responsible for counter-signing this document, if applicable.</td> </tr> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> <tr> <td>file</td> <td><a href="#file">File</a></td> <td>This is available only for completed signatures.</td> </tr> <tr> <td>formFields</td> <td><a href="#json">[JSON]</a></td> <td>An array of values entered in the e-signature document by the signer (and counter signer if applicable). This is available only for completed signatures.</td> </tr> <tr> <td>id</td> <td><a href="#id">ID</a></td> <td></td> </tr> <tr> <td>signatureRequestTemplate</td> <td><a href="#signaturerequesttemplate">SignatureRequestTemplate!</a></td> <td></td> </tr> <tr> <td>status</td> <td><a href="#signaturerequeststatus">SignatureRequestStatus</a></td> <td></td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> </tbody></table> <h2 id='signaturerequesttemplate'>SignatureRequestTemplate</h2> A template used when assigning signature requests. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>counterSigner</td> <td><a href="#employee">Employee</a></td> <td>The default employee responsible for counter-signing documents created from this template, if applicable. Individual SignatureRequest objects can override the counter signer.</td> </tr> <tr> <td>createdAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td>The name of the template. This is the label administrators will see.</td> </tr> <tr> <td>publicName</td> <td><a href="#string">String</a></td> <td>The public-facing name of the template. This is the name the new hire will see. If this is null, new hires will see the name field.</td> </tr> <tr> <td>updatedAt</td> <td><a href="#datetime">DateTime</a></td> <td></td> </tr> </tbody></table> <h2 id='state'>State</h2> A state <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>country</td> <td><a href="#country">Country</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>stateCode</td> <td><a href="#string">String</a></td> <td></td> </tr> </tbody></table> <h2 id='team'>Team</h2> A Team record <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>description</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>email</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#id">ID</a></td> <td></td> </tr> <tr> <td>location</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> </tr> <tr> <td>teamCategory</td> <td><a href="#teamcategory">TeamCategory</a></td> <td></td> </tr> </tbody></table> <h2 id='teamcategory'>TeamCategory</h2> A Team Category Record <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#id">ID</a></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> </tr> </tbody></table> <h2 id='teamcategoryconnection'>TeamCategoryConnection</h2> The connection type for TeamCategory. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>edges</td> <td><a href="#teamcategoryedge">[TeamCategoryEdge]</a></td> <td>A list of edges.</td> </tr> <tr> <td>pageInfo</td> <td><a href="#pageinfo">PageInfo!</a></td> <td>Information to aid in pagination.</td> </tr> </tbody></table> <h2 id='teamcategoryedge'>TeamCategoryEdge</h2> An edge in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cursor</td> <td><a href="#string">String!</a></td> <td>A cursor for use in pagination.</td> </tr> <tr> <td>node</td> <td><a href="#teamcategory">TeamCategory</a></td> <td>The item at the end of the edge.</td> </tr> </tbody></table> <h2 id='teamconnection'>TeamConnection</h2> The connection type for Team. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>edges</td> <td><a href="#teamedge">[TeamEdge]</a></td> <td>A list of edges.</td> </tr> <tr> <td>pageInfo</td> <td><a href="#pageinfo">PageInfo!</a></td> <td>Information to aid in pagination.</td> </tr> </tbody></table> <h2 id='teamedge'>TeamEdge</h2> An edge in a connection. <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>cursor</td> <td><a href="#string">String!</a></td> <td>A cursor for use in pagination.</td> </tr> <tr> <td>node</td> <td><a href="#team">Team</a></td> <td>The item at the end of the edge.</td> </tr> </tbody></table> <h2 id='updatedepartmentpayload'>UpdateDepartmentPayload</h2> The result of running an updateDepartment mutation <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>department</td> <td><a href="#department">Department</a></td> <td>The updated department</td> </tr> </tbody></table> <h2 id='updatelocationpayload'>UpdateLocationPayload</h2> The result of running an updateLocation mutation <table><thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>location</td> <td><a href="#location">Location</a></td> <td>The updated location</td> </tr> </tbody></table> <h1 id='input-objects'>Input Objects</h1><h2 id='adddepartmentinput'>AddDepartmentInput</h2> The input object used to add a <a href="#department">Department</a>. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>externalId</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='addlocationinput'>AddLocationInput</h2> The input object used to add a <a href="#location">Location</a>. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>address</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>externalId</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='addpendinghireinput'>AddPendingHireInput</h2> Specify the properties of a new PendingHire <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>about</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>customFieldValues</td> <td><a href="#updatecustomfieldvalue">[UpdateCustomFieldValue]</a></td> <td></td> <td></td> </tr> <tr> <td>dateOfBirth</td> <td><a href="#date">Date</a></td> <td></td> <td></td> </tr> <tr> <td>department</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>email</td> <td><a href="#string">String</a></td> <td></td> <td>Required</td> </tr> <tr> <td>employmentStatus</td> <td><a href="#string">String</a></td> <td><a href="#employmentstatuses-string">Valid options</a></td> <td></td> </tr> <tr> <td>firstName</td> <td><a href="#string">String!</a></td> <td></td> <td>Required</td> </tr> <tr> <td>hrManager</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>lastName</td> <td><a href="#string">String!</a></td> <td></td> <td>Required</td> </tr> <tr> <td>location</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>manager</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>middleName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>personalEmail</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>phoneNumber</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>preferredFirstName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>preferredLastName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>startDate</td> <td><a href="#date">Date</a></td> <td></td> <td></td> </tr> <tr> <td>suffix</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>title</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>workCountryCode</td> <td><a href="#string">String!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='customfieldvaluesinput'>CustomFieldValuesInput</h2> Limit employees to those that satisfy the specified CustomFieldValue criteria. Note: CustomFieldValues that belong to a CustomField with a CustomFieldType of "MASKED", are not filterable by textValues <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>dateValue</td> <td><a href="#datefilter">DateFilter</a></td> <td></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#string">String!</a></td> <td></td> <td>Required</td> </tr> <tr> <td>idValues</td> <td><a href="#int">[Int]</a></td> <td></td> <td></td> </tr> <tr> <td>textValues</td> <td><a href="#string">[String]</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='datefilter'>DateFilter</h2> Specify a range of dates using after (exclusive >), before (exclusive <), or on (exact match) <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#date">Date</a></td> <td></td> <td></td> </tr> <tr> <td>before</td> <td><a href="#date">Date</a></td> <td></td> <td></td> </tr> <tr> <td>on</td> <td><a href="#date">Date</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='dateofbirthfilter'>DateOfBirthFilter</h2> Filter employees based on their date of birth <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>dateFilter</td> <td><a href="#datefilter">DateFilter</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='datetimefilter'>DateTimeFilter</h2> Specify a range of date-times using after (exclusive >), before (exclusive <) <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>after</td> <td><a href="#datetime">DateTime</a></td> <td></td> <td></td> </tr> <tr> <td>before</td> <td><a href="#datetime">DateTime</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='deletedepartmentinput'>DeleteDepartmentInput</h2> The input object used to delete a <a href="#department">Department</a>. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='deletelocationinput'>DeleteLocationInput</h2> The input object used to delete a <a href="#location">Location</a>. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> <td>Required</td> </tr> </tbody></table> <h2 id='departmentfilter'>DepartmentFilter</h2> Filter employees based on their department <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>departmentIds</td> <td><a href="#int">[Int]</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='emailfilter'>EmailFilter</h2> Filter employees based on their email address <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>emails</td> <td><a href="#string">[String]</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='employmentstatusfilter'>EmploymentStatusFilter</h2> Filter employees based on their Employment Status <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>employmentStatuses</td> <td><a href="#string">[String]</a></td> <td><a href="#employmentstatuses-string">Valid options</a></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='hrmanagerfilter'>HrManagerFilter</h2> Filter employees based on their HR Manager <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>hrManagerIds</td> <td><a href="#int">[Int]</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='locationfilter'>LocationFilter</h2> Filter employees based on their location <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>locationIds</td> <td><a href="#int">[Int]</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='managerfilter'>ManagerFilter</h2> Filter employees based on their Manager <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>managerIds</td> <td><a href="#int">[Int]</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='personalemailfilter'>PersonalEmailFilter</h2> Filter employees based on their personal email address <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>personalEmails</td> <td><a href="#string">[String]</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='startdatefilter'>StartDateFilter</h2> Filter employees based on their start date <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>dateFilter</td> <td><a href="#datefilter">DateFilter</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='titlefilter'>TitleFilter</h2> Filter employees based on their title <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>titles</td> <td><a href="#string">[String]</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='updatecustomfieldvalue'>UpdateCustomFieldValue</h2> Used to update an employee's Custom Field Value <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>customFieldId</td> <td><a href="#id">ID!</a></td> <td></td> <td>Required</td> </tr> <tr> <td>value</td> <td><a href="#value">Value</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='updatedepartmentinput'>UpdateDepartmentInput</h2> The input object used to update a <a href="#department">Department</a>. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>externalId</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> <td>Required</td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='updateemployee'>UpdateEmployee</h2> The input object used to update an <a href="#employee">Employee</a>. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>about</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>customFieldValues</td> <td><a href="#updatecustomfieldvalue">[UpdateCustomFieldValue]</a></td> <td></td> <td></td> </tr> <tr> <td>dateOfBirth</td> <td><a href="#date">Date</a></td> <td></td> <td></td> </tr> <tr> <td>department</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>email</td> <td><a href="#string">String</a></td> <td>The employee's work email. They need this in order to sign in</td> <td></td> </tr> <tr> <td>employmentStatus</td> <td><a href="#string">String</a></td> <td><a href="#employmentstatuses-string">Valid options</a></td> <td></td> </tr> <tr> <td>firstName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>hrManager</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>lastName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>location</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>manager</td> <td><a href="#id">ID</a></td> <td></td> <td></td> </tr> <tr> <td>middleName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>otherCriteria</td> <td><a href="#id">[ID]</a></td> <td></td> <td></td> </tr> <tr> <td>personalEmail</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>phoneNumber</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>preferredFirstName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>preferredLastName</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>profileImage</td> <td><a href="#url">URL</a></td> <td></td> <td></td> </tr> <tr> <td>startDate</td> <td><a href="#date">Date</a></td> <td></td> <td></td> </tr> <tr> <td>suffix</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>title</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>workCountryCode</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='updatelocationinput'>UpdateLocationInput</h2> The input object used to update a <a href="#location">Location</a>. <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>address</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>externalId</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> <tr> <td>id</td> <td><a href="#id">ID!</a></td> <td></td> <td>Required</td> </tr> <tr> <td>name</td> <td><a href="#string">String</a></td> <td></td> <td></td> </tr> </tbody></table> <h2 id='workcountrycodefilter'>WorkCountryCodeFilter</h2> Filter employees based on their work country code <table><thead> <tr> <th>Argument</th> <th>Type</th> <th>Description</th> <th>Required</th> </tr> </thead><tbody> <tr> <td>anyValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>noValue</td> <td><a href="#boolean">Boolean</a></td> <td></td> <td></td> </tr> <tr> <td>workCountryCodes</td> <td><a href="#string">[String]</a></td> <td></td> <td></td> </tr> </tbody></table> <h1 id='scalars'>Scalars</h1><h2 id='boolean'>Boolean</h2> Represents <code>true</code> or <code>false</code> values. <h2 id='date'>Date</h2> Representation of a date in YYYY-MM-DD format. <h2 id='datetime'>DateTime</h2> Representation of datetime in ISO8601. <h2 id='float'>Float</h2> Represents signed double-precision fractional values as specified by <a href="http://en.wikipedia.org/wiki/IEEE_floating_point">IEEE 754</a>. <h2 id='id'>ID</h2> Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as <code>"VXNlci0xMA=="</code>) or integer (such as <code>4</code>) input value will be accepted as an ID. <h2 id='int'>Int</h2> Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. <h2 id='json'>JSON</h2> Represents untyped JSON <h2 id='string'>String</h2> Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text. <h2 id='url'>URL</h2> A URL-formatted String <h2 id='value'>Value</h2> The actual value of a Custom Field Value. This type is capable of holding both Strings and Integers. Its content will depend on the fieldType of its corresponding customField. <h3 id='text-long_text'>text, long_text</h3> <ul> <li>Allowed Type(s): String</li> <li>Must be less than 3000 chars</li> </ul> <h3 id='multiple_choice'>multiple_choice</h3> <ul> <li>Allowed Type(s): String</li> <li>Must exactly match one of the customField's options</li> </ul> <h3 id='multiple_select'>multiple_select</h3> <ul> <li>Allowed Type(s): String. Must be a JSON Array encoded string (with escaped quotes) e.g. <code>"[\"Option A\", \"Option B\"]"</code></li> <li>Each option must be a String that exactly matches one of the customField's options</li> </ul> <h3 id='team-2'>team</h3> <ul> <li>Allowed Type(s): String or Integer</li> <li>Value must be valid Team ID</li> <li>The Team specified by the ID must have the same teamCategory as the customField</li> </ul> <h3 id='employee-2'>employee</h3> <ul> <li>Allowed Type(s): String or Integer</li> <li>Provided value must be valid Employee ID</li> </ul> <h3 id='address'>address</h3> <ul> <li>Allowed Type(s): String. Must be a JSON Object encoded string (with escaped quotes) e.g. <code>"{\"key\": \"value\"}"</code></li> <li>Provided value must be valid Employee ID</li> <li>All values must be Strings</li> <li>Must provide <code>address_line_1</code>, <code>city</code>, <code>state</code>, <code>country</code></li> <li><code>country</code> must be a valid countryCode.</li> <li><code>country</code> must match the <code>workCountryCode</code> of the employee</li> <li><code>state</code> must be a valid stateCode</li> <li><code>state</code> must be a valid stateCode for the provided countryCode.</li> </ul> <h3 id='contact'>contact</h3> <ul> <li>Allowed Type(s): String. Must be a JSON Object encoded string (with escaped quotes) e.g. <code>"{\"key\": \"value\"}"</code></li> <li>All values in the JSON Object must be Strings.</li> <li>Must provide <code>first_name</code>, <code>last_name</code>, and <code>relationship</code></li> <li>must provide at least one of: <code>email</code> or <code>phone</code></li> <li><code>relationship</code> must be one of:</li> <li>Child</li> <li>Domestic Partner</li> <li>Domestic Partner Child</li> <li>Friend</li> <li>Grandparent</li> <li>Parent</li> <li>Sibling</li> <li>Spouse</li> <li>Other</li> </ul> <h3 id='date-2'>date</h3> <ul> <li>Allowed Type(s): String</li> <li>Must formatted as YYYY-MM-DD</li> </ul> <h3 id='legal_name'>legal_name</h3> <ul> <li>Allowed Type(s): String. Must be a JSON Object encoded string (with escaped quotes) e.g. <code>"{\"key\": \"value\"}"</code></li> <li>All values in the JSON Object must be Strings.</li> <li>Must provide <code>first_name</code> and <code>last_name</code></li> </ul> <h3 id='preferred_name'>preferred_name</h3> <ul> <li>Allowed Type(s): String. Must be a JSON Object encoded string (with escaped quotes) e.g. <code>"{\"key\": \"value\"}"</code></li> <li>All values in the JSON Object must be Strings.</li> </ul> <h1 id='enums'>Enums</h1> NOTE: Enums are unquoted in user input but quotes in API output. <h2 id='customfieldtype'>CustomFieldType</h2> Possible type values for CustomFieldValues <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>ADDRESS</td> <td>Displayed as group of inputs. Stored as JSON.</td> </tr> <tr> <td>CONTACT</td> <td>Displayed as group of inputs. Stored as JSON.</td> </tr> <tr> <td>COUNTRY</td> <td>Displayed as a dropdown. Stored as a String.</td> </tr> <tr> <td>DATE</td> <td>Displayed as a datepicker. Stored as a DateTime</td> </tr> <tr> <td>EMPLOYEE</td> <td>Displayed as a dropdown of employees. Stored as an Employee ID.</td> </tr> <tr> <td>IMAGE</td> <td>Displayed as an image. Stored as a File.</td> </tr> <tr> <td>LEGAL_NAME</td> <td>Displayed as a group of inputs. Stored as JSON.</td> </tr> <tr> <td>LONG_TEXT</td> <td>Displayed as a multiline text box. Stored as a String.</td> </tr> <tr> <td>MASKED</td> <td>Displayed as a single line text field (hidden in application). Stored as a String.</td> </tr> <tr> <td>MULTIPLE_CHOICE</td> <td>Displayed as a dropdown. Stored as a String.</td> </tr> <tr> <td>MULTIPLE_SELECT</td> <td>Displayed as a tag field. Stored as an Array of Strings.</td> </tr> <tr> <td>PREFERRED_NAME</td> <td>Displayed as a group of inputs. Stored as JSON.</td> </tr> <tr> <td>TEAM</td> <td>Displayed as a dropdown of teams. Stored as a Team ID.</td> </tr> <tr> <td>TEXT</td> <td>Displayed as a single line text field. Stored as a String.</td> </tr> </tbody></table> <h2 id='signaturerequeststatus'>SignatureRequestStatus</h2> Possible status values for a Signature Request <table><thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead><tbody> <tr> <td>BEING_PROCESSED</td> <td>Document is being processed by our E-Signature Vendor.</td> </tr> <tr> <td>CANCELED</td> <td>Signature request has been terminated.</td> </tr> <tr> <td>COMPLETED</td> <td>Document has been successfully signed and verified.</td> </tr> <tr> <td>ERROR</td> <td>Could not be completed due to an error processing the E-Signature.</td> </tr> <tr> <td>WAITING_FOR_COUNTER_SIGNATURE</td> <td>Document awaiting counter-signer signature.</td> </tr> <tr> <td>WAITING_FOR_SIGNATURE</td> <td>Waiting for the employee to sign the document.</td> </tr> </tbody></table> </div> <div class="dark-box"> <div class="lang-selector"> <a href="#" data-language-name="Examples">Examples</a> </div> </div> </div> </body> </html>