Sprints
Crea, gestiona y realiza seguimiento de sprints. Accede a KPIs, estadísticas, informes, progreso y métricas de burn-down.
REST API — Todos los endpoints requieren autenticación mediante Bearer token. IncluyeAuthorization: Bearer {token}en cada solicitud. Los tokens se gestionan en Configuración de GitScrum → API. Base URL:https://services.gitscrum.com— Todas las rutas de solicitud en esta documentación son relativas a esta URL base.
Los sprints son iteraciones con tiempo limitado que se utilizan para planificar y entregar trabajo. Cada sprint contiene tareas y proporciona métricas integradas para rastrear velocidad, burndown y rendimiento del equipo.
Listar sprints
Devuelve los sprints de un proyecto.
GET /sprints?company_slug={slug}&project_slug={slug}Parámetros de query
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
company_slug | string | Sí | Identificador del workspace |
project_slug | string | Sí | Identificador del proyecto |
Ejemplo de solicitud
curl -X GET "https://services.gitscrum.com/sprints?company_slug=acme&project_slug=web-app" \
-H "Authorization: Bearer {token}"Ejemplo de respuesta
{
"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
}
}
]
}Obtener sprint
Devuelve los detalles completos de un sprint individual.
GET /sprints/{slug}?company_slug={slug}&project_slug={slug}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
slug | string | Slug del sprint |
Todos los sprints (Cross-Workspace)
Devuelve sprints en todos los workspaces a los que el usuario autenticado tiene acceso.
GET /sprints/all-workspacesCrear sprint
Crea un nuevo sprint.
POST /sprintsCuerpo de la solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
title | string | Sí | Nombre del sprint |
company_slug | string | Sí | Identificador del workspace |
project_slug | string | Sí | Identificador del proyecto |
date_start | string | No | Fecha de inicio (YYYY-MM-DD, predeterminado: hoy) |
date_finish | string | No | Fecha de fin (YYYY-MM-DD, predeterminado: hoy + 7 días) |
description | string | No | Descripción del sprint (markdown) |
color | string | No | Color hex sin # |
is_private | boolean | No | Visibilidad del sprint |
closeonfinish | boolean | No | Cerrar automáticamente al llegar la fecha de fin |
Ejemplo de solicitud
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
}'Actualizar sprint
Actualiza un sprint existente.
PUT /sprints/{slug}Cuerpo de la solicitud
Acepta companyslug, projectslug y los mismos campos opcionales que Crear sprint.
KPIs del sprint
Devuelve los indicadores clave de rendimiento del sprint.
GET /sprints/{slug}/kpis?company_slug={slug}&project_slug={slug}Estadísticas del sprint
Devuelve estadísticas del sprint.
GET /sprints/{slug}/stats?company_slug={slug}&project_slug={slug}Informes del sprint
Devuelve informes del sprint con datos de gráficos opcionales.
GET /sprints/{slug}/reports?company_slug={slug}&project_slug={slug}Parámetros de query
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
resource | string | No | Filtrar a un solo gráfico: burndown, burnup, performance, types, efforts, memberdistribution, tasktype_distribution |
Progreso del sprint
Devuelve el progreso actual del sprint.
GET /sprints/{slug}/progress?company_slug={slug}&project_slug={slug}Métricas del sprint
Devuelve métricas detalladas del sprint.
GET /sprints/{slug}/metrics?company_slug={slug}&project_slug={slug}Eliminar sprint
Elimina permanentemente un sprint. Las tareas del sprint se conservan pero se desvinculan.
DELETE /sprints/{slug}?company_slug={slug}&project_slug={slug}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
slug | string | Slug del sprint |
Referencia de campos
| Campo | Tipo | Descripción |
|---|---|---|
slug | string | Identificador único del sprint |
title | string | Nombre del sprint |
description | string | Descripción del sprint (markdown) |
date_start | string | Fecha de inicio |
date_finish | string | Fecha de fin |
color | string | Código de color hex (sin #) |
is_private | boolean | Si el sprint es privado |
closeonfinish | boolean | Cerrar automáticamente en la fecha de fin |
stats | object | Resumen de estadísticas del sprint |
tasks_count | integer | Cantidad total de tareas |
completed_count | integer | Cantidad de tareas completadas |
progress_percentage | integer | Porcentaje de completitud (0–100) |