Buscar Campos de um Board por Fase

Retorna todos os campos de formulário vinculados às fases de um Board específico, agrupados conforme cada fase existente no fluxo.

Este endpoint permite consultar a estrutura de campos utilizada no Board, facilitando integrações que necessitam identificar dinamicamente os campos disponíveis em cada fase do processo.

As informações retornadas podem incluir identificadores dos campos, nomes, tipos e demais configurações relacionadas aos formulários vinculados às fases do Board.

É recomendado para integrações que realizam preenchimento automático, criação dinâmica de formulários ou sincronização de dados entre sistemas externos.

Parâmetros utilizados

boardId

Identificador ú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/12345/fields

Neste exemplo:

12345

Corresponde ao ID do Board consultado.

Exemplo de Resposta

[
   {
      "phaseId":"11111",
      "phaseName":"Entrada",
      "fields":[
         {
            "fieldInfoId":"aaaa-bbbb-cccc",
            "name":"Razão Social",
            "type":"text"
         },
         {
            "fieldInfoId":"dddd-eeee-ffff",
            "name":"Telefone",
            "type":"phone"
         }
      ]
   },
   {
      "phaseId":"22222",
      "phaseName":"Qualificação",
      "fields":[
         {
            "fieldInfoId":"gggg-hhhh-iiii",
            "name":"CNPJ",
            "type":"text"
         }
      ]
   }
]

Observações

🚧

Importante

Os campos retornados podem variar conforme as permissões do usuário autenticado e a configuração do Board.

• Os campos são agrupados conforme a fase à qual pertencem.
• Alguns tipos de campo podem possuir estruturas diferentes dependendo da configuração do formulário.
• O fieldInfoId é utilizado em endpoints de preenchimento e atualização de campos.
• Recomenda-se armazenar os identificadores dos campos para integrações futuras.
• Boards sem fases ou formulários configurados podem retornar listas vazias.

FAQ?

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