GitScrum / Docs

Proyectos

Crea, lista y gestiona proyectos. Obtén detalles, estadísticas y resúmenes de tareas.

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.

Los proyectos organizan tareas, sprints y miembros del equipo dentro de un workspace.

Listar proyectos

GET /projects?company_slug={slug}

Devuelve una lista paginada de proyectos en un workspace.

Parámetros de query

ParámetroTipoRequeridoDescripción
company_slugstringIdentificador del workspace
statusstringNoFiltro: in_progress, completed, archived
curl -X GET "https://services.gitscrum.com/projects?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Respuesta 200 OK

{
  "data": [
    {
      "slug": "web-platform",
      "name": "Web Platform",
      "description": "Main product application",
      "logo": "https://cdn.gitscrum.com/projects/web.png",
      "visibility": "public",
      "is_private": false,
      "recurring": false,
      "owner": {
        "name": "Jane Smith",
        "username": "janesmith"
      },
      "created_at": "2025-06-15T09:00:00Z"
    }
  ]
}

Buscar proyecto por nombre

GET /projects?company_slug={slug}&name={name}

Busca proyectos por nombre dentro de un workspace.

Parámetros de query

ParámetroTipoRequeridoDescripción
company_slugstringIdentificador del workspace
namestringNombre del proyecto a buscar
curl -X GET "https://services.gitscrum.com/projects?company_slug=acme-corp&name=Web%20Platform" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Obtener proyecto

GET /projects/{slug}?company_slug={slug}

Devuelve los detalles completos del proyecto.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del proyecto

Parámetros de query

ParámetroTipoRequeridoDescripción
company_slugstringIdentificador del workspace
curl -X GET "https://services.gitscrum.com/projects/web-platform?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Respuesta 200 OK

{
  "data": {
    "slug": "web-platform",
    "name": "Web Platform",
    "description": "Main product application",
    "logo": "https://cdn.gitscrum.com/projects/web.png",
    "visibility": "public",
    "is_private": false,
    "recurring": false,
    "owner": {
      "name": "Jane Smith",
      "username": "janesmith"
    },
    "settings": {
      "default_workflow": "backlog",
      "task_prefix": "WEB"
    },
    "stats": {
      "tasks_count": 156,
      "completed_count": 98,
      "members_count": 8
    },
    "created_at": "2025-06-15T09:00:00Z"
  }
}

Crear proyecto

POST /projects

Crea un nuevo proyecto en un workspace.

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
namestringNombre del proyecto
company_slugstringIdentificador del workspace
descriptionstringNoDescripción del proyecto
visibilitystringNopublic (predeterminado) o private
client_uuidstringNoAsociar con un cliente
curl -X POST https://services.gitscrum.com/projects \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Mobile App",
    "company_slug": "acme-corp",
    "description": "iOS and Android application",
    "visibility": "private"
  }'

Respuesta 201 Created

{
  "data": {
    "slug": "mobile-app",
    "name": "Mobile App",
    "description": "iOS and Android application",
    "visibility": "private",
    "is_private": true,
    "created_at": "2026-02-07T10:00:00Z"
  }
}

Estadísticas del proyecto

GET /projects/{slug}/stats?company_slug={slug}

Devuelve estadísticas del proyecto.

curl -X GET "https://services.gitscrum.com/projects/web-platform/stats?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Respuesta 200 OK

{
  "data": {
    "tasks_count": 156,
    "completed_count": 98,
    "open_count": 58,
    "members_count": 8,
    "sprints_count": 6,
    "labels_count": 12
  }
}

Actualizar proyecto

PUT /projects/{slug}

Actualiza un proyecto existente.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del proyecto

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
company_slugstringIdentificador del workspace
namestringNoNombre del proyecto
descriptionstringNoDescripción del proyecto
visibilitystringNopublic o private
curl -X PUT "https://services.gitscrum.com/projects/web-platform" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_slug": "acme-corp",
    "name": "Web Platform v2",
    "description": "Main product application - redesigned"
  }'

Eliminar proyecto

DELETE /projects/{slug}?company_slug={slug}

Elimina permanentemente un proyecto y todos sus datos. Esta acción no se puede deshacer.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del proyecto
curl -X DELETE "https://services.gitscrum.com/projects/web-platform?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}"

Duplicar proyecto

POST /projects/{slug}/duplicate?company_slug={slug}

Crea una copia de la estructura del proyecto incluyendo workflows y configuraciones.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del proyecto de origen
curl -X POST "https://services.gitscrum.com/projects/web-platform/duplicate?company_slug=acme-corp" \
  -H "Authorization: Bearer {token}"

Referencia de campos

CampoTipoDescripción
slugstringIdentificador único del proyecto
namestringNombre para mostrar del proyecto
descriptionstringDescripción del proyecto
logostringURL del logo del proyecto
visibilitystringpublic o private
is_privatebooleanSi el proyecto es privado
recurringbooleanSi el proyecto es recurrente
ownerobjectPropietario del proyecto (name, username)
settingsobjectConfiguración del proyecto
statsobjectEstadísticas agregadas
created_atstringTimestamp de creación ISO 8601