Skip to Content
Référence API

Référence API

L’API Checkflow est une API REST accessible à https://api.checkflow.space/api/v1. Toutes les requêtes (sauf authentification) nécessitent un token Bearer.


Authentification

Demander un OTP

POST /api/v1/auth/request-otp
ChampTypeDescription
emailstringEmail de l’utilisateur
full_namestring?Nom complet (optionnel, pour la création de compte)

Réponse : 200 — Code OTP envoyé par email.


Vérifier un OTP

POST /api/v1/auth/verify-otp
ChampTypeDescription
emailstringEmail
codestringCode OTP à 6 chiffres

Réponse : 200 — Retourne token, data (utilisateur), session.


Google OAuth

POST /api/v1/auth/google
ChampTypeDescription
id_tokenstringToken Google ID

Réponse : 200 — Retourne token, data, session.


Profil utilisateur

GET /api/v1/auth/me Authorization: Bearer <token>

Réponse : 200 — Données du profil utilisateur.


Déconnexion

POST /api/v1/auth/logout Authorization: Bearer <token>

Rafraîchir la session

POST /api/v1/auth/refresh Authorization: Bearer <token>

Projets

Toutes les routes nécessitent Authorization: Bearer <token>.

MéthodeRouteDescription
POST/projectsCréer un projet
GET/projectsLister mes projets
GET/projects/:idDétail d’un projet
GET/projects/:id/statsStatistiques du projet
PATCH/projects/:idModifier un projet
DELETE/projects/:idSupprimer un projet
POST/projects/:id/coverUpload image de couverture

Membres

MéthodeRouteDescription
GET/projects/:id/membersLister les membres
POST/projects/:id/membersInviter un membre
PATCH/projects/:id/members/:memberIdChanger le rôle
DELETE/projects/:id/members/:memberIdRetirer un membre

Invitations

MéthodeRouteDescription
GET/invites/:tokenDétails d’une invitation
POST/invites/:token/acceptAccepter une invitation

GTM (Initiatives, Phases, Tâches)

Toutes les routes sont préfixées par /projects/:projectId/gtm. Requiert authentification + accès au projet (owner, admin, ou member).

Initiatives

MéthodeRouteDescription
POST/initiativesCréer une initiative
GET/initiativesLister les initiatives
GET/initiatives/:idDétail d’une initiative
PATCH/initiatives/:idModifier une initiative
DELETE/initiatives/:idSupprimer une initiative
PUT/initiatives/reorderRéorganiser les initiatives

Phases

MéthodeRouteDescription
POST/initiatives/:initiativeId/phasesCréer une phase
GET/phases/:idDétail d’une phase
PATCH/phases/:idModifier une phase
DELETE/phases/:idSupprimer une phase
PUT/initiatives/:id/phases/reorderRéorganiser les phases

Tâches

MéthodeRouteDescription
POST/phases/:phaseId/tasksCréer une tâche
GET/phases/:phaseId/tasksLister les tâches d’une phase
GET/tasks/:idDétail d’une tâche
GET/my-tasksMes tâches assignées
PATCH/tasks/:idModifier une tâche
PATCH/tasks/:id/statusChanger le statut
PATCH/tasks/:id/datesModifier les dates
PATCH/tasks/:id/moveDéplacer vers une autre phase
DELETE/tasks/:idSupprimer une tâche

Dépendances

MéthodeRouteDescription
POST/tasks/:id/dependenciesCréer une dépendance
GET/tasks/:id/dependenciesLister les dépendances
DELETE/dependencies/:idSupprimer une dépendance

Commentaires

MéthodeRouteDescription
POST/tasks/:id/commentsAjouter un commentaire
GET/tasks/:id/commentsLister les commentaires
DELETE/comments/:idSupprimer un commentaire

Assignés

MéthodeRouteDescription
GET/tasks/:id/assigneesLister les assignés
POST/tasks/:id/assigneesAjouter un assigné
PUT/tasks/:id/assigneesRemplacer tous les assignés
DELETE/tasks/:id/assignees/:userIdRetirer un assigné

Statuts Personnalisés

MéthodeRouteDescription
GET/statusesLister les statuts
POST/statusesCréer un statut
PUT/statuses/reorderRéorganiser les statuts
PATCH/statuses/:idModifier un statut (nom, couleur)
DELETE/statuses/:idSupprimer un statut

Règles de Transition

MéthodeRouteDescription
GET/statuses/transition-rulesLister les règles
POST/statuses/transition-rulesCréer une règle
PUT/statuses/transition-rules/bulkRemplacer toutes les règles
PATCH/statuses/transition-rules/toggleActiver/désactiver les règles
DELETE/statuses/transition-rules/:idSupprimer une règle

Budget & KPIs

MéthodeRouteDescription
GET/projects/:id/gtm/kpisKPIs du projet
GET/projects/:id/gtm/initiatives/:id/kpisKPIs d’une initiative

IA

MéthodeRouteDescription
GET/projects/:id/gtm/ai/statusStatut de l’IA
POST/projects/:id/gtm/ai/generate-copyGénérer du texte
POST/projects/:id/gtm/ai/suggest-phasesSuggérer des phases
POST/projects/:id/gtm/ai/decompose-strategyDécomposer une stratégie

Analytics

MéthodeRouteDescription
GET/projects/:id/gtm/critical-pathChemin critique
POST/projects/:id/gtm/impact-analysisAnalyse d’impact
GET/projects/:id/gtm/velocityRapport de vélocité
GET/projects/:id/gtm/workloadCharge de travail
GET/projects/:id/gtm/analytics/summaryRésumé analytique
GET/projects/:id/gtm/analytics/eventsÉvénements

Médias & Fichiers

MéthodeRouteDescription
POST/projects/:id/gtm/tasks/:taskId/coverUpload couverture tâche
POST/projects/:id/gtm/tasks/:taskId/filesUpload fichier sur tâche
GET/projects/:id/gtm/tasks/:taskId/filesLister les fichiers
POST/projects/:id/gtm/tasks/:taskId/files/presigned-uploadURL présignée upload
GET/projects/:id/gtm/files/presignedURL présignée download
POST/projects/:id/gtm/files/uploadUpload fichier projet
DELETE/projects/:id/gtm/files/:storageKeySupprimer un fichier

Feedback

Préfixe : /projects/:projectId/feedbacks

MéthodeRouteDescription
POST/Créer un feedback
GET/Lister les feedbacks (filtres: status, type, priority, assignee_id, search)
GET/statsStatistiques
GET/:idDétail d’un feedback
PATCH/:idModifier un feedback
DELETE/:idSupprimer un feedback
POST/:id/commentsAjouter un commentaire
GET/:id/commentsLister les commentaires
GET/tags/listLister les tags
POST/tags/createCréer un tag
POST/:id/tags/:tagIdAjouter un tag
DELETE/:id/tags/:tagIdRetirer un tag
POST/api-keys/createCréer une clé API
GET/api-keys/listLister les clés API
DELETE/api-keys/:keyIdRévoquer une clé

SDK (Endpoint Public)

POST /api/v1/sdk/feedback Header: X-API-Key: ck_live_...

Endpoint public pour l’ingestion de feedbacks depuis le SDK. Authentifié via la clé API (header X-API-Key), pas de token Bearer requis.


Webhooks

Préfixe : /projects/:projectId/webhooks — Requiert rôle Owner ou Admin.

MéthodeRouteDescription
POST/Créer un webhook
GET/Lister les webhooks
PATCH/:idModifier un webhook
DELETE/:idSupprimer un webhook
POST/testTester un webhook

Notifications

MéthodeRouteDescription
GET/notificationsLister mes notifications
GET/notifications/unread-countNombre de non-lues
PUT/notifications/read-allTout marquer comme lu
PUT/notifications/:id/readMarquer comme lu
DELETE/notifications/:idSupprimer

Recherche

GET /api/v1/search?q=<terme> Authorization: Bearer <token>

Recherche globale dans tous les projets de l’utilisateur.


Templates

MéthodeRouteDescription
GET/templatesLister les templates
GET/templates/:idDétail d’un template
POST/templates/:id/forkForker en nouveau projet
Last updated on