| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retorna todas as informações de um Board específico utilizando seu identificador único (id).
Este endpoint permite consultar os dados completos de um Board dentro da plataforma, incluindo informações relacionadas à estrutura do fluxo, fases, configurações e demais dados disponíveis conforme as permissões do usuário autenticado.
É recomendado para integrações que necessitam consultar informações detalhadas de um Board específico antes de realizar operações relacionadas a cards, fases ou automações.
Parâmetros utilizados
id do Board
id do BoardIdentificador único do Board que será consultado.
O ID deve ser informado diretamente na rota da requisição.
Exemplo:
GET https://api.goalfy.com.br/api/boards/{id}Neste exemplo:
12345
Corresponde ao ID do Board consultado.
Exemplo de Resposta
{
"id": "12345",
"name": "Comercial",
"description": "Board responsável pelo fluxo comercial",
"createdAt": "2026-06-03T10:00:00Z",
"status": "active"
}
Possíveis erros
404 Not FoundRetornado quando o Board 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 o Board informado.
Observações
ImportanteO retorno da requisição pode variar conforme as permissões do usuário autenticado.
- Alguns dados do Board podem não ser exibidos dependendo das permissões do usuário.
- Certifique-se de informar um ID válido na rota da requisição.
- Boards arquivados ou desativados podem apresentar comportamentos diferentes dependendo das regras da organização.
- Recomenda-se armazenar o ID do Board para futuras consultas relacionadas a cards e fases.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: