Docs

Search the docs

Guides, sections and API endpoints

API reference

HireHappy API

A REST API over your organization's hiring: jobs and their pipelines, candidates, applications, AI scorecards and interviews. Every endpoint, with what it takes and returns, and a request in cURL, Python and Node.js.

Base URL

https://api.hirehappy.io/v1
Authentication
Authorization: Bearer hh_sk_…, with a key made under Settings → API keys
Format
JSON in and out, UTF-8; times in ISO 8601, in UTC
Lists
limit (up to 100) and offset, with the total
Errors
One shape for all: a type to branch on, a msg to show
Download the OpenAPI schema

OpenAPI 3.1, for generating a client, importing into Postman or Insomnia, or handing to an AI tool.

Check your key
curl https://api.hirehappy.io/v1/organizations/self \
  -H "Authorization: Bearer $HIREHAPPY_API_KEY"
Response 200
{
  "id": "0b6f3c2e-8a41-4d7e-9c55-3e2f1a7b9d10",
  "name": "Acme",
  "slug": "acme",
  "website": "https://acme.com",
  "timezone": "Europe/Berlin"
}

Resources

Organizations

The organization the API key belongs to

API keys

The API key itself: what it may do

Jobs

Your jobs: posting them on the job board, closing them, and their details

Job stages

A job's hiring pipeline, from the first stage to hired

Scorecards

Applications scored by AI against their job's rubric, with the evidence

Interviews

Interviews, calls and assessments of applications