API atual/Referência completa/Newsletter e formulários

GETLeads de um formulário

Lista os contatos (leads) recebidos por um formulário do seller, com filtro por status e busca.

Cada vez que um visitante envia o formulário, a plataforma guarda um lead com as respostas em data. Use esta rota para puxar os leads para o seu CRM ou e-mail. É somente leitura para o seller.

GET/api/v1/vendor/forms/{id}/submissionsSeller

Lista os leads de um formulário

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id do formulário.

Parâmetros de consulta

statusstring

newreadreplied

Filtra por status do lead.

searchstring

Texto procurado em qualquer 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, de 1 a 100. Fora da faixa volta a 20.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/forms/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/submissions?status=new&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Leads

json

{
  "submissions": [
    {
      "id": "309c59af-40a0-4333-b2b6-93d6c37cb882",
      "form_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
      "form_name": "Fale com a loja",
      "data": {
        "nome": "Maria Souza",
        "email": "maria.souza@example.com",
        "assunto": "orcamento",
        "mensagem": "Quero 20 unidades."
      },
      "ip_address": "203.0.113.10",
      "user_agent": "Mozilla/5.0",
      "status": "new",
      "created_at": "2026-10-11T15:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

Campos da resposta

submissionsarray

Leads da página, do mais novo para o mais antigo.

iduuid

Id do lead.

form_iduuid

Formulário.

form_namestring

Nome do formulário.

dataobject

Respostas: uma chave por id de campo.

ip_addressstring

IP do visitante.

user_agentstring

Navegador do visitante.

statusstring

newreadreplied

new, read ou replied.

created_atstring

Quando foi enviado (RFC 3339, UTC).

totalinteger

Total de leads que atendem ao filtro.

pageinteger

Página devolvida.

per_pageinteger

Itens por página efetivos.

total_pagesinteger

Total de páginas.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário do seller (equipe) não tem nenhum dos privilégios exigidos. O dono da loja nunca recebe este erro.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`
403	O usuário autenticado não está vinculado a nenhum seller.	`{"error":"no vendor account associated with this user"}`
404	Formulário inexistente ou de outro seller.	`{"error":"FORM_NOT_FOUND"}`

Veja também

GETLeads de um formulário

Lista os contatos (leads) recebidos por um formulário do seller, com filtro por status e busca.

GET/api/v1/vendor/forms/{id}/submissionsSeller

Lista os leads de um formulário

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller. Veja Tokens.

Parâmetros de caminho

iduuidobrigatório

Id do formulário.

Parâmetros de consulta

statusstring

newreadreplied

Filtra por status do lead.

searchstring

Texto procurado em qualquer 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, de 1 a 100. Fora da faixa volta a 20.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/forms/7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60/submissions?status=new&per_page=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Leads

json

{
  "submissions": [
    {
      "id": "309c59af-40a0-4333-b2b6-93d6c37cb882",
      "form_id": "7f0c2b1e-5a43-4d8e-9a67-3c1d2e4f5a60",
      "form_name": "Fale com a loja",
      "data": {
        "nome": "Maria Souza",
        "email": "maria.souza@example.com",
        "assunto": "orcamento",
        "mensagem": "Quero 20 unidades."
      },
      "ip_address": "203.0.113.10",
      "user_agent": "Mozilla/5.0",
      "status": "new",
      "created_at": "2026-10-11T15:00:00Z"
    }
  ],
  "total": 1,
  "page": 1,
  "per_page": 20,
  "total_pages": 1
}

Campos da resposta

submissionsarray

Leads da página, do mais novo para o mais antigo.

iduuid

Id do lead.

form_iduuid

Formulário.

form_namestring

Nome do formulário.

dataobject

Respostas: uma chave por id de campo.

ip_addressstring

IP do visitante.

user_agentstring

Navegador do visitante.

statusstring

newreadreplied

new, read ou replied.

created_atstring

Quando foi enviado (RFC 3339, UTC).

totalinteger

Total de leads que atendem ao filtro.

pageinteger

Página devolvida.

per_pageinteger

Itens por página efetivos.

total_pagesinteger

Total de páginas.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido ou expirado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador).	`{"error":"insufficient permissions"}`
403	O usuário do seller (equipe) não tem nenhum dos privilégios exigidos. O dono da loja nunca recebe este erro.	`{"error":"insufficient vendor privileges","privilege_required_any":["vendor_settings","vendor_view_settings","vendor_manage_delivery_areas","vendor_manage_whatsapp","vendor_manage_documents","vendor_manage_kyc","vendor_view_plan","vendor_manage_application","vendor_manage_vacation"]}`
403	O usuário autenticado não está vinculado a nenhum seller.	`{"error":"no vendor account associated with this user"}`
404	Formulário inexistente ou de outro seller.	`{"error":"FORM_NOT_FOUND"}`