Lister les campagnes
curl --request GET \
--url https://app.voicehire.io/api/v1/campaigns \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.voicehire.io/api/v1/campaigns"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.voicehire.io/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.voicehire.io/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.voicehire.io/api/v1/campaigns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.voicehire.io/api/v1/campaigns")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"campaigns": [
{
"campaign_id": "abc123def456",
"job_title": "Développeur Full Stack",
"status": "active",
"total_candidates": 25,
"created_at": "2024-01-15T10:30:00Z"
},
{
"campaign_id": "ghi789jkl012",
"job_title": "Commercial B2B",
"status": "completed",
"total_candidates": 50,
"created_at": "2024-01-10T14:20:00Z"
}
],
"total": 15,
"page": 1,
"per_page": 20,
"total_pages": 1
}
Campagnes
Lister les campagnes
Récupère la liste de toutes les campagnes de votre structure avec pagination
GET
/
api
/
v1
/
campaigns
Lister les campagnes
curl --request GET \
--url https://app.voicehire.io/api/v1/campaigns \
--header 'X-API-Key: <api-key>'import requests
url = "https://app.voicehire.io/api/v1/campaigns"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://app.voicehire.io/api/v1/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.voicehire.io/api/v1/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.voicehire.io/api/v1/campaigns"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.voicehire.io/api/v1/campaigns")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.voicehire.io/api/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"campaigns": [
{
"campaign_id": "abc123def456",
"job_title": "Développeur Full Stack",
"status": "active",
"total_candidates": 25,
"created_at": "2024-01-15T10:30:00Z"
},
{
"campaign_id": "ghi789jkl012",
"job_title": "Commercial B2B",
"status": "completed",
"total_candidates": 50,
"created_at": "2024-01-10T14:20:00Z"
}
],
"total": 15,
"page": 1,
"per_page": 20,
"total_pages": 1
}
Paramètres de requête
integer
default:"1"
Numéro de la page à récupérer (minimum: 1)
integer
default:"20"
Nombre de résultats par page (minimum: 1, maximum: 100)
string
Filtrer les campagnes par statutValeurs possibles:
active- Campagnes activespaused- Campagnes en pausecompleted- Campagnes terminées
Réponse
{
"campaigns": [
{
"campaign_id": "abc123def456",
"job_title": "Développeur Full Stack",
"status": "active",
"total_candidates": 25,
"created_at": "2024-01-15T10:30:00Z"
},
{
"campaign_id": "ghi789jkl012",
"job_title": "Commercial B2B",
"status": "completed",
"total_candidates": 50,
"created_at": "2024-01-10T14:20:00Z"
}
],
"total": 15,
"page": 1,
"per_page": 20,
"total_pages": 1
}
array
Liste des campagnes
Show Propriétés
Show Propriétés
integer
required
Nombre total de campagnes correspondant aux critères
integer
required
Page actuelle
integer
required
Nombre de résultats par page
integer
required
Nombre total de pages
Codes d’erreur
| Code | Description |
|---|---|
| 400 | Paramètres de requête invalides |
| 401 | Clé API manquante ou invalide |
Authorizations
Clé API au format vh_live_XXXXX
Query Parameters
Numéro de page (commence à 1)
Required range:
x >= 1Nombre d'éléments par page
Required range:
1 <= x <= 100Filtrer par statut
Available options:
active, paused, completed 
