Programmatic scaling with recruiting APIs

APIs are application program interfaces. APIs provide a way to programmatically interact with platforms on the web. Greenhouse has five APIs that allow data to flow into and out of the hiring software in a structured way. Almost everything that can be done in-app in your Greenhouse account can be done programmatically, at scale, with one or more of our APIs.

Check our Developer Resources for in-depth technical information, including available endpoints and expected payloads.

Harvest API

Harvest API can be used to create HRIS integrations, candidate offer integrations, and job approval integrations, as well as candidate and job update integrations. This API is designed to export internal candidate and job information from Greenhouse Recruiting via GET endpoints. However, Harvest API also includes POST, PUT, PATCH, and DELETE endpoints to transform information in Greenhouse Recruiting.

Example: You can use the Harvest API endpoint GET: List applications to programmatically retrieve candidate applications from Greenhouse Recruiting. You can also use the Harvest API endpoint DELETE: Delete application to programmatically delete candidate applications from Greenhouse Recruiting. In this way, Harvest allows for data flow both into and out of Greenhouse Recruiting.

Note: All Harvest API endpoints require authentication to use. Read more about authenticating with an API key.

Want to learn more about Harvest API? Check out Harvest API overview.

Job Board API

Job Board API can be used to build a custom job board or career site to post your jobs publicly for candidate applications. Job Board API is designed to export information about your public job boards and job posts so your web developers can build custom career and application sites. The Job Board API also allows for importing new candidate data into Greenhouse Recruiting via the endpoint POST: Submit an application.

Example: You can use the Job Board API endpoint GET: List jobs to programmatically retrieve your job post information from Greenhouse Recruiting then display your job posts on your API-driven career site. You can also use the Job Board API endpoint POST: Submit application to allow candidates to submit applications on your career site to Greenhouse Recruiting. In this way, Job Board API allows for data flow both into and out of Greenhouse Recruiting.

Note: The Job Board API endpoint POST: Submit application requires authentication. Read more about authenticating with an API key.

Assessment API

Assessment API can be used to create custom take home test integrations on Greenhouse Recruiting including coding tests, video interviews, and personality tests. Assessment API is designed to import test options from a third-party system to Greenhouse Recruiting. When candidates reach a predetermined job stage in Greenhouse Recruiting, the third-party can be triggered to send a test to the candidate. The test status is subsequently updated in Greenhouse Recruiting when the candidate completes the assessment on the third-party platform.

Note: With Assessment API, Greenhouse utilizes basic authentication over HTTPS to interact with third-party systems. For this reason, we require each of the third-party API endpoints to use HTTPS. Read more.

Ingestion API

Ingestion API can be used to source candidates and prospects from a third-party to Greenhouse Recruiting and to retrieve the stage and status of existing candidates in Greenhouse Recruiting. Ingestion API can be used to build new sourcing integrations.

Note: Ingestion API offers two methods of authentication: OAuth 2.0 and basic authentication. Read more.

Onboarding API

Onboarding API can be used to query and modify your employee profiles and company information in Greenhouse Onboarding. Onboarding API is typically used to build HR integrations. Compared to a traditional REST API, the Onboarding API only supports Graph QL. You're able to retrieve information from Greenhouse Onboarding using queries, and you're able to use mutations to manipulate data in Greenhouse Onboarding. You can read more here: Onboarding API > General concepts.

Note: Mutations via Graph QL are similar to REST API requests like GET, PUT, POST, PATCH, and DELETE.

Onboarding API requires a Greenhouse Onboarding or Greenhouse Welcome subscription.

Onboarding API is secured with HTTP Basic Authentication over HTTPS. Clients are required to supply both a username and password. Credentials can be generated in-app in Greenhouse Onboarding via Settings > API Management screen.