VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Formulários

GETRespostas do formulário

Lista as respostas que os clientes enviaram a um formulário, com filtro por andamento e busca.

Devolve as respostas enviadas pelos clientes a esse formulário, da mais nova para a mais antiga. O conteúdo de cada resposta está em data, com uma chave por campo do formulário (o id do campo).

GET/api/v1/admin/forms/{id}/submissionsAdmin

Lista as respostas recebidas por um formulário

Rota ligada ao módulo custom-forms: com o módulo desligado a resposta é 403. Leitura exige manage_content ou view_content; escrita exige manage_content.

Parâmetros de caminho

iduuidobrigatório
Identificador do formulário.

Parâmetros de consulta

statusstring
newreadreplied
Filtra pelo andamento.
searchstring
Texto contido em qualquer valor da resposta (nome, e-mail, mensagem...), sem diferenciar maiúsculas.
pageintegerpadrão: 1
Página, a partir de 1.
per_pageintegerpadrão: 20
Itens por página, 1 a 100; fora disso vale 20.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/forms/71464e65-00e2-4dbc-b9c8-61c2966008fc/submissions?status=new" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Respostas
json
{
  "submissions": [
    {
      "id": "0c9f2f60-5d2f-4a39-8a5e-0d6f2e5b7c21",
      "form_id": "71464e65-00e2-4dbc-b9c8-61c2966008fc",
      "form_name": "Fale conosco",
      "data": {
        "nome": "Maria Souza",
        "assunto": "duvida",
        "mensagem": "Qual o prazo de entrega?"
      },
      "ip_address": "203.0.113.10",
      "user_agent": "Mozilla/5.0",
      "status": "new",
      "created_at": "2026-10-11T18:30:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

Campos da resposta

submissionsarray

Respostas da página.

iduuid
Identificador da resposta.
form_iduuid
Formulário.
form_namestring
Nome do formulário.
dataobject
Valores enviados, uma chave por id de campo. Dados pessoais: trate conforme a LGPD.
ip_addressstring
IP de origem, quando registrado.
user_agentstring
Navegador de origem, quando registrado.
statusstring
new, read ou replied.
created_atstring
Envio, RFC 3339.
totalinteger
Total que atende ao filtro.
pageinteger
Página devolvida.
per_pageinteger
Itens por página usados.
total_pagesinteger
Total de páginas.

Erros

StatusQuandoExemplo de corpo
401Token ausente, inválido ou expirado.{"error":"invalid or expired token"}
403O administrador não tem o privilégio exigido.{"error":"insufficient privileges","privilege_required_any":["manage_content","view_content"]}
500id que não é UUID, ou falha de banco.{"error":"SUBMISSION_LIST_FAILED","detail":"..."}
Uma consulta de um formulário que não existe

Com um id bem formado mas inexistente, a lista volta vazia (200), não 404.

Veja também

  • Listar e consultar formulários
  • Alterar e apagar formulário
Anterior
Alterar e apagar formulário
Próxima
Newsletter
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também