This article outlines how to configure a Greenhouse Harvest API for Crosschq Recruiting Analytics.
The user who configures the Greenhouse Harvest API key will need access to the Greenhouse dev center with permissions to manage API credentials.
In Greenhouse
- Navigate to the Dev Center, and select API Credential Management.
- Click on the blue "Create New API Key" button.
-
Fill out the fields:
-
API Type: Harvest
- Partner (if applicable): TalentWall
- Description: Crosschq Recruiting Analytics
(or something similar)
-
- Click Manage Permissions.
- Copy the API key and make sure to store it in a safe place. The key will need to be shared with Crosschq once fully configured. Afterward, click "I have stored the API Key."
- On the next page, under Manage Permissions, make sure the following permissions have been enabled at a minimum:
Activity Feed
- All permissionsApplications
- GET: Retrieve Application
- GET: List ApplicationsCandidates
- GET: Retrieve Candidate
- GET: List CandidatesClose Reasons
- GET: Get close reasonsCustom Field Options:
- GET: Custom field optionsCustom Fields:
- GET: Get custom fieldsDemographic Data
- All permissionsDepartments
- GET: Retrieve Department
- GET: List DepartmentsEEOC
- All permissionsJob Openings
- GET: List Openings For a JobJob Stages
- All permissionsJobs
- GET: Retrieve Job
- GET: List Jobs
- GET: Get hiring teamJob Posts
- GET: List Job Posts
- GET: Retrieve Job Post for Job
- GET: List Job Posts for JobOffers
- GET: List Application's Offers
- GET: Retrieve Application's Current Offer
- GET: Retrieve Offer
- GET: List OffersOffices
- GET: Retrieve Office
- GET: List OfficesProspect Pool
- All permissionsRejection Reasons
- All permissionsScheduled Interviews
- GET: List Interviews for Application
- GET: Retrieve Interview
- GET: List InterviewsScorecards
- All permissionsSources
- All permissionsTags
- GET: List tags applied to candidate
- GET: List Candidate TagsUser Roles
- All permissionsUsers
- GET: Retrieve User
- GET: List Users
- GET: List User Job Permissions
- GET: List User Future Job Permissions -
Once the above permissions have been enabled, click Save at the bottom of the page.
-
Share the API key with your onboarding resource at Crosschq.