With Refer, you can effortlessly import roles for creating rewards, identify duplicate candidates, and manage referral applications directly in Greenhouse Recruiting, all powered through the Greenhouse Harvest API.

As candidates move through your hiring pipeline, changes are automatically synced, allowing your team to stay on top of candidate referrals without any extra effort.

Greenhouse Recruiting's integration with Refer allows you to seamlessly import, monitor and manage candidate referrals. 

Configure Refer signup flow

To begin integration setup, create a Refer employer profile within Refer's platform using LinkedIn authentication. You'll be prompted to enter a brief overview of your company details. 

Next, from the listed ATS options, select Greenhouse and enter your created API key and Site Admin User ID in the Greenhouse setup prompt to sync your open roles between the two systems.

Create a Harvest API key for the Refer integration

To configure the Greenhouse Recruiting / Refer integration, you’ll need to create a Harvest API key.

Follow the steps in this article to create the key, and verify that the permissions below are selected when configuring the Refer integration.


In the Create New Credential box, make the following selections:

  • API Type: Harvest
  • Partner: Refer or Unlisted Vendor
  • Description: Refer Harvest API Key

When finished, click Manage permissions, or click Create to generate the API key and automatically assign it the appropriate permissions required by the integration.

After the key is created, click Copy. Paste the API key in a secure location to provide to the integration later.

Click I have stored the API Key.

Note: You can't access the full API key again after clicking I have stored the API Key. If you lose your API key and need to access it later, you must create a new API key, provide it to the integration, and then revoke access to the original key.


Verify that the following permissions are selected for the Refer integration:


  • GET: List Applications
  • GET: Retrieve Applications
  • POST: Add Application to Candidate/Prospect
  • POST: Add Attachment to Application
  • PATCH: Update Application


  • GET: Retrieve Candidate
  • GET: List Candidates
  • POST: Add Candidate
  • POST: Add Prospect
  • POST: Add Attachment
  • POST: Add Note
  • POST: Add Application
  • PATCH: Edit Candidate


  • GET: List Departments
  • GET: Retrieve Department

Job Posts

  • GET: List Job Posts
  • GET: Retrieve Job Post
  • GET: List Job Posts for Job
  • GET: Retrieve Job Post for Jobs
  • GET: Retrieve Custom Location

Job Stages

  • GET: List Job Stages for Job
  • GET: Retrieve Job Stage

Close Reasons

  • GET: Close Reasons

Activity Feed

  • GET: Retrieve Activity Feed


  • GET: List Jobs
  • GET: Retrieve Jobs
  • GET: Hiring Team


  • GET: List Offers for Application
  • GET: Retrieve Offer
  • GET: Retrieve Offer for Application

Rejection Reasons

  • GET: List Rejection Reasons


  • GET: List Offices
  • GET: Retrieve Offices


  • GET: List Scorecards for Application
  • GET: Retrieve Scorecard
  • GET: Retrieve Application’s Scorecard


  • GET: List Users

After saving your key permissions, your Harvest API key for the Greenhouse Recruiting / Refer integration is created and configured.

Store your Refer Harvest API key to input into Refer’s system and begin import.

Retrieve Greenhouse Recruiting User ID

In addition to the Harvest API key, Refer requires the user ID of a Site Admin user in your Greenhouse Recruiting account in order to post new applications & candidates. To get this ID, export your user list to locate and extract the 10-digit user ID from the downloaded spreadsheet. 

Note: To keep your integration resilient against individual shifts, use a general user ID (recruiting@ for example) instead of an individual's user ID. If one is not available, add a new user to create a unique user for use with your Refer integration in Greenhouse Recruiting.

Input this information where indicated on the Refer setup page.

Use the Refer integration with Greenhouse Recruiting

After inputting your API key and Site Admin user ID for into your Refer profile, the integration is ready for use.

To begin, import your open roles into Refer and set custom bounties for each role selected.

As referrals are submitted through your shareable social link and/or our marketplace, duplicate applications will be removed. Use your Refer employer profile to monitor referrals as they’re referred.

With a single click from your Refer profile, you can post referred candidates and applications into your Greenhouse instance to commence your standard interview flow. From there, the candidate application status will sync as referrals move through your interview pipeline. 

Key data such as relevant location and department tags and different profiles for individual recruiters is also ingested when using the integration allowing Refer to create a more relevant and unique experience for users, optimizing their overall hiring process. 

Additional resources

For additional information or troubleshooting not covered here, reach out to support@getreferred.co.