Greenhouse API Reference

The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_ in their names. Public API procedures do not have such prefix in their names.

ActivityFeed

A candidate’s activity feed
Parameter
<candidate_id> (optional): Candidate Id
<candidate_table> (optional): Table with id of the candidates
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
feed	string	Note, email or activity
id	string	The internal Greenhouse ID of the activity feed note
created_at	timestamp	Timestamp indicating when this feed resource is created
subject	string	Subject
to	string	Email to
from	string	Email from
cc	string	Email cc
body	string	body of the feed
user_id	string	User id
user_first_name	string	User first name
user_last_name	string	User last name
user_name	string	User name
user_employee_id	string	Employee id
private	boolean	Is private
visibility	boolean	Visibility

Example

SQL

CREATE VIEW greenhouse_examples.example_ActivityFeed
AS 
SELECT * FROM greenhouse.ActivityFeed (
	preview => TRUE
)

Applications

Applications
Parameter
<application_id> (optional): Return single application, rather than list
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The application's unique identifier
candidate_id	string	The candidate's unique identifier
prospect	boolean	This is a prospect application which means that the associated person is a prospect and has not yet applied for this job
applied_at	timestamp	Timestamp indicating when this resource is applied
rejected_at	timestamp	Timestamp indicating when this resource is rejected
last_activity_at	timestamp	Timestamp indicating when this resource is last activity
location_address	string	The contents of the location question on a job post
source_id	string	The source's unique identifier
source_public_name	string	The source's public name
credited_to_id	string	The ID of the user who will receive credit for this application
credited_to_first_name	string	The first name of the user who will receive credit for this application
credited_to_last_name	string	The last name of the user who will receive credit for this application
credited_to_name	string	The name of the user who will receive credit for this application
credited_to_employee_id	string	The employee id of the user who will receive credit for this application
rejection_reason_id	string	The ID of the rejection reason
rejection_reason_name	string	The name of the rejection reason
rejection_reason_type_id	string	The type ID of the rejection reason
rejection_reason_type_name	string	The type name of the rejection reason
job_post_id	string	The ID of the job post through which the candidate applied
status	string	The status of the application
current_stage_id	string	The ID of the current stage
current_stage_name	string	The name of the current stage

Example

SQL

CREATE VIEW greenhouse_examples.example_Applications
AS 
SELECT * FROM greenhouse.Applications (
	preview => TRUE
)

Approvals

Approvals For Job
Parameter
<job_id> (optional): Job Id
<job_table> (optional): The table with job data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
job_id	string	The job's unique identifier
id	string	The approval's unique identifier
offer_id	string	Offer id
sequential	boolean	Sequential
version	bigdecimal	The specific version of this flow
approval_type	string	The approval type
approval_status	string	The approval_status
requested_by_user_id	string	The user who requested this approval be started

Example

SQL

CREATE VIEW greenhouse_examples.example_Approvals
AS 
SELECT * FROM greenhouse.Approvals (
	preview => TRUE
)

CandidateTags

Candidate Tags
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The candidate tag's unique identifier
name	string	The name of the tag

Example

SQL

CREATE VIEW greenhouse_examples.example_CandidateTags
AS 
SELECT * FROM greenhouse.CandidateTags (
	preview => TRUE
)

Candidates

Candidates
Parameter
<candidate_id> (optional): Return single candidate, rather than list
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The candidate's unique identifier
first_name	string	First name of the candiate
last_name	string	Last name of the candiate
company	string	The company at which the candidate currently works
title	string	The candidate's current title
is_private	boolean	Whether the candidate is private or not
created_at	timestamp	Timestamp indicating when this candidate resource is created
updated_at	timestamp	Timestamp indicating when this candidate resource is updated
last_activity	timestamp	Timestamp indicating when was last activity
recruiter_id	string	The recruiter's unique identifier
recruiter_first_name	string	First name of the recruiter
recruiter_last_name	string	Last name of the recruiter
recruiter_name	string	Name of the recruiter
recruiter_employee_id	string	The recruiter's employee unique identifier
coordinator_id	string	The coordinator's unique identifier
coordinator_first_name	string	First name of the coordinator
coordinator_last_name	string	Last name of the coordinator
coordinator_name	string	Name of the coordinator
coordinator_employee_id	string	The coordinator's employee unique identifier
can_email	boolean	Can email

Example

SQL

CREATE VIEW greenhouse_examples.example_Candidates
AS 
SELECT * FROM greenhouse.Candidates (
	preview => TRUE
)

CloseReasons

List all of an organization’s close reasons
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The close reason's unique identifier
name	string	The name of the close reason

Example

SQL

CREATE VIEW greenhouse_examples.example_CloseReasons
AS 
SELECT * FROM greenhouse.CloseReasons (
	preview => TRUE
)

CustomFields

CustomFields
Parameter
<field_type> (required): Field type, one of: offer, candidate, application, job, rejection_question, referral_question, user_attribute
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The custom field's unique identifier
name	string	The field's name in Greenhouse
active	boolean	Boolean value which is false if the custom field has been deleted, true otherwise
field_type	string	Field type
priority	integer	Numeric field used for ordering in Greenhouse
value_type	string	The type of the value
private	boolean	If this field is private in Greenhouse
required	boolean	The object this field exists on can not be saved if this value is not set
require_approval	boolean	Only applicable to job and opening custom fields, changes to this fields requires an approval flow in Greenhouse to be re-done
trigger_new_version	boolean	Only applicable to offer custom fields, changes to this field creates a new offer version
name_key	string	This value is based of the name of the field when it is created
description	string	Description
expose_in_job_board_api	boolean	Only relevant for Job custom fields. If true, then the field will be shown in the Job Board API
api_only	boolean	Only relevant for Job custom fields. If true, this custom field can only be edited from the API
template_token_string	string	Token string used in email and offer document templates

Example

SQL

CREATE VIEW greenhouse_examples.example_CustomFields
AS 
SELECT * FROM greenhouse.CustomFields (
	field_type => 'offer',
	preview => TRUE
)

Degrees

Degrees
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the degree
name	string	The name of the degree
priority	integer	Priority
external_id	string	External id

Example

SQL

CREATE VIEW greenhouse_examples.example_Degrees
AS 
SELECT * FROM greenhouse.Degrees (
	preview => TRUE
)

Departments

Departments
Parameter
<department_id> (optional): Department Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the department
name	string	The name of the department
parent_id	string	Parent id
parent_department_external_id	string	The external_id of this department's parent
external_id	string	An arbitrary ID provided by an external source

Example

SQL

CREATE VIEW greenhouse_examples.example_Departments
AS 
SELECT * FROM greenhouse.Departments (
	 preview => TRUE
)

Disciplines

Disciplines
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the degree
name	string	The name of the degree
priority	integer	Priority

Example

SQL

CREATE VIEW greenhouse_examples.example_Disciplines
AS 
SELECT * FROM greenhouse.Disciplines (
	 preview => TRUE
)

EEOC

All of an organization’s EEOC data
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
application_id	string	Application id
candidate_id	string	Candidate id
race_id	integer	Race id
race_description	string	Race description
gender_id	integer	Gender id
gender_description	string	Gender description
veteran_status_id	integer	Veteran status id
veteran_status_message	string	Veteran status message
disability_status_id	integer	Disability status id
disability_status_description	string	Disability status description
submitted_at	timestamp	Timestamp indicating when this EEOC data is submitted

Example

SQL

CREATE VIEW greenhouse_examples.example_EEOC
AS 
SELECT * FROM greenhouse.EEOC (
	 preview => TRUE
)

EmailTemplates

Email Templates
Parameter
<email_template_id> (optional): Email template Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the email template
name	string	The name of the email template
default	boolean	Default
created_at	timestamp	Timestamp indicating when this email template is created
updated_at	timestamp	Timestamp indicating when this email template is updated
description	string	Description
type	string	Type
from	string	Email from
cc	string	Email copy to
body	string	Email body
html_body	string	Email html body
user_id	string	The user's unique identifier
user_first_name	string	First name of the user
user_last_name	string	Last name of the user
user_name	string	Name of the user
user_employee_id	string	The user's employee unique identifier

Example

SQL

CREATE VIEW greenhouse_examples.example_EmailTemplates
AS 
SELECT * FROM greenhouse.EmailTemplates (
	 preview => TRUE
)

JobOpenings

Job Openings
Parameter
<job_id> (optional): Job Id
<job_table> (optional): The table with job data
<status> (optional): The status of the job opening
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
job_id	string	The job's unique identifier
id	string	The opening's unique identifier
opening_id	string	This is a text string used to identify the opening
status	string	The status of the job opening
opened_at	timestamp	Timestamp indicating when this job opening is opened
closed_at	timestamp	Timestamp indicating when this job opening is closed
application_id	string	The application that was used to fill this opening
close_reason_id	string	Close reason id
close_reason_name	string	Close reason name

Example

SQL

CREATE VIEW greenhouse_examples.example_JobOpenings
AS 
SELECT * FROM greenhouse.JobOpenings (
	 preview => TRUE
)

JobPosts

Job Posts
Parameter
<job_id> (optional): Job Id
<live> (optional): If true, return only live job posts
<active> (optional): If true, only return active job posts. If false, only return deleted job posts
<full_content> (optional): If true, returns the board introduction, description, pay transparency ranges, and board conclusion as one content or internal_content element
<internal> (optional): If true, only return internal job posts. If false, only return external job posts
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	Job post ID
title	string	The title of the job post
location_name	string	Location name
location_id	string	Location id
location_office_id	string	Location office id
location_job_post_location_type_id	string	Location job post location type id
location_job_post_location_type_name	string	Location job post location type name
internal	boolean	If true, this job post has been posted on an internal job
external	boolean	If true, this job post has been posted on an external job
active	boolean	If false, this job post has been deleted
live	boolean	If true, this job post status is set to live
first_published_at	timestamp	Timestamp indicating when this job post is first published
job_id	string	Job ID
content	string	The text of the job post as posted to the external job board
internal_content	string	The text of the job post if posted to the internal job board, if different than the external job board
created_at	timestamp	Timestamp indicating when this job post is created
updated_at	timestamp	Timestamp indicating when this job post is updated
demographic_question_set_id	string	The demographic question set associated with this job post

Example

SQL

CREATE VIEW greenhouse_examples.example_JobPosts
AS 
SELECT * FROM greenhouse.JobPosts (
	 preview => TRUE
)

JobStages

Job Stages
Parameter
<job_id> (optional): Job Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
job_id	string	Job ID
id	string	Job stage ID
name	string	The name for this job stage
created_at	timestamp	Timestamp indicating when this job stage is created
updated_at	timestamp	Timestamp indicating when this job stage is updated
priority	integer	Numeric field used for ordering

Example

SQL

CREATE VIEW greenhouse_examples.example_JobStages
AS 
SELECT * FROM greenhouse.JobStages (
	 preview => TRUE
)

Jobs

Jobs
Parameter
<job_id> (optional): Job Id
<status> (optional): If included, will return only the jobs in this specific status
<department_id> (optional): If included, will return only the jobs in this specific department
<office_id> (optional): If included, will return only the jobs in this specific office
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The job's unique identifier
name	string	The name of the job
requisition_id	string	An arbitrary ID provided by an external source
notes	string	Notes
confidential	boolean	If the job is confidential or not
is_template	boolean	Is this job designated as a template used to create other jobs
copied_from_id	string	If this job was copied from another job
status	string	Status of the job
created_at	timestamp	Timestamp indicating when this job is created
updated_at	timestamp	Timestamp indicating when this job is updated
opened_at	timestamp	Timestamp indicating when this job is opened
closed_at	timestamp	Timestamp indicating when this job is closed

Example

SQL

CREATE VIEW greenhouse_examples.example_Jobs
AS 
SELECT * FROM greenhouse.Jobs (
	 preview => TRUE
)

Offers

Offers
Parameter
<offer_id> (optional): Offer Id
<status> (optional): If included, will return only the offers in this specific status
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The offer's unique identifier
version	integer	The version number of this offer
application_id	string	The ID of the associated application
job_id	string	The job's unique identifier
candidate_id	string	The candidate's unique identifier
opening_id	string	The opening's unique identifier
opening_opening_id	string	This is a text string used to identify the opening
opening_status	string	The status of the job opening
opening_opened_at	timestamp	Timestamp indicating when this job opening is opened
opening_closed_at	timestamp	Timestamp indicating when this job opening is closed
opening_application_id	string	The application that was used to fill this opening
opening_close_reason_id	string	Close reason id of the job opening
opening_close_reason_name	string	Close reason name of the job opening
created_at	timestamp	Timestamp indicating when this offer is created
updated_at	timestamp	Timestamp indicating when this offer is updated
sent_at	date	Date when this offer was sent to the candidate
resolved_at	timestamp	Date when this offer was resolved
starts_at	date	Date when the candidate starts
status	string	Status of the offer

Example

SQL

CREATE VIEW greenhouse_examples.example_Offers
AS 
SELECT * FROM greenhouse.Offers (
	 preview => TRUE
)

Offices

Offices
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The office's unique identifier
name	string	The name of the office
location_name	string	The name of the close reason
primary_contact_user_id	string	Primary contact user id
parent_id	string	Parent id
parent_office_external_id	string	Parent office external id
external_id	string	An arbitrary ID provided by an external source

Example

SQL

CREATE VIEW greenhouse_examples.example_Offices
AS 
SELECT * FROM greenhouse.Offices (
	 preview => TRUE
)

ProspectPools

Prospect Pools
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the degree
name	string	The name of the degree
active	boolean	Active
prospect_stages_id	string	Prospect stages id
prospect_stages_name	string	Prospect stages name

Example

SQL

CREATE VIEW greenhouse_examples.example_ProspectPools
AS 
SELECT * FROM greenhouse.ProspectPools (
	 preview => TRUE
)

RejectionReasons

Rejection Reasons
Parameter
<include_defaults> (optional): If true, this will also return Greenhouse’s default rejection reasons
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the degree
name	string	The name of the degree
type_id	string	Prospect stages id
type_name	string	Prospect stages name

Example

SQL

CREATE VIEW greenhouse_examples.example_RejectionReasons
AS 
SELECT * FROM greenhouse.RejectionReasons (
	 preview => TRUE
)

ScheduledInterviews

Scheduled Interviews
Parameter
<scheduled_interview_id> (optional): Job Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The scheduled interview's unique identifier
application_id	string	The application's unique identifier
external_event_id	string	An arbitrary ID provided by an external source
start_date_time	timestamp	A date_time value if this interview has a precise start time
end_date_time	timestamp	A date_time value if this interview has a precise end time
location	string	The location of the interview
video_conferencing_url	string	The URL used for video interviews
status	string	Status of the scheduled interview
created_at	timestamp	Timestamp indicating when this scheduled interview is created
updated_at	timestamp	Timestamp indicating when this scheduled interview is updated
interview_id	string	Interview Id
interview_name	string	The name of the interview
organizer_id	string	The organizer's unique identifier
organizer_first_name	string	First name of the organizer
organizer_last_name	string	Lasr name of the organizer
organizer_name	string	Name of the organizer
organizer_employee_id	string	The organizer's employee unique identifier

Example

SQL

CREATE VIEW greenhouse_examples.example_ScheduledInterviews
AS 
SELECT * FROM greenhouse.ScheduledInterviews (
	 preview => TRUE
)

Schools

Schools
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the degree
name	string	The name of the degree
priority	integer	Priority

Example

SQL

CREATE VIEW greenhouse_examples.example_Schools
AS 
SELECT * FROM greenhouse.Schools (
	 preview => TRUE
)

Scorecards

Scorecards
Parameter
<scorecard_id> (optional): Scorecard Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The scorecard's unique identifier
created_at	timestamp	Timestamp indicating when this scorecard is created
updated_at	timestamp	Timestamp indicating when this scorecard is updated
interview	string	Interview
interview_step_id	string	Id of the interview step
interview_step_name	string	The name of the interview step
candidate_id	string	The candidate's unique identifier
application_id	string	The application's unique identifier
interviewed_at	timestamp	Timestamp indicating when interviewed
submitted_by_id	string	The user' unique identifier who submitted this scorecard
submitted_by_first_name	string	The user' first name who submitted this scorecard
submitted_by_last_name	string	The user' lasr name who submitted this scorecard
submitted_by_name	string	The user' name who submitted this scorecard
submitted_by_employee_id	string	The user's employee unique identifier
interviewer_id	string	The interviewer's unique identifier
interviewer_first_name	string	First name of the interviewer
interviewer_last_name	string	Lasr name of the interviewer
interviewer_name	string	Name of the interviewer
interviewer_employee_id	string	The interviewer's employee unique identifier
submitted_at	timestamp	Timestamp indicating when this scorecard is submitted
overall_recommendation	string	Overall recommendation

Example

SQL

CREATE VIEW greenhouse_examples.example_Scorecards
AS 
SELECT * FROM greenhouse.Scorecards (
	 preview => TRUE
)

Sources

Sources
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the degree
name	string	The name of the degree
type_id	string	Prospect stages id
type_name	string	Prospect stages name

Example

SQL

CREATE VIEW greenhouse_examples.example_Sources
AS 
SELECT * FROM greenhouse.Sources (
	 preview => TRUE
)

UserRoles

User Roles
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the user role
name	string	The name of the user role
type	string	The type of the user role

Example

SQL

CREATE VIEW greenhouse_examples.example_UserRoles
AS 
SELECT * FROM greenhouse.UserRoles (
	 preview => TRUE
)

Users

Users
Parameter
<user_id> (optional): User Id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label

Attribute	Type	Description
id	string	The internal Greenhouse ID of the user
name	string	The name of the user
first_name	string	The first name of the user
last_name	string	The last name of the user
primary_email_address	string	The primary email address of the user
updated_at	timestamp	Timestamp indicating when this user is updated
created_at	timestamp	Timestamp indicating when this user is created
disabled	boolean	Disabled
site_admin	boolean	Is site admin
emails	string	Emails
employee_id	string	Employee id

Example

SQL

CREATE VIEW greenhouse_examples.example_Users
AS 
SELECT * FROM greenhouse.Users (
	 preview => TRUE
)