Notes

REST API — All endpoints require authentication via Bearer token. Include Authorization: Bearer {token} in every request. Tokens are managed in GitScrum Settings → API. Base URL: https://services.gitscrum.com — All request paths in this documentation are relative to this base URL.

Notes provide a personal and shared space for capturing ideas, meeting notes, and documentation outside of project tasks. Notes support markdown, folders, sharing, and revision history.

List Notes

Returns notes for the authenticated user in a workspace.

GET /notes?company_slug={slug}

Query Parameters

Example Request

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

Example Response

{
  "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"
    }
  ]
}

Create Note

Creates a new note.

POST /notes

Request Body

Example Request

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"
  }'

Update Note

Updates an existing note.

PUT /notes/{uuid}

Path Parameters

Request Body

Delete Note

Permanently deletes a note and its revision history.

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

Path Parameters

Toggle Share

Toggles the sharing visibility of a note.

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

Path Parameters

Note Revisions

Returns the revision history of a note.

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

Path Parameters

Note Folders

List Folders

GET /note-folders?company_slug={slug}

Create Folder

POST /note-folders

Request Body:

Update Folder

PUT /note-folders/{uuid}

Request Body:

Move Note to Folder

POST /note-folders/move-note

Request Body:

Field Reference