Docs

Search the docs

Guides, sections and API endpoints

API reference

Scorecards

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

Retrieve an application's scorecard

get/applications/{application_id}/scorecard

Needs the applications:read scope

The application scored by AI against its job's rubric, criterion by criterion. 404 until it's been scored.

Path parameters

  • application_iduuidRequired

Returns 200

  • application_iduuid
  • statusenum
    pending while being (re)scored.
    One ofpendingcompletedfailed
  • scoreintegernullable
    0-100 against the job's rubric; null when the rubric only has knockouts.
  • knockout_resultenumnullable
    One ofpassedunclearfailed
  • summarystringnullable
    A couple of sentences on the overall fit.
  • scored_atdatetimenullable
  • itemsarray of object
    8 child attributes
    • namestring
    • kindenum
      scored (1-5) or knockout (passed, unclear or failed).
      One ofscoredknockout
    • weightinteger
    • scoreintegernullable
      1-5 for a scored criterion: the team's override when there is one, else the AI's.
    • resultenumnullable
      For a knockout criterion: the team's override when there is one, else the AI's.
      One ofpassedunclearfailed
    • justificationstringnullable
    • quotestringnullable
      Verbatim evidence.
    • sourceenumnullable
      Where the quote is from.
      One ofresumeapplicationgithub

Errors

  • 401The key is wrong, expired or revoked (api_key_required when missing) invalid_api_key
  • 403The key isn't allowed applications:read insufficient_scope
  • 404It isn't there, or belongs to another organization resource_not_found
  • 422A parameter or field doesn't validate missing, uuid_parsing, …
curl "https://api.hirehappy.io/v1/applications/e3b1c5d7-9f2a-4b6c-8d0e-1f3a5b7c9d2e/scorecard" \
  -H "Authorization: Bearer $HIREHAPPY_API_KEY"
Response 200
{
  "application_id": "e3b1c5d7-9f2a-4b6c-8d0e-1f3a5b7c9d2e",
  "status": "completed",
  "score": 82,
  "knockout_result": "passed",
  "summary": "Five years running Python services in production and a clear record of owning APIs end to end.",
  "scored_at": "2026-10-26T09:31:12Z",
  "items": [
    {
      "name": "Python in production",
      "kind": "scored",
      "weight": 3,
      "score": 4,
      "result": null,
      "justification": "Ran FastAPI services at scale at her last two jobs.",
      "quote": "Led the migration of our billing API to FastAPI, serving 2M requests a day.",
      "source": "resume"
    }
  ]
}