Gem Scheduling: Configure a Greenhouse API key

Overview

To integrate Greenhouse with Gem Scheduling, we utilize a Greenhouse API key to be able to sync the data across the two platforms. This article covers how to generate a Greenhouse API key and what API key permissions are required.

Requirements

• To be able to go through the rest of this guide, you’ll need the Developer permission Can manage ALL organization’s API Credentials.
• If you don’t have this permission, ask your Site Admin to give you this permission or ask your Site Admin to go through this guide themselves.

• If you’re not sure if you have this permission or not, you can attempt to continue with the guide, and we’ll let you know where you’d be able to confirm if you have it.

Generate a Greenhouse API key

Follow these steps to generate a Greenhouse API key:

1. In Greenhouse, select the gear icon in the top-right to get to the API Credentials page.

2. Select Dev Center in the left-hand sidebar. If you don’t see this as an option, you don’t have the necessary permissions (see above).

3. Select API Credential Management.

4. Select the Create New API Key button.

5. In the pop-up that appears, create a new Harvest API key with the following details:
1. API Type: Harvest (if you don’t have this as an option, you don’t have the necessary permissions. See the Requirements section above).
2. Partner: Leave blank or select unlisted vendor, if available.
3. Description: Set this as Gem Scheduling.
6. Once you’ve filled in the pop-up, select the Manage Permissions button. This will then show you the API key.
7. Copy your API key.

8. Select the I have stored the API Key button to configure the permissions for this new key.

Configure API key permissions

Once you’ve created the API key, you’ll be taken to the page to manage the permissions of this new key. For Gem Scheduling to function properly, you’ll need the following permissions:

• Applications:
• Get: List Applications: We use this to sync applications from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Candidates:
• Get: List Candidates: We use this to sync candidates from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Post: Add Note: We use this to make a note on a candidate’s activity feed when they’re scheduled or a schedule is cancelled.
• Post: Add E-mail: We use this to log all emails we send to a candidate on their activity feed.
• Users:
• Get: List Users: We use this to sync users from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Scheduled Interviews:
• Get: List Interviews for Application: We use this to find all scheduled interviews for an application and ensure that your scheduled interviews are accurate.
• Delete: Delete a scheduled interview: We use this to clear out scheduled interviews in Greenhouse so that interviewers don’t get reminders for cancelled schedules.
• Post: Create a scheduled interview: We use this to inform Greenhouse about scheduled interviews so that it can send out email reminders to the interviewers.
• Patch: Update a scheduled interview: We use this to update scheduled interviews when you edit an existing schedule.
• Activity Feed:
• Get: Retrieve Activity Feed: We use this to sync availabilities that candidates submit to Greenhouse.
• Jobs:
• Get: List Jobs: We use this to sync jobs from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Get: Retrieve Job: We use this to sync a specific job from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Job Posts:
• Get: List Job Posts: We use this to sync external job post names from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Get: Retrieve Job Post for Job: We used this to sync the external job post name for a specific job from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Job Stages:
• Get: List Job Stages: We use this to sync job stages from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Get: List Job Stages for Job: We use this to sync the job stages for a specific job from Greenhouse and keep the data in Gem Scheduling up-to-date.
• Offices:
• Get: List Offices: We use this to sync offices from Greenhouse and keep the data in Gem Scheduling up-to-date.

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.

• Overview
• Requirements
• Generate a Greenhouse API key
• Configure API key permissions