Skip to main content
GET
/
api
/
v1
/
candidates
/
{candidate_id}
Détails d'un candidat
curl --request GET \
  --url https://app.voicehire.io/api/v1/candidates/{candidate_id} \
  --header 'X-API-Key: <api-key>'
{
  "candidate_id": "550e8400-e29b-41d4-a716-446655440000",
  "campaign_id": "abc123def456",
  "basic_info": {
    "first_name": "Jean",
    "last_name": "Dupont",
    "email": "jean.dupont@example.com",
    "phone": "0612345678"
  },
  "interview": {
    "status": "completed",
    "date": "2024-01-15T14:30:00Z",
    "duration_seconds": 480,
    "score": 8.5
  },
  "responses": [
    {
      "question": "Parlez-moi de votre expérience avec React et Node.js",
      "answer": "J'ai 5 ans d'expérience avec React, j'ai travaillé sur plusieurs projets...",
      "score": 9,
      "weight": 2,
      "explanation": "Le candidat démontre une expertise approfondie avec des exemples concrets"
    },
    {
      "question": "Quelle est votre disponibilité?",
      "answer": "Je suis disponible immédiatement",
      "score": 10,
      "weight": 1,
      "explanation": "Disponibilité immédiate, alignée avec les besoins"
    }
  ],
  "analysis": {
    "availability": "Immédiatement",
    "availability_start": "2024-01-20",
    "salary_expectation": "45000-50000€",
    "candidate_alignment": "Excellente correspondance avec le profil recherché. Expertise technique solide et disponibilité immédiate.",
    "strengths": [
      "5 ans d'expérience avec React et Node.js",
      "Portfolio de projets impressionnant",
      "Excellentes compétences en communication",
      "Disponible immédiatement"
    ],
    "concerns": [
      "Peu d'expérience en gestion d'équipe",
      "Prétentions salariales dans la fourchette haute"
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.voicehire.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Paramètres

​
candidate_id
string
required
Identifiant unique du candidat (UUID)

​
Réponse

{
  "candidate_id": "550e8400-e29b-41d4-a716-446655440000",
  "campaign_id": "abc123def456",
  "basic_info": {
    "first_name": "Jean",
    "last_name": "Dupont",
    "email": "jean.dupont@example.com",
    "phone": "0612345678"
  },
  "interview": {
    "status": "completed",
    "date": "2024-01-15T14:30:00Z",
    "duration_seconds": 480,
    "score": 8.5
  },
  "responses": [
    {
      "question": "Parlez-moi de votre expérience avec React et Node.js",
      "answer": "J'ai 5 ans d'expérience avec React, j'ai travaillé sur plusieurs projets...",
      "score": 9,
      "weight": 2,
      "explanation": "Le candidat démontre une expertise approfondie avec des exemples concrets"
    },
    {
      "question": "Quelle est votre disponibilité?",
      "answer": "Je suis disponible immédiatement",
      "score": 10,
      "weight": 1,
      "explanation": "Disponibilité immédiate, alignée avec les besoins"
    }
  ],
  "analysis": {
    "availability": "Immédiatement",
    "availability_start": "2024-01-20",
    "salary_expectation": "45000-50000€",
    "candidate_alignment": "Excellente correspondance avec le profil recherché. Expertise technique solide et disponibilité immédiate.",
    "strengths": [
      "5 ans d'expérience avec React et Node.js",
      "Portfolio de projets impressionnant",
      "Excellentes compétences en communication",
      "Disponible immédiatement"
    ],
    "concerns": [
      "Peu d'expérience en gestion d'équipe",
      "Prétentions salariales dans la fourchette haute"
    ]
  }
}
​
candidate_id
string
required
Identifiant unique du candidat
​
campaign_id
string
required
Identifiant de la campagne associée
​
basic_info
object
required
Informations de base du candidat
​
interview
object
required
Détails de l’entretien
​
responses
array
Réponses détaillées aux questions (uniquement si l’entretien est complété)
​
analysis
object
Analyse globale du candidat (uniquement si l’entretien est complété)

​
Exemple de requête

curl -X GET https://app.voicehire.io/api/v1/candidates/550e8400-e29b-41d4-a716-446655440000 \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX"

​
Codes d’erreur

CodeDescription
401Clé API manquante ou invalide
404Candidat non trouvé

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Path Parameters

​
candidate_id
string
required

ID ou UUID du candidat

Response

Détails du candidat

​
id
integer

ID du candidat

​
uuid
string

UUID du candidat

​
first_name
string
​
last_name
string
​
phone_number
string
​
email
string | null
​
status
enum<string>
Available options:
completed,
pending,
voicemail,
incomplete
​
interview_score
number | null

Score de l'entretien (sur 10)

​
date
string<date-time>
​
is_sourced
boolean

Candidat sourcé (avec SMS)

​
campaign_id
string
​
job_title
string
​
availability
string | null
​
salary_expectation
string | null
​
interview_duration
integer

Durée de l'entretien en secondes

​
recherche_active
boolean

En recherche active d'emploi

​
ecoute_marche
boolean

À l'écoute du marché

​
score_details
object
​
transcript
object