Skip to main content

How to transition your Guide instance to Greenhouse's V3 Harvest API

How to connect Guide to Greenhouse's new Harvest V3 API

In this article you'll learn how to transition from Greenhouse's old API connection to their new V3 Harvest version in under 10 minutes.

Note: the steps below should only be following once your Guide CSM enables the V3 transition workflow in your account.

Reconnect Greenhouse from your Guide integration dashboard

Guide authenticates with Greenhouse using the OAuth 2.0 authorization code flow. A Site Admin in Greenhouse authorizes Guide once from within Guide’s settings.


Prerequisites

  • You are a Site Admin in both Guide and Greenhouse Recruiting.

  • You have an active Guide account.

Step 1: Open the Integrations page in your Guide settings

  1. In Guide, go to Settings > Integrations.

  2. Locate the Greenhouse integration tile and click Connect.

Step 2: Authorize Guide on the Greenhouse permissions screen

  1. Make sure you are logged in to Greenhouse.

  2. [Recommended] Select the checkbox next to Authorize using a service account. This creates an org-level service account to own the authorization, so the integration keeps working if the authorizing employee later leaves the organization.

  3. Click Authorize.

Data Guide creates or updates in Greenhouse

As part of the integration, Guide takes action on the following Greenhouse objects:

  • Interviews - creates, updates, and removes interview events tied to a candidate’s application.

  • Candidates - creates, updates, and merges candidate records.

  • Applications - creates and updates applications and moves candidates between stages.

  • Notes and attachments - adds notes and files to the candidate record.

Field mapping

The table below maps fields between Guide and Greenhouse.

Guide field

Greenhouse field

Direction / Notes

Interview start time

starts_at

Guide → Greenhouse

Interview end time

ends_at

Guide → Greenhouse

Video conferencing URL

location

Guide → Greenhouse; conditional on conference link being set

Calendar event identifier

external_event_id

Guide → Greenhouse; used for deduplication

Interviewer Greenhouse user ID

interviewers[].user_id

Guide → Greenhouse

Interviewer response status

interviewers[].response_status

Guide → Greenhouse; one of needs_action, tentative, accepted, declined

Job interview template (remote ID)

job_interview_id

Guide → Greenhouse; create only

Application (remote ID)

application_id

Guide → Greenhouse; create only

Candidate first name

first_name

Guide → Greenhouse

Candidate last name

last_name

Guide → Greenhouse

Candidate email address(es) + type

email_addresses[].value + type

Guide → Greenhouse

Candidate phone number(s) + type

phone_numbers[].value + type

Guide → Greenhouse; replaces existing values

Candidate URL(s) + type

website_addresses[].value + type

Guide → Greenhouse; replaces existing values

Job (remote ID)

job_id

Guide → Greenhouse

Current pipeline stage (remote ID)

initial_stage_id (create) / to_stage_id (stage move)

Guide → Greenhouse

Default ATS source

source_id

Guide → Greenhouse; optional, org-level setting

Acting Greenhouse user

referrer_id

Guide → Greenhouse

Email subject

subject (note)

Guide → Greenhouse

Email body

body (note)

Guide → Greenhouse

Email from address

email_from (note)

Guide → Greenhouse

Email to address

email_to (note)

Guide → Greenhouse

File name

filename (attachment)

Guide → Greenhouse

File type classification

type - resume / cover_letter / other

Guide → Greenhouse

Admin-only visibility

visibility: "admin_only"

Guide → Greenhouse; applied to non-resume, non-cover-letter files

File content

content (base64)

Guide → Greenhouse

Use the Guide integration

Once Guide is authorized on Harvest V3, the integration runs automatically. The scenarios below cover the most common workflows.

For additional information not covered here, reach out to support@guide.co.

Did this answer your question?