Consultar formulário público

GET

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

Retorna a versão pública do formulário inicial, no formato utilizado pela página de preenchimento voltada a quem solicita — o mesmo conteúdo exibido fora de uma sessão de usuário autenticada da plataforma.

Esta chamada requer o cabeçalho ag-flow-id, contendo o mesmo identificador de flow já presente no caminho.

Requisição

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200Formulário público

application/json

Conteúdo do formulário inicial no formato exibido na página pública de preenchimento.

Bodyapplication/json

🟠404Formulário não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//start-form//public' \
--header 'ag-flow-id;'

Response Example

200 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "description": "string",
    "logoUrl": "string",
    "backgroundColor": "string",
    "createButtonLabel": "string",
    "fields": [
        {
            "id": "string",
            "name": "string",
            "type": "string",
            "required": true,
            "help": "string",
            "options": [
                "string"
            ],
            "sectionMetadata": {}
        }
    ]
}

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

Página anterior

Consultar formulário inicial

Próxima página

Atualizar campos do formulário