GitScrum / Docs

Workspaces

Lista y recupera workspaces. Obtén detalles, estadísticas y configuración del workspace.

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 workspaces son el contenedor de nivel superior en GitScrum. Cada proyecto, miembro y recurso pertenece a un workspace.

Listar workspaces

GET /companies

Devuelve todos los workspaces a los que pertenece el usuario autenticado.

curl -X GET https://services.gitscrum.com/companies \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Respuesta 200 OK

{
  "data": [
    {
      "slug": "acme-corp",
      "name": "Acme Corp",
      "logo": "https://cdn.gitscrum.com/logos/acme.png",
      "header_logo": "https://cdn.gitscrum.com/logos/acme-header.png",
      "header_color": "#1a1a2e",
      "favicon": "https://cdn.gitscrum.com/favicons/acme.ico",
      "owner": {
        "name": "Jane Smith",
        "username": "janesmith"
      },
      "settings": {
        "timezone": "America/New_York",
        "language": "en"
      }
    }
  ]
}

Obtener workspace

GET /companies/{slug}

Devuelve los detalles completos del workspace.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del workspace
curl -X GET https://services.gitscrum.com/companies/acme-corp \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Respuesta 200 OK

{
  "data": {
    "slug": "acme-corp",
    "name": "Acme Corp",
    "logo": "https://cdn.gitscrum.com/logos/acme.png",
    "header_logo": "https://cdn.gitscrum.com/logos/acme-header.png",
    "header_color": "#1a1a2e",
    "favicon": "https://cdn.gitscrum.com/favicons/acme.ico",
    "owner": {
      "name": "Jane Smith",
      "username": "janesmith"
    },
    "settings": {
      "timezone": "America/New_York",
      "language": "en"
    }
  }
}

Crear workspace

POST /companies

Crea un nuevo workspace.

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
namestringNombre del workspace
curl -X POST https://services.gitscrum.com/companies \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "New Workspace"
  }'

Actualizar workspace

PUT /companies/{slug}

Actualiza la configuración del workspace.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del workspace

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
namestringNoNombre del workspace
curl -X PUT https://services.gitscrum.com/companies/acme-corp \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Corporation"
  }'

Eliminar workspace

DELETE /companies/{slug}

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

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del workspace
curl -X DELETE https://services.gitscrum.com/companies/acme-corp \
  -H "Authorization: Bearer {token}"

POST /companies/{slug}/logo

Sube o reemplaza el logo del workspace.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del workspace

Cuerpo de la solicitud (multipart/form-data)

CampoTipoRequeridoDescripción
logofileArchivo de imagen (PNG, JPG)

DELETE /companies/{slug}/logo

Elimina el logo del workspace.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del workspace

Estadísticas del workspace

GET /companies/stats

Devuelve estadísticas a nivel de workspace.

curl -X GET https://services.gitscrum.com/companies/stats \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json"

Respuesta 200 OK

{
  "data": {
    "projects_count": 12,
    "members_count": 28,
    "tasks_count": 847,
    "completed_tasks_count": 623,
    "active_sprints_count": 3
  }
}

Mi rol

GET /companies/{slug}/my-role

Devuelve el rol del usuario autenticado en el workspace.

Parámetros de ruta

ParámetroTipoRequeridoDescripción
slugstringIdentificador del workspace
curl -X GET https://services.gitscrum.com/companies/acme-corp/my-role \
  -H "Authorization: Bearer {token}"

Referencia de campos

CampoTipoDescripción
slugstringIdentificador único del workspace
namestringNombre para mostrar del workspace
logostringURL de la imagen del logo
header_logostringURL del logo del header
header_colorstringColor de fondo del header (hex)
faviconstringURL del favicon
ownerobjectPropietario del workspace (name, username)
settingsobjectConfiguración del workspace (timezone, language)
statsobjectEstadísticas agregadas (cuando se solicitan)