Wiki

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.

A wiki fornece uma base de conhecimento estruturada dentro de cada projeto. As páginas suportam conteúdo markdown, hierarquias aninhadas e pesquisa de texto completo.

Listar Páginas Wiki

Retorna páginas wiki de um projeto.

GET /wiki/pages?company_slug={slug}&project_slug={slug}

Parâmetros de Query

Exemplo de Requisição

curl -X GET "https://services.gitscrum.com/wiki/pages?company_slug=acme&project_slug=web-app" \
  -H "Authorization: Bearer {token}"

Exemplo de Resposta

{
  "data": [
    {
      "uuid": "d4e5f6a7-b8c9-0123-def0-123456789abc",
      "title": "API Architecture",
      "content": "# API Architecture\n\nOur REST API follows...",
      "parent_uuid": null,
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "revisions_count": 3,
      "created_at": "2026-01-20T10:00:00Z",
      "updated_at": "2026-02-01T14:30:00Z"
    }
  ]
}

Obter Página Wiki

Retorna uma única página wiki com conteúdo completo.

GET /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Criar Página Wiki

Cria uma nova página wiki.

POST /wiki/pages

Corpo da Requisição

Exemplo de Requisição

curl -X POST "https://services.gitscrum.com/wiki/pages" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Deployment Guide",
    "content": "# Deployment Guide\n\n## Prerequisites\n\n- Docker installed\n- Access to production cluster",
    "company_slug": "acme",
    "project_slug": "web-app"
  }'

Atualizar Página Wiki

Atualiza uma página wiki existente.

PUT /wiki/pages/{uuid}

Parâmetros de Caminho

Corpo da Requisição

Excluir Página Wiki

Exclui permanentemente uma página wiki.

DELETE /wiki/pages/{uuid}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Revisões da Página

Retorna o histórico de revisões de uma página wiki.

GET /wiki/pages/{uuid}/revisions?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Restaurar Revisão

Restaura uma página wiki para uma revisão anterior.

POST /wiki/pages/{uuid}/restore/{revision_uuid}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

Pesquisar Wiki

Pesquisa páginas wiki por conteúdo ou título.

GET /wiki/pages/search?company_slug={slug}&project_slug={slug}&q={query}

Parâmetros de Query

Exemplo de Requisição

curl -X GET "https://services.gitscrum.com/wiki/pages/search?company_slug=acme&project_slug=web-app&q=deployment" \
  -H "Authorization: Bearer {token}"

Referência de Campos