Notes
Créez, mettez à jour et partagez des notes. Gérez les dossiers de notes et suivez les révisions.
REST API — Tous les endpoints nécessitent une authentification par Bearer token. IncluezAuthorization: Bearer {token}dans chaque requête. Les tokens sont gérés dans Paramètres GitScrum → API. Base URL:https://services.gitscrum.com— Tous les chemins de requête dans cette documentation sont relatifs à cette URL de base.
Les notes fournissent un espace personnel et partagé pour capturer des idées, des comptes-rendus de réunion et de la documentation en dehors des tâches de projet. Les notes supportent le markdown, les dossiers, le partage et l'historique des révisions.
Lister les notes
Retourne les notes de l'utilisateur authentifié dans un workspace.
GET /notes?company_slug={slug}Paramètres de requête
| Paramètre | Type | Requis | Description |
|---|---|---|---|
company_slug | string | Oui | Identifiant du workspace |
Exemple de requête
curl -X GET "https://services.gitscrum.com/notes?company_slug=acme" \
-H "Authorization: Bearer {token}"Exemple de réponse
{
"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"
}
]
}Créer une note
Crée une nouvelle note.
POST /notesCorps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
title | string | Oui | Titre de la note |
content | string | Non | Corps de la note (markdown) |
company_slug | string | Oui | Identifiant du workspace |
Exemple de requête
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"
}'Mettre à jour une note
Met à jour une note existante.
PUT /notes/{uuid}Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
uuid | string | UUID de la note |
Corps de la requête
| Champ | Type | Requis | Description |
|---|---|---|---|
title | string | Non | Titre mis à jour |
content | string | Non | Contenu mis à jour (markdown) |
company_slug | string | Oui | Identifiant du workspace |
Supprimer une note
Supprime définitivement une note et son historique de révisions.
DELETE /notes/{uuid}?company_slug={slug}Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
uuid | string | UUID de la note |
Basculer le partage
Bascule la visibilité de partage d'une note.
PUT /notes/{uuid}/share/toggle?company_slug={slug}Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
uuid | string | UUID de la note |
Révisions des notes
Retourne l'historique des révisions d'une note.
GET /notes/{uuid}/revisions?company_slug={slug}Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
uuid | string | UUID de la note |
Dossiers de notes
Lister les dossiers
GET /note-folders?company_slug={slug}Créer un dossier
POST /note-foldersCorps de la requête :
| Champ | Type | Requis | Description |
|---|---|---|---|
name | string | Oui | Nom du dossier |
company_slug | string | Oui | Identifiant du workspace |
Mettre à jour un dossier
PUT /note-folders/{uuid}Corps de la requête :
| Champ | Type | Requis | Description |
|---|---|---|---|
name | string | Oui | Nom du dossier mis à jour |
company_slug | string | Oui | Identifiant du workspace |
Déplacer une note dans un dossier
POST /note-folders/move-noteCorps de la requête :
| Champ | Type | Requis | Description |
|---|---|---|---|
note_uuid | string | Oui | UUID de la note |
folder_uuid | string | Non | UUID du dossier cible (omettre pour retirer du dossier) |
company_slug | string | Oui | Identifiant du workspace |
Référence des champs
| Champ | Type | Description |
|---|---|---|
uuid | string | Identifiant unique de la note |
title | string | Titre de la note |
content | string | Corps de la note (markdown) |
is_shared | boolean | Si la note est partagée |
folder | object | Dossier (uuid, name) |
user | object | Propriétaire (username, name) |
revisions_count | integer | Nombre de révisions |
created_at | string | Horodatage de création |
updated_at | string | Horodatage de dernière mise à jour |