Notas

REST API — Todos os endpoints requerem autenticação via Bearer token. Inclua Authorization: Bearer {token} em cada requisição. Os tokens são gerenciados em Configurações do GitScrum → API. Base URL: https://services.gitscrum.com — Todos os caminhos de requisição nesta documentação são relativos a esta URL base.

Notas fornecem um espaço pessoal e compartilhado para capturar ideias, anotações de reunião e documentação fora das tarefas do projeto. Notas suportam markdown, pastas, compartilhamento e histórico de revisões.

Listar Notas

Retorna notas do usuário autenticado em um workspace.

GET /notes?company_slug={slug}

Parâmetros de Query

Exemplo de Requisição

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

Exemplo de Resposta

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

Criar Nota

Cria uma nova nota.

POST /notes

Corpo da Requisição

Exemplo de Requisição

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

Atualizar Nota

Atualiza uma nota existente.

PUT /notes/{uuid}

Parâmetros de Caminho

Corpo da Requisição

Excluir Nota

Exclui permanentemente uma nota e seu histórico de revisões.

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

Parâmetros de Caminho

Alternar Compartilhamento

Alterna a visibilidade de compartilhamento de uma nota.

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

Parâmetros de Caminho

Revisões da Nota

Retorna o histórico de revisões de uma nota.

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

Parâmetros de Caminho

Pastas de Notas

Listar Pastas

GET /note-folders?company_slug={slug}

Criar Pasta

POST /note-folders

Corpo da Requisição:

Atualizar Pasta

PUT /note-folders/{uuid}

Corpo da Requisição:

Mover Nota para Pasta

POST /note-folders/move-note

Corpo da Requisição:

Referência de Campos