Listar campos da fase

GET

/v1/flows/{id}/phases/{phaseId}/fields

Retorna os campos customizados configurados em uma fase do flow — os campos exibidos e preenchidos pelos usuários enquanto um card permanece nessa etapa do processo.

A lista retornada inclui tanto os campos atualmente ativos quanto os campos removidos anteriormente: um campo removido não é apagado do histórico, permanecendo no retorno com active:false e index:null. Para identificar apenas os campos em uso na interface, filtre por active:true combinado com index diferente de null.

Recomendamos consultar este endpoint antes de qualquer atualização de campos (PUT .../fields), já que essa atualização substitui a lista inteira: os identificadores (id) dos campos existentes precisam ser reaproveitados no payload de atualização para que não sejam removidos por engano.

Requisição

Parâmetros de Caminho

Respostas

🟢200Campos da fase

application/json

Objeto contendo o array 'fields' com os campos configurados na fase, incluindo campos ativos e removidos (soft-deleted).

Bodyapplication/json

Response Example

{
    "fields": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "help": "string",
            "description": "string",
            "required": true,
            "editable": true,
            "active": true,
            "category": "default",
            "index": 0,
            "sectionMetadata": {
                "sectionId": "string",
                "sectionTitle": "string",
                "sectionIndex": 0
            },
            "options": [
                "string"
            ]
        }
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Campos — Visão Geral

Próxima página

Atualizar campos da fase