GitScrum / Docs

Épiques

Créez et gérez les épiques. Regroupez les user stories en initiatives de haut niveau.

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 épiques sont des initiatives de haut niveau qui regroupent des user stories liées. Utilisez les épiques pour organiser de grandes fonctionnalités ou phases de projet qui s'étendent sur plusieurs sprints.

Lister les épiques

Retourne les épiques d'un projet.

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

Paramètres de requête

ParamètreTypeRequisDescription
company_slugstringOuiIdentifiant du workspace
project_slugstringOuiIdentifiant du projet

Exemple de requête

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

Exemple de réponse

{
  "data": [
    {
      "uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "title": "User Onboarding",
      "description": "Complete onboarding flow including signup, verification, and tutorial.",
      "color": "8E44AD",
      "user_stories_count": 4,
      "created_at": "2026-01-10T12:00:00Z"
    }
  ]
}

Créer un épique

Crée un nouvel épique.

POST /user-story-epics

Corps de la requête

ChampTypeRequisDescription
titlestringOuiTitre de l'épique
company_slugstringOuiIdentifiant du workspace
project_slugstringOuiIdentifiant du projet
descriptionstringNonDescription de l'épique (markdown)
colorstringNonCouleur hex sans # (ex. : 8E44AD)

Exemple de requête

curl -X POST "https://services.gitscrum.com/user-story-epics" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Billing & Payments",
    "company_slug": "acme",
    "project_slug": "web-app",
    "description": "All billing, subscription, and payment-related stories.",
    "color": "E67E22"
  }'

Mettre à jour un épique

Met à jour un épique existant.

PUT /user-story-epics/{uuid}

Paramètres de chemin

ParamètreTypeDescription
uuidstringUUID de l'épique

Corps de la requête

ChampTypeRequisDescription
company_slugstringOuiIdentifiant du workspace
project_slugstringOuiIdentifiant du projet
titlestringNonTitre de l'épique mis à jour
descriptionstringNonDescription mise à jour
colorstringNonCouleur hex mise à jour sans #

Supprimer un épique

Supprime définitivement un épique. Les user stories liées à cet épique sont conservées mais dissociées.

DELETE /user-story-epics/{uuid}?company_slug={slug}&project_slug={slug}

Paramètres de chemin

ParamètreTypeDescription
uuidstringUUID de l'épique

Référence des champs

ChampTypeDescription
uuidstringIdentifiant unique de l'épique
titlestringTitre de l'épique
descriptionstringDescription de l'épique (markdown)
colorstringCode couleur hex (sans #)
userstoriescountintegerNombre de user stories liées
created_atstringHorodatage de création