GitScrum / Docs

Historias de Usuario

Crea y gestiona historias de usuario. Organiza tareas en historias de usuario para planificación ágil.

REST API — Todos los endpoints requieren autenticación mediante Bearer token. Incluye Authorization: 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.

Las historias de usuario representan requisitos o funcionalidades orientadas al usuario. Las tareas pueden agruparse bajo historias de usuario para organizar el trabajo en torno a resultados entregables.

Listar historias de usuario

Devuelve las historias de usuario de un proyecto.

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

Parámetros de query

ParámetroTipoRequeridoDescripción
company_slugstringIdentificador del workspace
project_slugstringIdentificador del proyecto

Ejemplo de solicitud

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

Ejemplo de respuesta

{
  "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"
    }
  ]
}

Obtener historia de usuario

Devuelve los detalles completos de una historia de usuario individual.

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

Parámetros de ruta

ParámetroTipoDescripción
slugstringSlug de la historia de usuario

Crear historia de usuario

Crea una nueva historia de usuario.

POST /user-stories

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
titlestringTítulo de la historia de usuario
company_slugstringIdentificador del workspace
project_slugstringIdentificador del proyecto
descriptionstringNoDescripción detallada (markdown)
priorityintegerNoID de prioridad (de los niveles de esfuerzo del proyecto)
acceptance_criteriastringNoDefinición de completado (markdown)

Ejemplo de solicitud

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"
  }'

Actualizar historia de usuario

Actualiza una historia de usuario existente.

PUT /user-stories/{slug}

Cuerpo de la solicitud

Acepta companyslug, projectslug y los mismos campos opcionales que Crear historia de usuario.

Eliminar historia de usuario

Elimina permanentemente una historia de usuario. Las tareas vinculadas a esta historia se conservan pero se desvinculan.

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

Parámetros de ruta

ParámetroTipoDescripción
slugstringSlug de la historia de usuario

Referencia de campos

CampoTipoDescripción
slugstringIdentificador único de la historia
titlestringTítulo de la historia de usuario
descriptionstringDescripción detallada (markdown)
priorityobjectNivel de prioridad (id, title)
acceptance_criteriastringDefinición de completado (markdown)
tasks_countintegerNúmero de tareas vinculadas
created_atstringTimestamp de creación
userobjectCreador (username, name)