Consultar formulário inicial

GET

/v1/flows/{id}/start-form/{startFormId}

Retorna a configuração completa do formulário inicial de um flow: metadados (título, cor de fundo, texto do botão, descrição, logotipo) e a lista completa de campos (fields), incluindo identificadores, tipos, seções e — quando configuradas — as regras condicionais associadas a cada campo.

Recomendamos consultar este endpoint antes de qualquer atualização de metadados ou de campos, para obter os identificadores atuais e os valores vigentes dos campos obrigatórios em uma atualização, como createButtonLabel e backgroundColor.

Requisição

Parâmetros de Caminho

Respostas

🟢200Formulário encontrado

application/json

Configuração completa do formulário inicial.

Bodyapplication/json

🟠404Formulário não encontrado

Response Example

200 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "description": "string",
    "logoUrl": "string",
    "backgroundColor": "string",
    "createButtonLabel": "string",
    "startFormPhaseId": "string",
    "flowId": "string",
    "fields": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "index": 0,
            "active": true,
            "editable": true,
            "required": true,
            "help": "string",
            "description": "string",
            "category": "string",
            "slug": "string",
            "uiComponent": "string",
            "sectionMetadata": {},
            "options": [
                "string"
            ],
            "rules": {}
        }
    ]
}

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

Página anterior

Atualizar metadados do formulário

Próxima página

Consultar formulário público