GitScrum / Docs

Comentários

Adicione, liste e atualize comentários em tarefas. Suporte para conteúdo em rich text.

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.

Comentários permitem que membros da equipe discutam tarefas, compartilhem atualizações e registrem decisões diretamente nos itens de trabalho.

Listar Comentários

Retorna comentários de uma tarefa específica.

GET /comments?company_slug={slug}&project_slug={slug}&task_uuid={uuid}

Parâmetros de Query

ParâmetroTipoObrigatórioDescrição
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
task_uuidstringSimUUID da tarefa

Exemplo de Requisição

curl -X GET "https://services.gitscrum.com/comments?company_slug=acme&project_slug=web-app&task_uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer {token}"

Exemplo de Resposta

{
  "data": [
    {
      "id": 1024,
      "comment": "<p>API integration is complete. Ready for review.</p>",
      "user": {
        "username": "johndoe",
        "name": "John Doe"
      },
      "created_at": "2026-02-05T09:15:00Z",
      "updated_at": "2026-02-05T09:15:00Z"
    }
  ]
}

Criar Comentário

Adiciona um comentário a uma tarefa.

POST /comments

Corpo da Requisição

CampoTipoObrigatórioDescrição
commentstringSimTexto do comentário (HTML ou markdown)
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto
task_uuidstringSimUUID da tarefa

Exemplo de Requisição

curl -X POST "https://services.gitscrum.com/comments" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Blocked by missing API credentials. Reaching out to DevOps.",
    "company_slug": "acme",
    "project_slug": "web-app",
    "task_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }'

Atualizar Comentário

Atualiza um comentário existente.

PUT /comments/{id}

Parâmetros de Caminho

ParâmetroTipoDescrição
idintegerID do comentário

Corpo da Requisição

CampoTipoObrigatórioDescrição
commentstringSimTexto do comentário atualizado
company_slugstringSimIdentificador do workspace
project_slugstringSimIdentificador do projeto

Excluir Comentário

Exclui um comentário.

DELETE /comments/{id}?company_slug={slug}&project_slug={slug}

Parâmetros de Caminho

ParâmetroTipoDescrição
----------------------------nidintegerID do comentário

Referência de Campos

CampoTipoDescrição
idintegerIdentificador do comentário
commentstringConteúdo do comentário (HTML)
userobjectAutor (username, name, avatar)
created_atstringTimestamp de criação
updated_atstringTimestamp da última atualização