Retorna os cards de uma fase específica aplicando filtros avançados de consulta.

Este endpoint permite realizar pesquisas detalhadas dentro de uma fase do Board, possibilitando filtrar cards por campos personalizados, atributos do card, informações da fase e critérios relacionados ao tempo de permanência no fluxo.

É recomendado para integrações que necessitam gerar relatórios, realizar auditorias, acompanhar indicadores, sincronizar informações com sistemas externos ou executar consultas avançadas sobre os cards de uma determinada fase.

Diferentemente das consultas convencionais, este endpoint permite combinar múltiplos critérios de filtragem para obter resultados mais específicos e precisos.

Parâmetros utilizados

phaseId

Identificador único da fase que será consultada.

O ID deve ser informado diretamente na rota da requisição.

Exemplo:

POST https://api.goalfy.com.br/api/cards/phase/12345/advancedFilter?

Neste exemplo:

12345

Corresponde ao ID da fase onde a consulta será realizada.

Body Raw

{
    "title": "Filtro Goalfy",
    "conditionals": [
        {
            "firstField": "...",
            "logic": "...",
            "secondField": "...",
            "groupOperator": "...",
            "fieldType": "..."
        }
    ],
    "createdBy": "...",
    "contextId": "..."
}

Explicação das Keys

Exemplo prático

Fase Atual = Concluído

A condição será interpretada da seguinte forma:

Logic entre arrays e valores únicos

Valores do firstField para Atributos do Card

Como utilizar os campos para os firstFields?

Quando desejar criar um filtro utilizando um campo personalizado do formulário, o valor enviado em firstField deve ser o infoId desse campo.

O infoId é o identificador único utilizado pela API para localizar e comparar os valores armazenados no campo durante a execução do filtro.

Como criar mais de uma condicional?

Possuímos a função de criar mais de uma condicional, por exemplo:

{
   "firstField":"...",
   "logic":"DATETIME_IS",
   "secondField":"TODAY",
   "groupOperator":"AND", // A função que entra na operação AND
   "fieldType":"datetime-local"
},
{
   "firstField":"card_title",
   "logic":"TEXT_IS_EQUAL_TO",
   "secondField":"rascunho",
   "groupOperator":"AND", // A função que entra na operação AND
   "fieldType":"shortText"
},
{
   "firstField":"...",
   "logic":"TEXT_IS_EQUAL_TO",
   "secondField":"Vitor Hugo",
   "groupOperator":"OR", // A função que entra na operação OR
   "fieldType":"shortText"
}

Esse JSON segue o mesmo padrão do de baixo:

FAQ?

Perguntas frequentes que fazem.
Segue abaixo cards que podem te ajudar a tirar essas dúvidas: