Sprints

REST API — Tous les endpoints nécessitent une authentification par Bearer token. Incluez Authorization: Bearer {token} dans chaque requête. Les tokens sont gérés dans Paramètres GitScrum → API. Base URL: https://services.gitscrum.com — Tous les chemins de requête dans cette documentation sont relatifs à cette URL de base.

Les sprints sont des itérations limitées dans le temps utilisées pour planifier et livrer du travail. Chaque sprint contient des tâches et fournit des métriques intégrées pour suivre la vélocité, le burndown et la performance de l'équipe.

Lister les sprints

Retourne les sprints d'un projet.

GET /sprints?company_slug={slug}&project_slug={slug}

Paramètres de requête

Exemple de requête

curl -X GET "https://services.gitscrum.com/sprints?company_slug=acme&project_slug=web-app" \
  -H "Authorization: Bearer {token}"

Exemple de réponse

{
  "data": [
    {
      "slug": "sprint-12",
      "title": "Sprint 12",
      "description": "Authentication and onboarding improvements",
      "date_start": "2026-02-03",
      "date_finish": "2026-02-14",
      "color": "4A90D9",
      "is_private": false,
      "close_on_finish": true,
      "stats": {
        "tasks_count": 18,
        "completed_count": 7,
        "progress_percentage": 39
      }
    }
  ]
}

Obtenir un sprint

Retourne les détails complets d'un sprint.

GET /sprints/{slug}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Tous les sprints (inter-workspace)

Retourne les sprints de tous les workspaces auxquels l'utilisateur authentifié a accès.

GET /sprints/all-workspaces

Créer un sprint

Crée un nouveau sprint.

POST /sprints

Corps de la requête

Exemple de requête

curl -X POST "https://services.gitscrum.com/sprints" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Sprint 13",
    "company_slug": "acme",
    "project_slug": "web-app",
    "date_start": "2026-02-17",
    "date_finish": "2026-02-28",
    "close_on_finish": true
  }'

Mettre à jour un sprint

Met à jour un sprint existant.

PUT /sprints/{slug}

Corps de la requête

Accepte companyslug, projectslug et les mêmes champs optionnels que Créer un sprint.

KPIs du sprint

Retourne les indicateurs de performance clés du sprint.

GET /sprints/{slug}/kpis?company_slug={slug}&project_slug={slug}

Statistiques du sprint

Retourne les statistiques du sprint.

GET /sprints/{slug}/stats?company_slug={slug}&project_slug={slug}

Rapports du sprint

Retourne les rapports du sprint avec des données de graphiques optionnelles.

GET /sprints/{slug}/reports?company_slug={slug}&project_slug={slug}

Paramètres de requête

Progression du sprint

Retourne la progression actuelle du sprint.

GET /sprints/{slug}/progress?company_slug={slug}&project_slug={slug}

Métriques du sprint

Retourne les métriques détaillées du sprint.

GET /sprints/{slug}/metrics?company_slug={slug}&project_slug={slug}

Supprimer un sprint

Supprime définitivement un sprint. Les tâches du sprint sont conservées mais dissociées.

DELETE /sprints/{slug}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Référence des champs