Skip to main content
GET
Lister les campagnes

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 actives
  • paused - Campagnes en pause
  • completed - Campagnes terminées

Réponse

array
Liste des campagnes
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

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