Recruitment Marketing Public

Greenhouse Harvest v3 is the current API version for the Recruitment Marketing (RM) integration. This version utilizes OAuth 2.0 to provide enhanced security and seamless data transfer between Greenhouse and PageUp.

Generating a Harvest v3 API key

1. On your Greenhouse account, navigate to Configure > Dev Center > API credentials.
2. Click on the Create new API credentials button.
3. Select "Harvest V3 (OAuth)" from the API type drop-down menu.
4. Enter a description for this key.
5. Click on the View and store credentials button.
6. Copy your Client key and Client secret and keep the latter in a safe place. You will need them later.
7. Once you have copied the credentials, click on the "I have stored the client credentials" button to close the dialog.
8. Manage scopes: We require permissions for the following areas of Harvest:
   1. Applications > List applications
   2. Attachments > List attachments
   3. Candidate educations > List candidate educations
   4. Candidate employments > List candidate employments
   5. Candidates > List candidates
   6. Custom field options > List custom field options
   7. Custom fields > List custom fields
   8. Demographic answer options > List demographic answer options
   9. Demographic question sets > List demographic question sets
   10. Demographic questions > List demographic questions
   11. Departments > List departments
   12. Job hiring managers > List job hiring managers
   13. Job owners > List job owners
   14. Job post locations > List job post locations
   15. Job posts > List job posts
   16. Jobs > List jobs
   17. Offices > List offices
   18. Openings > List openings
   19. Pay input ranges > List pay input ranges
   20. Pay inputs > List pay inputs
   21. User emails > List user emails
   22. Users > List users
9. Click Save.

Creating a Greenhouse v3 integration

The steps to create a new Greenhouse integration are fully explained in the Greenhouse article. You will need to select "v3" from the drop-down menu (see screenshot below) and add your Harvest v3 API key in the "Harvest API key" textbox. The rest of the steps will be the same.

Authorizing with Greenhouse

Once your new integration has been created, you will be able to see it in the list of ATS integrations in RM. For v3 integrations, there will be an extra icon in the Actions menu which you will need to use in order to connect with Greenhouse.

When you click on the plug icon, you will be redirected to Greenhouse to initiate the authorization process. You will see a list of scopes (endpoints) that you will be given us access to, which should match the scopes you selected when generating the Harvest v3 API key. You will need to log into Greenhouse by entering your email address and clicking on the button as per screenshot below. We recommend that the person performing this action has Admin privileges in Greenhouse.

If the person logging in is a Greenhouse Admin, you will see another screen with a checkbox asking to authorize using a service account, which is what we recommend, so tick that box and click on "Authorize".

Once the authorization process has succeeded, you will be redirected to the ATS integration list page in RM with a message of "Greenhouse ATS integration connected successfully". The actions menu will show a success tick, meaning the integration is fully connected to Greenhouse.

After this authorization process has been completed, you can start importing jobs and/or candidates regularly.

For further information, you can refer to this Greenhouse's support article on Harvest v3 integrations.