| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retorna todos os comentários vinculados a um card específico a partir do seu identificador único (id).
Este endpoint permite consultar o histórico completo de comentários registrados em um card, incluindo informações sobre o autor, data de criação, conteúdo do comentário e demais metadados relacionados.
É recomendado para integrações que necessitam acompanhar interações, registrar históricos de atendimento, sincronizar conversas ou exibir comentários em sistemas externos.
Parâmetros utilizados
id
idIdentificador único do card que será consultado.
O ID deve ser informado diretamente na rota da requisição.
Exemplo:
GET https://api.goalfy.com.br/api/cards/12345/commentsNeste exemplo:
12345
Corresponde ao ID do card consultado.
Estrutura da resposta
Keys que retornam no PayLoad:
Keys que retornam no PayLoad:| Campo | Tipo | Descrição |
|---|---|---|
comments | array | Lista de comentários encontrados no card. |
id | string | Identificador único do comentário. |
createdAt | datetime | Data de criação do comentário. |
updateAt | datetime | Data da última atualização do comentário. |
body | string | Conteúdo do comentário armazenado em formato JSON. |
author | object | Informações do autor do comentário. |
author.id | string | Identificador do usuário autor. |
author.username | string | Nome do usuário autor do comentário. |
author.email | string | E-mail do usuário autor. |
Respostas esperadas
Sucesso 200Retorna todos os comentários associados ao card informado.
Caso o card não possua comentários, será retornada uma lista vazia.
Possíveis erros
404 Not FoundRetornado quando o card informado não existe ou não foi localizado.
401 UnauthorizedRetornado quando o token de autenticação é inválido ou não foi enviado corretamente.
403 ForbiddenRetornado quando o usuário não possui permissão para acessar os comentários do card informado.
Observações
ImportanteDependendo da integração utilizada, pode ser necessário realizar um JSON.parse() para obter o conteúdo textual do comentário.
- Os comentários são retornados vinculados ao card informado.
- Cada comentário contém informações completas sobre seu autor.
- O conteúdo retornado pode variar conforme futuras evoluções do editor de comentários da plataforma.
- Comentários adicionados por automações ou integrações também poderão ser retornados nesta consulta.
- O retorno da requisição pode variar conforme as permissões do usuário autenticado.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: