| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Retorna uma lista de cards vinculados a um Board específico, permitindo aplicar filtros opcionais de pesquisa textual, datas e paginação.
Este endpoint é recomendado para integrações que necessitam consultar grandes volumes de cards de forma otimizada, possibilitando buscas específicas dentro do Board através de parâmetros de filtro.
Os filtros podem ser utilizados individualmente ou combinados para refinar os resultados da consulta.
Parâmetros utilizados
boardId
boardIdIdentificador ú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/cards/board/12345/filterNeste exemplo:
12345
Corresponde ao ID do Board consultado.
Query Params disponíveis
Os filtros abaixo podem ser adicionados diretamente na URL da requisição.
| Parâmetro | Tipo | Descrição |
|---|---|---|
limit | integer | Quantidade máxima de registros retornados por requisição. |
offset | integer | Número da página da consulta. O valor inicial é 1. |
search | string | Realiza busca textual por valores dentro do Card. |
startDueDate | ISO 8601 Date | Filtra cards com vencimento a partir da data informada. |
endDueDate | ISO 8601 Date | Filtra cards com vencimento até a data informada. |
startCreatedAt | ISO 8601 Date | Filtra cards criados a partir da data informada. |
endCreatedAt | ISO 8601 Date | Filtra cards criados até a data informada. |
Exemplo utilizando filtros de datas
GET https://api.goalfy.com.br/api/cards/board/12345/filter?limit=10&offset=1&startCreatedAt=2026-03-01T00:00:00&endCreatedAt=2026-03-30T00:00:00
Importante sobre filtros de data
Os filtros de período devem ser utilizados sempre em pares.Se informar
startCreatedAt, também é obrigatório informarendCreatedAt.Da mesma forma, se informar
startDueDate, também é obrigatório informarendDueDate.Exemplos válidos:
startCreatedAt+endCreatedAtstartDueDate+endDueDateExemplos inválidos:
- Apenas
startCreatedAt- Apenas
endCreatedAt- Apenas
startDueDate- Apenas
endDueDate
Exemplo de Resposta
{
"cards":[
{
"id":"10001",
"title":"Goalfy",
"phase":"Em andamento",
"responsible":"Goalfy",
"dueDate":"2026-03-15T12:00:00Z"
},
{
"id":"10002",
"title":"Goalfy",
"phase":"Concluído",
"responsible":"Goalfy",
"dueDate":"2026-03-20T18:00:00Z"
}
]
}
Respostas esperadas
Sucesso200Retorna uma lista paginada de cards compatíveis com os filtros informados.
Possíveis erros
400 Bad RequestRetornado quando algum parâmetro foi enviado em formato inválido.
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
ImportanteAs datas devem obrigatoriamente ser enviadas no formato ISO 8601 completo (YYYY-MM-DDTHH:MM:SS).
Exemplo válido:
2026-03-01T00:00:00
Exemplo inválido:
2026-03-01
- O formato de data incompleto pode causar erro no backend.
- Os filtros podem ser utilizados individualmente ou combinados.
- Recomenda-se utilizar paginação em consultas com grande volume de cards.
- Dependendo das permissões do usuário autenticado, alguns cards podem não ser retornados.
- A busca textual realizada em search considera o título do card.
FAQ?
Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: