Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaign_id}
/
candidates
Lister les candidats d'une campagne
curl --request GET \
  --url https://app.voicehire.io/api/v1/campaigns/{campaign_id}/candidates \
  --header 'X-API-Key: <api-key>'
{
  "candidates": [
    {
      "candidate_id": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "Jean",
      "last_name": "Dupont",
      "email": "jean.dupont@example.com",
      "phone": "0612345678",
      "status": "completed",
      "interview_score": 8.5,
      "interview_date": "2024-01-15T14:30:00Z",
      "availability": "Immédiatement",
      "salary_expectation": "45000-50000€",
      "candidate_alignment": "Excellente correspondance avec le profil recherché",
      "strengths": "Expérience solide en React, Bonne communication, Motivé",
      "concerns": "Peu d'expérience en gestion d'équipe",
      "is_sourced": false
    }
  ],
  "pagination": {
    "total": 125,
    "page": 1,
    "per_page": 50,
    "total_pages": 3
  }
}

​
Paramètres

​
campaign_id
string
required
Identifiant unique de la campagne
​
page
integer
default:"1"
Numéro de la page à récupérer
​
per_page
integer
default:"50"
Nombre de résultats par page (maximum: 100)
​
sort
string
default:"date_desc"
Ordre de tri des résultatsValeurs possibles:
  • date_desc - Plus récents en premier
  • date_asc - Plus anciens en premier
  • score_desc - Meilleurs scores en premier
  • score_asc - Scores les plus faibles en premier
​
filter_status
string
Filtrer par statut d’entretienValeurs possibles:
  • completed - Entretiens terminés
  • voicemail - Tombés sur répondeur
  • pending - En attente d’appel

​
Réponse

{
  "candidates": [
    {
      "candidate_id": "550e8400-e29b-41d4-a716-446655440000",
      "first_name": "Jean",
      "last_name": "Dupont",
      "email": "jean.dupont@example.com",
      "phone": "0612345678",
      "status": "completed",
      "interview_score": 8.5,
      "interview_date": "2024-01-15T14:30:00Z",
      "availability": "Immédiatement",
      "salary_expectation": "45000-50000€",
      "candidate_alignment": "Excellente correspondance avec le profil recherché",
      "strengths": "Expérience solide en React, Bonne communication, Motivé",
      "concerns": "Peu d'expérience en gestion d'équipe",
      "is_sourced": false
    }
  ],
  "pagination": {
    "total": 125,
    "page": 1,
    "per_page": 50,
    "total_pages": 3
  }
}
​
candidates
array
required
Liste des candidats
​
pagination
object
required
Informations de pagination

​
Exemple de requête

curl -X GET "https://app.voicehire.io/api/v1/campaigns/abc123def456/candidates?sort=score_desc" \
  -H "X-API-Key: vh_live_XXXXXXXXXXXXX"

​
Codes d’erreur

CodeDescription
400Paramètres de requête invalides
401Clé API manquante ou invalide
404Campagne non trouvée

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Path Parameters

​
campaign_id
string
required

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:50
Required range: 1 <= x <= 100
​
status
enum<string>

Filtrer par statut

Available options:
completed,
pending,
voicemail
​
min_score
number

Score minimum

Required range: 0 <= x <= 10
​
sort
enum<string>
default:date_desc

Ordre de tri

Available options:
date_desc,
date_asc,
score_desc,
score_asc

Response

200 - application/json

Liste des candidats

​
candidates
object[]
​
pagination
object