User Stories

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 user stories représentent les exigences ou fonctionnalités orientées utilisateur. Les tâches peuvent être regroupées sous des user stories pour organiser le travail autour de résultats livrables.

Lister les user stories

Retourne les user stories d'un projet.

GET /user-stories?company_slug={slug}&project_slug={slug}

Paramètres de requête

Exemple de requête

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

Exemple de réponse

{
  "data": [
    {
      "slug": "as-a-user-i-can-reset-my-password",
      "title": "As a user, I can reset my password",
      "description": "Users need to recover access when they forget their password.",
      "priority": {
        "id": 2,
        "title": "Medium"
      },
      "acceptance_criteria": "- Reset email sent within 30s\n- Link expires after 24h\n- Password must meet complexity rules",
      "tasks_count": 5,
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "created_at": "2026-01-15T08:00:00Z"
    }
  ]
}

Obtenir une user story

Retourne les détails complets d'une user story.

GET /user-stories/{slug}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Créer une user story

Crée une nouvelle user story.

POST /user-stories

Corps de la requête

Exemple de requête

curl -X POST "https://services.gitscrum.com/user-stories" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "As a manager, I can view team velocity",
    "company_slug": "acme",
    "project_slug": "web-app",
    "description": "Managers need a velocity chart to track team output per sprint.",
    "acceptance_criteria": "- Chart shows last 10 sprints\n- Displays story points and task count"
  }'

Mettre à jour une user story

Met à jour une user story existante.

PUT /user-stories/{slug}

Corps de la requête

Accepte companyslug, projectslug et les mêmes champs optionnels que Créer une user story.

Supprimer une user story

Supprime définitivement une user story. Les tâches liées à cette story sont conservées mais dissociées.

DELETE /user-stories/{slug}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

Référence des champs