Skip to main content
GET
/
api
/
v1
/
campaigns
Lister les campagnes
curl --request GET \
  --url https://app.voicehire.io/api/v1/campaigns \
  --header 'X-API-Key: <api-key>'
{
  "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

​
page
integer
default:"1"
Numéro de la page à récupérer (minimum: 1)
​
per_page
integer
default:"20"
Nombre de résultats par page (minimum: 1, maximum: 100)
​
status
string
Filtrer les campagnes par statutValeurs possibles:
  • active - Campagnes actives
  • paused - Campagnes en pause
  • completed - 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
}
​
campaigns
array
Liste des campagnes
​
total
integer
required
Nombre total de campagnes correspondant aux critères
​
page
integer
required
Page actuelle
​
per_page
integer
required
Nombre de résultats par page
​
total_pages
integer
required
Nombre total de pages

​
Codes d’erreur

CodeDescription
400Paramètres de requête invalides
401Clé API manquante ou invalide

Authorizations

​
X-API-Key
string
header
required

Clé API au format vh_live_XXXXX

Query Parameters

​
page
integer
default:1

Numéro de page (commence à 1)

Required range: x >= 1
​
per_page
integer
default:20

Nombre d'éléments par page

Required range: 1 <= x <= 100
​
status
enum<string>

Filtrer par statut

Available options:
active,
paused,
completed

Response

Liste des campagnes

​
campaigns
object[]
​
page
integer
​
per_page
integer
​
total
integer
​
total_pages
integer