Skip to main content
GET
Lister les candidats d'une campagne

Paramètres

string
required
Identifiant unique de la campagne
integer
default:"1"
Numéro de la page à récupérer
integer
default:"50"
Nombre de résultats par page (maximum: 100)
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
string
Filtrer par statut d’entretienValeurs possibles:
  • completed - Entretiens terminés
  • voicemail - Tombés sur répondeur
  • pending - En attente d’appel

Réponse

array
required
Liste des candidats
object
required
Informations de pagination

Exemple de requête

Codes d’erreur

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