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. 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.
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ámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
company_slug | string | Sí | Identificador 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 /notesCuerpo de la solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
title | string | Sí | Título de la nota |
content | string | No | Cuerpo de la nota (markdown) |
company_slug | string | Sí | Identificador 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ámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID de la nota |
Cuerpo de la solicitud
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
title | string | No | Título actualizado |
content | string | No | Contenido actualizado (markdown) |
company_slug | string | Sí | Identificador del workspace |
Eliminar nota
Elimina permanentemente una nota y su historial de revisiones.
DELETE /notes/{uuid}?company_slug={slug}Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID 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ámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID 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ámetro | Tipo | Descripción |
|---|---|---|
uuid | string | UUID de la nota |
Carpetas de notas
Listar carpetas
GET /note-folders?company_slug={slug}Crear carpeta
POST /note-foldersCuerpo de la solicitud:
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
name | string | Sí | Nombre de la carpeta |
company_slug | string | Sí | Identificador del workspace |
Actualizar carpeta
PUT /note-folders/{uuid}Cuerpo de la solicitud:
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
name | string | Sí | Nombre actualizado de la carpeta |
company_slug | string | Sí | Identificador del workspace |
Mover nota a carpeta
POST /note-folders/move-noteCuerpo de la solicitud:
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
note_uuid | string | Sí | UUID de la nota |
folder_uuid | string | No | UUID de la carpeta destino (omitir para desagrupar) |
company_slug | string | Sí | Identificador del workspace |
Referencia de campos
| Campo | Tipo | Descripción |
|---|---|---|
uuid | string | Identificador único de la nota |
title | string | Título de la nota |
content | string | Cuerpo de la nota (markdown) |
is_shared | boolean | Si la nota está compartida |
folder | object | Carpeta (uuid, name) |
user | object | Propietario (username, name) |
revisions_count | integer | Número de revisiones |
created_at | string | Timestamp de creación |
updated_at | string | Timestamp de última actualización |