Aller au contenu

Référence de l'API

Source

Authentifiez chaque requête avec une clé API de workspace, dans l’un ou l’autre en-tête :

Authorization: Bearer <clé>
X-API-Key: <clé>

Le préfixe de la clé choisit l’hôte — co_live_… → https://api.custom.one, co_test_… → https://dev.api.custom.one. Tous les chemins sont sous /api/v1.

Groupés par ce que vous faites. Cette table est un index — le contrat, c’est le document OpenAPI en bas de page, généré depuis l’API elle-même, et un contrôle au build échoue si les deux divergent.

Méthode & chemin Rôle
GET /me Tester l’authentification, et identifier le workspace de la clé.
Méthode & chemin Rôle
GET /funnels Lister les customs du workspace. Paginé par curseur.
GET /funnels/:id Un custom : ses pointeurs de version et son lien vers l’éditeur.
GET /templates Les modèles clonables.
GET /funnels/:id/fields Les colonnes mappables d’un custom.
GET /funnels/:id/readiness Ce qu’il reste avant publication, sans rien publier.
GET /funnels/:id/questions Les questions du brouillon.
GET /funnels/:id/scores Les scores du brouillon.
GET /funnels/:id/segments Les scènes : quels clips existent et quand ils jouent.
Méthode & chemin Rôle
POST /funnels Créer un custom, éventuellement cloné d’un modèle. Toujours un brouillon.
PATCH /funnels/:id/questions REMPLACER l’ensemble des questions.
PATCH /funnels/:id/scores REMPLACER l’ensemble des scores.
PATCH /funnels/:id/segments REMPLACER les scènes. Vous définissez la structure, jamais les images.
POST /funnels/:id/clip-scripts Écrire les textes à lire face caméra.
POST /funnels/:id/pages/:pageSlug/html-blocks Poser des blocs HTML personnalisés sur une page de résultat, et récupérer un lien montrant le rendu. Pose seulement — le HTML, c’est vous qui l’écrivez.
POST /funnels/:id/result-page-previews Voir une page de résultat draft pour un jeu de réponses, sans publier. Renvoie un lien qui expire.
POST /funnels/:id/publish Mettre le brouillon en ligne. Refuse tant qu’il manque quelque chose.
DELETE /funnels/:id Mettre un custom à la corbeille. Réversible — il reste récupérable depuis le dashboard.
Méthode & chemin Rôle
GET /leads Lister les leads, du plus récent au plus ancien. Paginé par curseur.
POST /leads Créer un lead. Accepte un en-tête Idempotency-Key.
PATCH /leads/:id Modifier un lead — marquer acheteur, ajouter une note.
GET /leads/sample Quelques leads récents, au format de l’événement diagnostic.submitted.
GET /tags Lister les tags du workspace.
POST /leads/:id/tags Ajouter des tags au contact d’un lead.
DELETE /leads/:id/tags Retirer des tags du contact d’un lead.
Méthode & chemin Rôle
POST /sources Créer une entrée par custom. Renvoie l’URL d’ingestion prête à coller.
GET /sources Lister les sources entrantes d’un custom (jamais le secret).
GET /sources/:id Une source entrante (jamais le secret).
PATCH /sources/:id Modifier le nom, le mapping, l’état actif ou l’auto-soumission.
DELETE /sources/:id Supprimer une source. Les lignes déjà produites sont conservées.
GET /sources/:id/secret Reconstruire l’URL d’ingestion d’une source existante.
POST /sources/:id/rotate-secret Générer un nouveau secret. L’ancienne URL cesse immédiatement.
POST /sources/:id/import Importer un CSV en lignes EN ATTENTE. Rien n’est facturé tant qu’elles ne sont pas soumises.
Méthode & chemin Rôle
POST /hooks S’abonner à des événements de lead.
GET /hooks Lister les abonnements créés par l’API.
PATCH /hooks/:id Modifier un abonnement sur place — URL, événements, périmètre.
DELETE /hooks/:id Se désabonner.

Le contrat complet et lisible par une machine — chaque paramètre, schéma de réponse et erreur — est le document OpenAPI, généré depuis l’API elle-même :

Pointez votre générateur de code ou votre agent IA sur cette URL. Un explorateur interactif rendu arrivera.