Dados dos formulários dos membros

Recupera as respostas dos campos de formulário preenchidos pelos assinantes, em JSON estruturado.

Quando você define formFields[] na criação da operação, os assinantes preenchem esses campos antes de assinar. Esse endpoint devolve todas as respostas estruturadas em JSON — útil pra alimentar seu CRM, banco de dados, ou regras de negócio internas que dependem do que o cliente declarou.

Quando usar

Você criou uma operação com formulário (formFields[] em members[])
Precisa puxar as respostas pra processar internamente após a assinatura
Quer auditar o que cada assinante declarou
Está construindo um painel próprio com as respostas

Endpoint

Authorization

ApiKey

X-Api-Key<token>

Token de integracao. Envie no header X-Api-Key.

In: header

Path Parameters

operationId*integer

Formatint64

Query Parameters

memberId?integer

Formatint64

Header Parameters

Response Body

curl -X GET "https://example.com/api/v2/operations/0/forms"

{
  "data": {
    "operationCompanyId": 0,
    "members": [
      {
        "memberId": 0,
        "memberName": "string",
        "memberEmail": "string",
        "formTitle": "string",
        "formDescription": "string",
        "fields": [
          {
            "fieldId": 0,
            "fieldName": "string",
            "fieldValue": "string",
            "fieldType": "string",
            "type": "string",
            "required": true,
            "multiple": true,
            "variant": "string",
            "selectedOptions": [
              "string"
            ],
            "order": 0
          }
        ]
      }
    ]
  }
}

Parâmetros

Local	Campo	Tipo	Obrigatório	Descrição
Path	`operationId`	`long`	Sim	ID da operação — o campo `id` da criação. É o mesmo número usado em todos os endpoints da operação. Precisa ser `> 0`.
Query	`memberId`	`long`	Não	Filtra por um assinante específico. Sem ele, retorna respostas de todos os membros da operação.

Resposta

{
  "data": {
    "operationCompanyId": 12345,
    "members": [
      {
        "memberId": 35845,
        "memberName": "Claudio Nogueira",
        "memberEmail": "[email protected]",
        "formTitle": "Preencha os dados abaixo",
        "formDescription": null,
        "fields": [
          {
            "fieldId": 901,
            "fieldName": "Nome da mãe",
            "fieldValue": "Maria Silva",
            "fieldType": "Text",
            "type": "Others",
            "required": true,
            "multiple": false,
            "variant": null,
            "selectedOptions": null,
            "order": 0
          },
          {
            "fieldId": 902,
            "fieldName": "Estado civil",
            "fieldValue": "Casado, Comunhão parcial",
            "fieldType": "Select",
            "type": "Others",
            "required": true,
            "multiple": true,
            "variant": null,
            "selectedOptions": ["Casado", "Comunhão parcial"],
            "order": 1
          }
        ]
      }
    ]
  }
}

Campos por item

Caminho	Tipo	Descrição
`members[].memberId`	`long`	ID do assinante (use no `?memberId=` pra filtrar).
`members[].memberName` / `memberEmail`	string	Identificação do assinante.
`members[].formTitle` / `formDescription`	string \| null	Cabeçalho exibido ao assinante (vem da criação).
`fields[].fieldId`	`long`	ID do campo.
`fields[].fieldName`	string	Nome exibido (ex: "Nome da mãe").
`fields[].fieldValue`	string	Resposta crua. Quando `multiple=true`, vem como string com valores separados por `,` .
`fields[].fieldType`	enum	Tipo de input: `Text`, `Date`, `Select`, `Textarea`, etc.
`fields[].type`	enum	Categoria semântica: `Name`, `Email`, `DateNow`, `Others`. Os 3 primeiros são preenchidos automaticamente.
`fields[].required`	bool	Se o assinante foi obrigado a preencher.
`fields[].multiple`	bool	`true` para múltipla escolha (campos do tipo `Select` com várias opções).
`fields[].variant`	string \| null	Variante visual (ex: `Radio`, `Checkbox`) quando aplicável.
`fields[].selectedOptions`	string[] \| null	Apenas para `multiple=true`: lista de opções marcadas.
`fields[].order`	int	Ordem de exibição no formulário.

Campos com type em Name, Email e DateNow são preenchidos automaticamente pelo sistema (com os dados do assinante e o momento da assinatura) e também aparecem aqui — não confunda esses com dados que o assinante digitou.

Erros comuns

HTTP	Quando acontece
`400`	`operationId` informado é `0` ou negativo.
`401`	API key ausente ou inválida.
`403`	Sua API key não tem permissão para acessar esta operação.
`404`	`operationId` não existe na sua conta (ou você não tem acesso a ela).

Observações

Pode ser chamado mesmo com a operação ainda em andamento — você recebe as respostas dos membros que já preencheram, sem esperar a conclusão.
Se preferir as respostas em CSV (em vez de JSON), use o download em ZIP — ele inclui o arquivo dados-de-formulario-{operationId}.csv.

Veja também

Criar operação — definição dos formFields[]
Download em ZIP — mesmas respostas em CSV
Download Base64 — documento individual assinado

Dados dos formulários dos membros

200text/plain

On this page