How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Greenhouse Candidates API

Create or retrieve candidates / prospects in the customer's Greenhouse account.

Greenhouse Candidates API is one of 27 APIs that Greenhouse publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Candidates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, rate-limit docs, and 2 JSON Schemas.

This API exposes 15 operations across 12 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.greenhouse.io/v1/partner, https://harvest.greenhouse.io/v1.

15 operations 12 paths 11 schemas 3 DELETE2 GET1 PATCH7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://harvest.greenhouse.io/v1
Authentication
OAuth 2.0, HTTP Basic
Resource Areas
1

Authentication & Security 2

Greenhouse Candidates API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP basic authentication (BasicAuth).

  • BasicAuth — HTTP Basic with the Partner API key as the username and an empty password.

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 3 DELETE, 2 GET, 1 PATCH, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Candidates 15

Create or retrieve candidates / prospects in the customer's Greenhouse account.

GET
/candidates
List Partner Candidates
listPartnerCandidates 3 params → 200
POST
/candidates
Create Partner Candidate
createPartnerCandidate 1 param body → 201
DELETE
/candidates
Delete Candidates Bulk
deleteCandidates 1 param → 2044XX
GET
/candidates/{id}
Retrieve Candidate
getCandidate 1 param → 2004XX
PATCH
/candidates/{id}
Update Candidate
updateCandidate 2 params body → 2004XX
POST
/candidates/{id}/attachments
Add Candidate Attachment
addCandidateAttachment 2 params body → 2014XX
POST
/candidates/{id}/notes
Add Candidate Note
addCandidateNote 2 params body → 2014XX
POST
/candidates/{id}/email_notes
Add Candidate Email Note
addCandidateEmailNote 2 params body → 2014XX
POST
/candidates/{id}/education
Add Candidate Education
addCandidateEducation 2 params body → 2014XX
DELETE
/candidates/{id}/education/{education_id}
Delete Candidate Education
deleteCandidateEducation 3 params → 2044XX
POST
/candidates/{id}/employment
Add Candidate Employment
addCandidateEmployment 2 params body → 2014XX
DELETE
/candidates/{id}/employment/{employment_id}
Delete Candidate Employment
deleteCandidateEmployment 3 params → 2044XX
POST
/candidates/{id}/prospect
Convert Candidate To Prospect
candidateToProspect 2 params → 2004XX
PUT
/candidates/{id}/anonymize
Anonymize Candidate
anonymizeCandidate 2 params → 2004XX
PUT
/candidates/{id}/merge
Merge Candidate
mergeCandidate 2 params body → 2004XX

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Candidate (21 properties), Application (17 properties), PartnerCandidate (11 properties), CandidateCreate (8 properties). Each schema is shown below with its type and property counts.

PartnerCandidate
object
11 properties 3 required
UserRef
object
5 properties
Error
object
2 properties
Application
object
17 properties
CandidateUpdate
object
6 properties
Candidate
object
21 properties
CandidateCreate
object
8 properties 2 required
Attachment
object
5 properties 2 required
Employment
object
4 properties
ApplicationCreate
object
5 properties 1 required
Education
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

greenhouse-io-candidates-api-openapi.yml Raw ↑

Other APIs Greenhouse publishes across the network.

Greenhouse Recruiting Webhooks
Greenhouse Onboarding Webhooks
Greenhouse ActivityFeed API
Greenhouse Applications API
Greenhouse Approvals API
Greenhouse Auth API
Greenhouse CustomFields API
Greenhouse Departments API
Greenhouse Events API
Greenhouse GraphQL API
Greenhouse JobOpenings API
Greenhouse JobPosts API
Where this information came from

This is an independent, third-party profile of Greenhouse Candidates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.