Skip to main content

Setting Up Your Greenhouse Harvest API Key

This article describes the process for setting up Greenhouse Harvest API Key, and Webhooks for deep integrations with Gem.

Prerequisites:

Step 1: Go to the Greenhouse API Credentials page

Visit the Greenhouse API Credentials page.

 

Step 2: Create the API Key

  1. In the Create New Credential dialog box, make the following selections:

  • API Type: Harvest

  • Partner: Gem

  • Description: Gem Harvest API Key

When finished, click Manage Permissions to generate the Harvest API key and automatically assign it the appropriate permissions required by Gem.

 

mceclip0.png

 

Step 3: Verify the Following Permissions are Set

The following permissions should be automatically set, but please confirm they are selected

Activity Feed

  • GET: Retrieve Activity Feed

Applications

  • GET: Retrieve Application

  • GET: List Applications

  • PATCH: Update Application

  • POST: Advance Application

  • POST: Move Application

  • POST: Moves Application to Job

Candidates

  • GET: Retrieve Candidate

  • GET: List Candidates

  • PATCH: Edit Candidate

  • POST: Add Candidate

  • POST: Add Note

  • POST: Add Attachment

  • POST: Add Application

  • POST: Add Prospect

  • PUT: Merge two candidates

Close Reasons

  • GET: Get close reasons

Custom Field Options

  • GET: Custom Field Options

Custom Fields

  • GET: Get custom fields

Departments

  • GET: Retrieve Department

  • GET: List Departments

Education

  • GET: Get degrees

  • GET: Get disciplines

  • GET: Get schools

Email Templates

  • GET: Retrieve Email Template

  • GET: List Email Templates

Job Openings

  • GET: List Openings for a job

Job Posts

  • GET: List job posts

  • GET: Retrieve job post for job

  • GET: List job posts for job

Job Stages

  • GET: Retrieve job stage

  • GET: List job stages

  • GET: List job stages for job

Jobs

  • GET: Retrieve job

  • GET: List jobs

Offers

  • GET: List application's offers

  • GET: Retrieve application's current offer

  • GET: Retrieve offer

  • GET: List offers

Offices

  • GET: Retrieve office

  • GET: List offices

Rejection Reasons

  • GET: List rejection reasons

Scheduled Interviews

  • GET: List interviews for application

  • GET: Retrieve interview

  • GET: List interviews

Scorecards

  • GET: Retrieve application's scorecard

  • GET: List Scorecards for application

  • GET: Retrieve scorecard

  • GET: List Scorecards

Sources

  • GET: List sources

Tags

  • DELETE: Remove tag from candidate

  • GET: List tags applied to candidate

  • GET: List candidate tags

  • PUT: Add a candidate tag

  • GET: Retrieve Job Tracking Link

User Roles

  • GET: List User Roles

Users

  • GET: Retrieve User

  • GET: List Users

  • GET: List User Job Permissions

  • GET: List User Future Job Permissions

EEOC (Optional)

If you are enabling EEOC, you'll need to grant this permission as well. If you're interested in hearing more about this, please reach out to your Customer Success Manager!

  • Get: Retrieve EEOC Data for Application

  • Get: List EEOC

Step 4: Add the API Key to the Gem Admin panel

Copy the “Gem” Harvest API Key in the API Credentials Management page and input it into the Admin Section in Gem under the Greenhouse Harvest API Key Section.

 

Step 5 (Optional): Setting up Greenhouse Webhooks 

If you're using features like Pipeline Analytics, Talent Pipeline, or ATS Candidate Rediscovery, you'll also need to set up Greenhouse Webhooks as well. This article walks you through setting those up!

 

 

Have any issues or questions on this topic? Please feel free to contact your dedicated Gem Customer Success Manager directly or our Support team at support@gem.com.

Was this article helpful?