GitScrum / Docs

Notas

Crea, actualiza y comparte notas. Gestiona carpetas de notas y realiza seguimiento de revisiones.

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 notas proporcionan un espacio personal y compartido para capturar ideas, notas de reuniones y documentación fuera de las tareas del proyecto. Las notas soportan markdown, carpetas, compartición e historial de revisiones.

Listar notas

Devuelve las notas del usuario autenticado en un workspace.

GET /notes?company_slug={slug}

Parámetros de query

ParámetroTipoRequeridoDescripción
company_slugstringIdentificador del workspace

Ejemplo de solicitud

curl -X GET "https://services.gitscrum.com/notes?company_slug=acme" \
  -H "Authorization: Bearer {token}"

Ejemplo de respuesta

{
  "data": [
    {
      "uuid": "f6a7b8c9-d0e1-2345-f012-3456789abcde",
      "title": "Sprint Retrospective Notes",
      "content": "## What went well\n\n- Shipped auth module on time\n- Zero production incidents",
      "is_shared": false,
      "folder": {
        "uuid": "a1b2c3d4-0000-1111-2222-333344445555",
        "name": "Meetings"
      },
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "revisions_count": 2,
      "created_at": "2026-02-03T09:00:00Z",
      "updated_at": "2026-02-05T11:30:00Z"
    }
  ]
}

Crear nota

Crea una nueva nota.

POST /notes

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
titlestringTítulo de la nota
contentstringNoCuerpo de la nota (markdown)
company_slugstringIdentificador del workspace

Ejemplo de solicitud

curl -X POST "https://services.gitscrum.com/notes" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Architecture Decision Record: Event Sourcing",
    "content": "## Context\n\nWe need to track all state changes for audit purposes.\n\n## Decision\n\nAdopt event sourcing for the billing domain.",
    "company_slug": "acme"
  }'

Actualizar nota

Actualiza una nota existente.

PUT /notes/{uuid}

Parámetros de ruta

ParámetroTipoDescripción
uuidstringUUID de la nota

Cuerpo de la solicitud

CampoTipoRequeridoDescripción
titlestringNoTítulo actualizado
contentstringNoContenido actualizado (markdown)
company_slugstringIdentificador del workspace

Eliminar nota

Elimina permanentemente una nota y su historial de revisiones.

DELETE /notes/{uuid}?company_slug={slug}

Parámetros de ruta

ParámetroTipoDescripción
uuidstringUUID de la nota

Alternar compartición

Alterna la visibilidad de compartición de una nota.

PUT /notes/{uuid}/share/toggle?company_slug={slug}

Parámetros de ruta

ParámetroTipoDescripción
uuidstringUUID de la nota

Revisiones de nota

Devuelve el historial de revisiones de una nota.

GET /notes/{uuid}/revisions?company_slug={slug}

Parámetros de ruta

ParámetroTipoDescripción
uuidstringUUID de la nota

Carpetas de notas

Listar carpetas

GET /note-folders?company_slug={slug}

Crear carpeta

POST /note-folders

Cuerpo de la solicitud:

CampoTipoRequeridoDescripción
namestringNombre de la carpeta
company_slugstringIdentificador del workspace

Actualizar carpeta

PUT /note-folders/{uuid}

Cuerpo de la solicitud:

CampoTipoRequeridoDescripción
namestringNombre actualizado de la carpeta
company_slugstringIdentificador del workspace

Mover nota a carpeta

POST /note-folders/move-note

Cuerpo de la solicitud:

CampoTipoRequeridoDescripción
note_uuidstringUUID de la nota
folder_uuidstringNoUUID de la carpeta destino (omitir para desagrupar)
company_slugstringIdentificador del workspace

Referencia de campos

CampoTipoDescripción
uuidstringIdentificador único de la nota
titlestringTítulo de la nota
contentstringCuerpo de la nota (markdown)
is_sharedbooleanSi la nota está compartida
folderobjectCarpeta (uuid, name)
userobjectPropietario (username, name)
revisions_countintegerNúmero de revisiones
created_atstringTimestamp de creación
updated_atstringTimestamp de última actualización