Skip to main content

List of Harvest API Permissions

Greenhouse setup

Shanie Grancioso avatar
Written by Shanie Grancioso
Updated today

An easy-to-understand guide to the different permissions you need to use the Harvest API, explaining what each one lets you do and what information you can access.

Groups

Permission Details

Applications

Get: Retrieve Applications

  • Sapia.ai uses this permission to query the candidate’s status and rejection reason for up to 90 days after the application.

Patch: Update Application

  • Sapia.ai uses this permission to update the application’s custom fields upon completion of Sapia.ai.

Post: Advance Applications

Candidates

Get: Retrieve Candidate

  • Sapia.ai uses this permission to get the candidate’s address/location.

Post: Add note

  • Sapia.ai uses this permission to add notes to the candidate’s profile (displaying Sapia.ai results and updates).

Users

Get: Retrieve User

  • Sapia uses this permission to retrieve the email addresses of hiring managers and recruiters (for permission management).

EEOC

Get: Retrieve EEOC Data for Application

  • Sapia.ai uses this permission for bias testing, including compliance with NYC Law 144.

Job

Get: Retrieve Jobs

  • Sapia.ai uses this permission to retrieve the job ID, job title, and job location.

Job Stages

Get: Retrieve Job Stage

  • Sapia.ai uses this permission to retrieve the job stage using the ID.

Get: List Job Stages

  • Sapia.ai uses this permission to query all job stages set up for your organization.

Get: List Job Stages for Job

  • Sapia.ai uses this permission to query all job stages for a particular job.

Custom Fields

Get: Get custom fields

  • Sapia.ai uses this permission to query the custom field’s unique ID (required for PATCH calls).

Post: Create custom field

  • Sapia.ai uses this permission to create custom fields designed to store Sapia.ai scores, ratings, and URLs.

Patch: Update custom field

  • Sapia.ai uses this permission to correct typos or other errors when creating custom fields.

Delete: Delete custom field

  • Sapia.ai uses this permission to delete custom fields it created or upon customer request.

Did this answer your question?