Public API v1 — Debrief
Public API v1 — Candidates & Debrief

Get debrief by candidate email

Same as /candidates/{id}/debrief but looks up candidate by email. Use when you don't have the candidate_id stored.

get/api/public/v1/debrief

Request

  • Base URL: https://api.thebetterhire.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.thebetterhire.ai/api/public/v1/debrief
  • Auth: HTTP bearer

Query parameters

candidate_emailstring required

Response

Successful Response

candidate_idstring required

Candidate ID.

candidate_namestring required

Candidate name.

rolestring nullable

Primary role across interviews.

overall_scoreinteger required

Average score across all rounds (0-100).

recommendationstring required

Consensus hiring recommendation.

confidencestring required

Confidence level in recommendation.

rounds_completedinteger required

Number of interview rounds included.

date_rangestring

Date range of interviews.

executive_summarystring nullable

AI-generated executive brief (3-4 sentences).

Example response

{
  "date_range": "Jan 23 - Feb 3",
  "interview_journey": [
    {
      "round": "Phone Screening",
      "score": 81,
      "date": "Jan 23"
    }
  ],
  "top_strengths": [
    {
      "frequency": "3/4"
    }
  ],
  "key_concerns": [
    {
      "frequency": "3/4"
    }
  ],
  "risk_assessment": {
    "level": "low"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.