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
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| clientId | Client ID | STRING | The Client ID of your Harvest V3 (OAuth) API credentials. | true |
| clientSecret | Client Secret | STRING | The Client Secret of your Harvest V3 (OAuth) API credentials. | true |
| tokenUrl | Token URL | STRING | The Greenhouse OAuth token endpoint. | true |
Connection Setup
Create Harvest V3 (OAuth) Credentials
- Log in to Greenhouse as a user who can manage API credentials.
- Open API Credentials.
- Click Create new API credentials.
- Select Harvest V3 (OAuth) and save the credential.
- Configure the scopes of the credential. This component needs
harvest:candidates:list,harvest:applications:list,harvest:scorecards:listandharvest:jobs:list. - Copy the Client ID and the Client Secret.
- 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
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| applicationId | Application ID | STRING | The 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
| Name | Type | Description |
|---|---|---|
| id | INTEGER | The ID of the application. |
| created_at | STRING | ISO 8601 timestamp for when the application was created. |
| updated_at | STRING | ISO 8601 timestamp for when the application was last updated. |
| candidate_id | INTEGER | The ID of the candidate this application belongs to. |
| job_id | INTEGER | The ID of the job this application is on. Null for jobless prospect applications. |
| job_post_id | INTEGER | The ID of the job post the candidate applied through. |
| recruiter_id | INTEGER | The ID of the user assigned as recruiter on the application's job. |
| coordinator_id | INTEGER | The ID of the user assigned as coordinator on the application's job. |
| referrer_id | INTEGER | The ID of the referrer credited with this application. |
| source_id | INTEGER | The ID of the source the application is attributed to. |
| rejection_reason_id | INTEGER | The ID of the rejection reason selected for the application. |
| stage_id | INTEGER | The ID of the interview stage the candidate is currently in. |
| job_interview_stage_id | INTEGER | The ID of the job interview stage definition of the current stage. |
| stage_name | STRING | The display name of the current interview stage. |
| status | STRING | The lifecycle status of the application: in_process, rejected, hired or converted. |
| needs_decision | BOOLEAN Optionstrue, false | Whether the application is waiting on a hiring team decision. |
| prospect | BOOLEAN Optionstrue, false | Whether this is a prospect application. |
| rejected_at | STRING | ISO 8601 timestamp for when the application was rejected. |
| last_activity_at | STRING | ISO 8601 timestamp of recent activity for the application's candidate. |
| location_address | STRING | The free-form location captured on the application. |
| answers | ARRAY Items[{STRING(question), STRING(answer)}] | The answers the candidate provided on the job post application form. |
| prospective_job_ids | ARRAY Items[INTEGER] | For prospect applications, the IDs of the jobs the prospect is considered for. |
| custom_fields | OBJECT 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
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| candidateId | Candidate ID | STRING | The 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
| Name | Type | Description |
|---|---|---|
| id | INTEGER | The ID of the candidate. |
| created_at | STRING | ISO 8601 timestamp for when the candidate was created. |
| updated_at | STRING | ISO 8601 timestamp for when the candidate was last updated. |
| first_name | STRING | The first name of the candidate. |
| last_name | STRING | The last name of the candidate. |
| preferred_name | STRING | The preferred name of the candidate. |
| company | STRING | The current company of the candidate. |
| title | STRING | The current job title of the candidate. |
| last_activity_at | STRING | ISO 8601 timestamp of the most recent activity on the candidate's applications. |
| private | BOOLEAN Optionstrue, false | Whether the candidate is private. |
| can_email | BOOLEAN Optionstrue, false | Whether the candidate has consented to receive email. |
| time_zone | STRING | The time zone of the candidate. |
| tags | ARRAY Items[STRING] | The tag names applied to the candidate. |
| linked_user_ids | ARRAY Items[INTEGER] | The IDs of Greenhouse users linked to the candidate. |
| phone_numbers | ARRAY Items[{STRING(value), STRING(type)}] | The phone numbers of the candidate. |
| addresses | ARRAY Items[{STRING(value), STRING(type)}] | The postal addresses of the candidate. |
| email_addresses | ARRAY Items[{STRING(value), STRING(type)}] | The email addresses of the candidate. |
| website_addresses | ARRAY Items[{STRING(value), STRING(type)}] | The website addresses of the candidate. |
| social_media_addresses | ARRAY Items[{STRING(value)}] | The social media addresses of the candidate. |
| custom_fields | OBJECT 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
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| jobId | Job ID | STRING | The 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
| Name | Type | Description |
|---|---|---|
| id | INTEGER | The ID of the job. |
| created_at | STRING | ISO 8601 timestamp for when the job was created. |
| updated_at | STRING | ISO 8601 timestamp for when the job was last updated. |
| name | STRING | The internal job title. |
| requisition_id | STRING | The external requisition identifier of the job. |
| notes | STRING | Internal HTML notes about the job. |
| confidential | BOOLEAN Optionstrue, false | Whether the job is confidential. |
| status | STRING | The lifecycle status of the job: draft, open or closed. |
| opened_at | STRING | ISO 8601 timestamp for when the job first transitioned to open. |
| closed_at | STRING | ISO 8601 timestamp for when the job most recently transitioned to closed. |
| is_template | BOOLEAN Optionstrue, false | Whether the job is a template. |
| copied_from_id | INTEGER | The ID of the job this job was copied from. |
| department_id | INTEGER | The ID of the department the job is assigned to. |
| external_department_id | STRING | The external ID of the department the job is assigned to. |
| office_ids | ARRAY Items[INTEGER] | The IDs of the offices the job is assigned to. |
| external_office_ids | ARRAY Items[STRING] | The external IDs of the offices the job is assigned to. |
| custom_fields | OBJECT 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
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| applicationId | Application ID | STRING | The ID of the application whose scorecards to list. | true |
| status | Status | STRING Optionscomplete, 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
| Name | Type | Description |
|---|---|---|
| id | INTEGER | The ID of the scorecard. |
| created_at | STRING | ISO 8601 timestamp for when the scorecard was created. |
| updated_at | STRING | ISO 8601 timestamp for when the scorecard was last updated. |
| application_id | INTEGER | The ID of the application the scorecard belongs to. |
| interview_kit_id | INTEGER | The ID of the interview kit the scorecard was filled out against. |
| interviewer_id | INTEGER | The ID of the user who participated in the interview. |
| submitter_id | INTEGER | The ID of the user who submitted the scorecard. |
| interviewed_at | STRING | ISO 8601 timestamp for when the interview took place. |
| submitted_at | STRING | ISO 8601 timestamp for when the scorecard was submitted. |
| status | STRING | The lifecycle status of the scorecard: draft or complete. |
| candidate_rating | STRING | The interviewer's overall recommendation. |
| notes | STRING | The key takeaways the interviewer recorded. |
| public_notes | STRING | The note the interviewer left for other interviewers. |
| private_notes | STRING | The 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