ByteChef LogoByteChef

Greenhouse

Greenhouse is an applicant tracking system and hiring platform that helps companies manage job openings, candidates, applications and structured interview feedback.

Categories: Human Resources Information System

Type: greenhouse/v1


Connections

Version: 1

Harvest V3 (OAuth)

Properties

NameLabelTypeDescriptionRequired
clientIdClient IDSTRINGThe Client ID of your Harvest V3 (OAuth) API credentials.true
clientSecretClient SecretSTRINGThe Client Secret of your Harvest V3 (OAuth) API credentials.true
tokenUrlToken URLSTRINGThe Greenhouse OAuth token endpoint.true

Connection Setup

Create Harvest V3 (OAuth) Credentials

  1. Log in to Greenhouse as a user who can manage API credentials.
  2. Open API Credentials.
  3. Click Create new API credentials.
  4. Select Harvest V3 (OAuth) and save the credential.
  5. Configure the scopes of the credential. This component needs harvest:candidates:list, harvest:applications:list, harvest:scorecards:list and harvest:jobs:list.
  6. Copy the Client ID and the Client Secret.
  7. In ByteChef, paste them into the Client ID and Client Secret fields. Keep the default Token URL, https://auth.greenhouse.io/token.

ByteChef requests an access token with the OAuth 2.0 client credentials grant and sends it as a Bearer token to https://harvest.greenhouse.io/v3. Requests run as the integration service user that Greenhouse creates for the credentials.


Actions

Get Application

Name: getApplication

Get an application by ID, including its status, current stage, job and answers.

Properties

NameLabelTypeDescriptionRequired
applicationIdApplication IDSTRINGThe ID of the application to get.true

Example JSON Structure

{
  "label" : "Get Application",
  "name" : "getApplication",
  "parameters" : {
    "applicationId" : ""
  },
  "type" : "greenhouse/v1/getApplication"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGERThe ID of the application.
created_atSTRINGISO 8601 timestamp for when the application was created.
updated_atSTRINGISO 8601 timestamp for when the application was last updated.
candidate_idINTEGERThe ID of the candidate this application belongs to.
job_idINTEGERThe ID of the job this application is on. Null for jobless prospect applications.
job_post_idINTEGERThe ID of the job post the candidate applied through.
recruiter_idINTEGERThe ID of the user assigned as recruiter on the application's job.
coordinator_idINTEGERThe ID of the user assigned as coordinator on the application's job.
referrer_idINTEGERThe ID of the referrer credited with this application.
source_idINTEGERThe ID of the source the application is attributed to.
rejection_reason_idINTEGERThe ID of the rejection reason selected for the application.
stage_idINTEGERThe ID of the interview stage the candidate is currently in.
job_interview_stage_idINTEGERThe ID of the job interview stage definition of the current stage.
stage_nameSTRINGThe display name of the current interview stage.
statusSTRINGThe lifecycle status of the application: in_process, rejected, hired or converted.
needs_decisionBOOLEAN
Options true, false
Whether the application is waiting on a hiring team decision.
prospectBOOLEAN
Options true, false
Whether this is a prospect application.
rejected_atSTRINGISO 8601 timestamp for when the application was rejected.
last_activity_atSTRINGISO 8601 timestamp of recent activity for the application's candidate.
location_addressSTRINGThe free-form location captured on the application.
answersARRAY
Items [{STRING(question), STRING(answer)}]
The answers the candidate provided on the job post application form.
prospective_job_idsARRAY
Items [INTEGER]
For prospect applications, the IDs of the jobs the prospect is considered for.
custom_fieldsOBJECT
Properties {}
Custom field values of the application.

Output Example

{
  "id" : 1,
  "created_at" : "",
  "updated_at" : "",
  "candidate_id" : 1,
  "job_id" : 1,
  "job_post_id" : 1,
  "recruiter_id" : 1,
  "coordinator_id" : 1,
  "referrer_id" : 1,
  "source_id" : 1,
  "rejection_reason_id" : 1,
  "stage_id" : 1,
  "job_interview_stage_id" : 1,
  "stage_name" : "",
  "status" : "",
  "needs_decision" : false,
  "prospect" : false,
  "rejected_at" : "",
  "last_activity_at" : "",
  "location_address" : "",
  "answers" : [ {
    "question" : "",
    "answer" : ""
  } ],
  "prospective_job_ids" : [ 1 ],
  "custom_fields" : { }
}

Get Candidate

Name: getCandidate

Get a candidate by ID, including contact details, tags and custom fields.

Properties

NameLabelTypeDescriptionRequired
candidateIdCandidate IDSTRINGThe ID of the candidate to get.true

Example JSON Structure

{
  "label" : "Get Candidate",
  "name" : "getCandidate",
  "parameters" : {
    "candidateId" : ""
  },
  "type" : "greenhouse/v1/getCandidate"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGERThe ID of the candidate.
created_atSTRINGISO 8601 timestamp for when the candidate was created.
updated_atSTRINGISO 8601 timestamp for when the candidate was last updated.
first_nameSTRINGThe first name of the candidate.
last_nameSTRINGThe last name of the candidate.
preferred_nameSTRINGThe preferred name of the candidate.
companySTRINGThe current company of the candidate.
titleSTRINGThe current job title of the candidate.
last_activity_atSTRINGISO 8601 timestamp of the most recent activity on the candidate's applications.
privateBOOLEAN
Options true, false
Whether the candidate is private.
can_emailBOOLEAN
Options true, false
Whether the candidate has consented to receive email.
time_zoneSTRINGThe time zone of the candidate.
tagsARRAY
Items [STRING]
The tag names applied to the candidate.
linked_user_idsARRAY
Items [INTEGER]
The IDs of Greenhouse users linked to the candidate.
phone_numbersARRAY
Items [{STRING(value), STRING(type)}]
The phone numbers of the candidate.
addressesARRAY
Items [{STRING(value), STRING(type)}]
The postal addresses of the candidate.
email_addressesARRAY
Items [{STRING(value), STRING(type)}]
The email addresses of the candidate.
website_addressesARRAY
Items [{STRING(value), STRING(type)}]
The website addresses of the candidate.
social_media_addressesARRAY
Items [{STRING(value)}]
The social media addresses of the candidate.
custom_fieldsOBJECT
Properties {}
Custom field values of the candidate.

Output Example

{
  "id" : 1,
  "created_at" : "",
  "updated_at" : "",
  "first_name" : "",
  "last_name" : "",
  "preferred_name" : "",
  "company" : "",
  "title" : "",
  "last_activity_at" : "",
  "private" : false,
  "can_email" : false,
  "time_zone" : "",
  "tags" : [ "" ],
  "linked_user_ids" : [ 1 ],
  "phone_numbers" : [ {
    "value" : "",
    "type" : ""
  } ],
  "addresses" : [ {
    "value" : "",
    "type" : ""
  } ],
  "email_addresses" : [ {
    "value" : "",
    "type" : ""
  } ],
  "website_addresses" : [ {
    "value" : "",
    "type" : ""
  } ],
  "social_media_addresses" : [ {
    "value" : ""
  } ],
  "custom_fields" : { }
}

Get Job

Name: getJob

Get a job by ID, including its status, department, offices and custom fields.

Properties

NameLabelTypeDescriptionRequired
jobIdJob IDSTRINGThe ID of the job to get.true

Example JSON Structure

{
  "label" : "Get Job",
  "name" : "getJob",
  "parameters" : {
    "jobId" : ""
  },
  "type" : "greenhouse/v1/getJob"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGERThe ID of the job.
created_atSTRINGISO 8601 timestamp for when the job was created.
updated_atSTRINGISO 8601 timestamp for when the job was last updated.
nameSTRINGThe internal job title.
requisition_idSTRINGThe external requisition identifier of the job.
notesSTRINGInternal HTML notes about the job.
confidentialBOOLEAN
Options true, false
Whether the job is confidential.
statusSTRINGThe lifecycle status of the job: draft, open or closed.
opened_atSTRINGISO 8601 timestamp for when the job first transitioned to open.
closed_atSTRINGISO 8601 timestamp for when the job most recently transitioned to closed.
is_templateBOOLEAN
Options true, false
Whether the job is a template.
copied_from_idINTEGERThe ID of the job this job was copied from.
department_idINTEGERThe ID of the department the job is assigned to.
external_department_idSTRINGThe external ID of the department the job is assigned to.
office_idsARRAY
Items [INTEGER]
The IDs of the offices the job is assigned to.
external_office_idsARRAY
Items [STRING]
The external IDs of the offices the job is assigned to.
custom_fieldsOBJECT
Properties {}
Custom field values of the job.

Output Example

{
  "id" : 1,
  "created_at" : "",
  "updated_at" : "",
  "name" : "",
  "requisition_id" : "",
  "notes" : "",
  "confidential" : false,
  "status" : "",
  "opened_at" : "",
  "closed_at" : "",
  "is_template" : false,
  "copied_from_id" : 1,
  "department_id" : 1,
  "external_department_id" : "",
  "office_ids" : [ 1 ],
  "external_office_ids" : [ "" ],
  "custom_fields" : { }
}

List Scorecards for Application

Name: listApplicationScorecards

List the scorecards of an application, including the overall recommendation, notes and interviewer.

Properties

NameLabelTypeDescriptionRequired
applicationIdApplication IDSTRINGThe ID of the application whose scorecards to list.true
statusStatusSTRING
Options complete, draft
Return only scorecards with this status. Complete scorecards are submitted feedback, draft scorecards are autosaved working copies. Leave empty to return both.false

Example JSON Structure

{
  "label" : "List Scorecards for Application",
  "name" : "listApplicationScorecards",
  "parameters" : {
    "applicationId" : "",
    "status" : ""
  },
  "type" : "greenhouse/v1/listApplicationScorecards"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

NameTypeDescription
idINTEGERThe ID of the scorecard.
created_atSTRINGISO 8601 timestamp for when the scorecard was created.
updated_atSTRINGISO 8601 timestamp for when the scorecard was last updated.
application_idINTEGERThe ID of the application the scorecard belongs to.
interview_kit_idINTEGERThe ID of the interview kit the scorecard was filled out against.
interviewer_idINTEGERThe ID of the user who participated in the interview.
submitter_idINTEGERThe ID of the user who submitted the scorecard.
interviewed_atSTRINGISO 8601 timestamp for when the interview took place.
submitted_atSTRINGISO 8601 timestamp for when the scorecard was submitted.
statusSTRINGThe lifecycle status of the scorecard: draft or complete.
candidate_ratingSTRINGThe interviewer's overall recommendation.
notesSTRINGThe key takeaways the interviewer recorded.
public_notesSTRINGThe note the interviewer left for other interviewers.
private_notesSTRINGThe private notes, visible only to users allowed to see private notes.

Output Example

[ {
  "id" : 1,
  "created_at" : "",
  "updated_at" : "",
  "application_id" : 1,
  "interview_kit_id" : 1,
  "interviewer_id" : 1,
  "submitter_id" : 1,
  "interviewed_at" : "",
  "submitted_at" : "",
  "status" : "",
  "candidate_rating" : "",
  "notes" : "",
  "public_notes" : "",
  "private_notes" : ""
} ]

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

How is this guide?

Last updated on

On this page