Greenhouse

A greenhouse is a software that provides recruiting software as a service. It collects the job seekers' applications from different routes like employment websites and referrals into one dashboard. It’s an open platform that uses an API to facilitate aggregation.

1 Authorization
- 1.1 Basic Auth
- 1.2 OAuth 2.0
2 Greenhouse Connections
- 2.1 Greenhouse Basic Connection
- 2.2 Greenhouse OAuth2.0 Connection
3 Actions
- 3.1 Get user by Id
- 3.2 Get candidates by ID
- 3.3 Get departments by Id
- 3.4 Get Jobs by ID
- 3.5 Get Application
- 3.6 Get Jobs
- 3.7 Get all users
- 3.8 Get all candidates
- 3.9 Get all Departments
- 3.10 Create user in Greenhouse
- 3.11 Update User in Green House
- 3.12 Create User
- 3.13 Update User

Authorization

This API offers two methods of authentication: OAuth 2.0 and Basic Auth.

Basic Auth

If you select Basic Auth, you will need to supply the Greenhouse email and an API token to the credential. For information on generating an API, token refers to the Greenhouse document.

OAuth 2.0

The preferred authentication method is OAuth2.0 for the Greenhouse in Sapper account. In this case, you would place an integration option on our website which would allow you to authenticate into Greenhouse via the Sapper application. If you select OAuth2.0, you need to enable it for your app using the developer console. When you create your Greenhouse app, you must be sure to enter Sapper's OAuth callback URL -Sapper. Consult Greenhouse to determine the proper OAuth Scopes to assign to the credential.

Now, you can configure OAuth2.0 settings in Sapper. Create a new connection and enter the following information:

Application name: The name of the application as it would appear in Greenhouse.

Application URL: The URL to the primary application.

Callback URL: This is the URL to which Greenhouse will send authenticated users.

Logo image: This is a 128x128 image that will be included in the permissions modal.

When Greenhouse receives this information, they will supply the partner with a consumer key, a consumer secret, a token URL, and an authorized URL.

Greenhouse Connections

Greenhouse Basic Connection

Input	Key	Description	Example
Select application	application	Select Greenhouse application
Connection type	connection type	Select the type of connection.	REST
Rest connection type	Rest Connection Type	Select the Basic connection type	Basic
Connection name	name	Provide a name for the connection.	Greenhouse
Connection description	description	Provide a description for the connection.
Host name	host	Provide a string value for the URL of the user's Greenhouse account.
Username	username	Provide a valid username for the given Greenhouse account.	exampleUser
Password	password	Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value.	exampleSecurePassword
Header field	header	Provide the path of the endpoint for authentication.	Authorization
Header prefix header	header prefix	Select the header prefix - Basic, Bearer, Token, None

Greenhouse OAuth2.0 Connection

Input	Key	Description	Example
Select application	application	Select Greenhouse application
Connection type	connection type	Select the type of connection.	REST
REST connection type	rest connection type	Select the type of REST connection.	OAuth2.0
Connection name	name	Provide a name for the connection.	Greenhouse connection
Connection description	description	Provide a description for the connection.
Host name	host	Provide a string value for the URL of the user's Greenhouse account.
Grant type	grant type	Provide the grant type - authorization code, password, client credentials.

Actions

Get user by Id

Get information and meta data about all users | key: getUserbyID

Input	Key	Description	Example

Input	Key	Description	Example
User id	userID	The user Id for the object	John@123

Get candidates by ID

Get information of all candidates by id | key: getCandidatesbyID

Input	Key	Description	Example

Input	Key	Description	Example
Candidates id	candidatesID	Provide the candidate id.	1234

Get departments by Id

Get departments information| key: getdepartmentsbyID

Input	Key	Description	Example

Input	Key	Description	Example
Department id	departmentID	Provide the department Id	123
Render as	renderAs	Mention the render pattern for the information's	List or Tree

Get Jobs by ID

Provide the information of Jobs| key: getjobsbyID

Input	Key	Description	Example

Input	Key	Description	Example
Job id	JobID	Provide the Job id	6248

Get Application

Get information about application List | key: getApplications

Input	Key	Description	Example

Input	Key	Description	Example
Status	status	Mention the status of the job application	Hired/rejected

Get Jobs

Get jobs | key: Getjobs

Get all users

Get all users | key: Getallusers

Get all candidates

Get all candidates | key: GetallCandidates

Get all Departments

Get all departments | key: Getalldepartments

Create user in Greenhouse

Get user in Greenhouse | key: GetuserinGreenhouse

Input	Key	Description	Example

Input	Key	Description	Example
First name	firstName	Provide the first name of the user.	John
Last name	LastName	Provide the last name of the user.	Smith
Company	company	Mention the name of the company.	Sapper
Title	title	Provide a title for the user.	Sample
Is private	is private	Mention the privacy state.	It can be “True” or “False”
Phone numbers	phoneNumbers	Provide the phone number.	‎+12163547758
Applications	applications	Mention the applications information.	Sample
On behalf of	onbehalfOf	Provide the reference id of the Greenhouse user.	Js10Q1

Update User in Green House

Update user in Greenhouse | key: UpdateuserinGreenhouse

Input	Key	Description	Example

Input	Key	Description	Example
Candidate Id	candidateID	It is a unique id of the user.
On behalf of	onbehalfOf	Provide the reference id of the Greenhouse user.	Js10Q1
First Name	firstName	Provide the first name of the user.	John
Last Name	LastName	Provide the last name of the user.	Smith
Job Title	jobTitle	A job title is a name that describes someone's job or position at work.
Phone numbers	phoneNumbers	Provide the phone number.	‎+12163547758
Addresses	addresses	Addresses is a place where a person or organization may be communicated with asked for her name, address, and phone number.
Email Addresses	emailID	Email id is an unique address of the users used for sending emails.	jsmith@example.com.
Website Addresses	websiteAddresses	The web address contains information about the location of the webpage. It is also known as the URL (uniform resource locator).	http://www.example.com/index.html
Social Media Addresses	socialmediaAddresses	A social media address is a public username used on social media accounts.
Recruiter	recruiter	Recruiter is a person whose job is to enroll people as employees, in the armed forces, or as members of an organization.
Coordinators	coordinators	Coordinators is a person who is responsible for organizing different things or people so that they work together
Tags	tags	Tags provide details about an item and make it easy to locate related items that have the same tag.
Custom field	customField	Custom fields, also referred to as post meta, is a feature in WordPress which allows users to add additional information when writing a post.

Create User

Create user | key: createUser

Input	Key	Description	Example

Input	Key	Description	Example
On behalf of	onbehalfOf	Provide the reference id of the Greenhouse user.	Js10Q1
First name	firstName	Provide the first name of the user.	John
Last name	LastName	Provide the last name of the user.	Smith
Email Id	emailID	Email id is an unique address of the users used for sending emails.	jsmith@example.com.
Send email invite	sendemailInvite	Sending an email invitation for a specific event.	It can be true or false

Update User

Upddate user | key: updateUser

Input	Key	Description	Example

Input	Key	Description	Example
On behalf of	onbehalfOf	Provide the reference id of the Greenhouse user.	Js10Q1
First name	firstName	Provide the first name of the user.	John
Last name	LastName	Provide the last name of the user.	Smith
Email Id	emailID	Email id is an unique address of the users used for sending emails.	jsmith@example.com.