Leads

Um lead é um contato interessado: alguém que preencheu um formulário no seu site ou em uma landing page. Esta seção cobre os dois lados do fluxo — criar leads (de qualquer origem) e listar os leads da sua empresa.

---

Criar um lead

Registra um novo lead no Crédito Semanal.

POST /public/leads

Aceita chave global ou de empresa — é seguro chamar a partir de um formulário público com a chave global.

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
name	string	sim	Nome do interessado
email	string	sim	E-mail para contato
phone	string	não	Telefone ou WhatsApp
company	string	não	Empresa do interessado
message	string	não	Mensagem ou observação livre
enterprise_id	number	não	Empresa dona do lead. Direciona o lead para uma empresa específica (ex.: a dona da landing /e/<slug>)
kind	string	não	Categoria do lead: partner, merchant, consumer ou contact. Padrão: contact
source	string	não	Origem do lead — recomendamos a URL da página (ex.: /e/sua-empresa)

Exemplo

curl -X POST https://server.creditosemanal.com.br/public/leads \
  -H "x-api-key: SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Maria Silva",
    "email": "maria@exemplo.com",
    "phone": "(32) 99999-0000",
    "enterprise_id": 42,
    "kind": "consumer",
    "source": "/e/sua-empresa"
  }'

Resposta — 201 Created

{ "result": { "id": 128 }, "meta": { "code": 201 } }

Erros possíveis

HTTP	error	Causa
400	missing_required_fields	name ou email não foram enviados
401	—	Chave ausente ou inválida

---

Listar os leads da sua empresa

Retorna, em ordem cronológica decrescente, os leads captados para a sua empresa.

GET /public/leads

Requer chave de empresa. A resposta contém somente os leads vinculados à empresa dona da chave — não é possível ler leads de outra empresa.

Parâmetros de query

Parâmetro	Padrão	Descrição
page	1	Página desejada
limit	20	Itens por página (máximo 100)

Exemplo

curl "https://server.creditosemanal.com.br/public/leads?page=1&limit=20" \
  -H "x-api-key: SUA_CHAVE_DE_EMPRESA"

Resposta — 200 OK

{
  "result": [
    {
      "id": 128,
      "kind": "consumer",
      "name": "Maria Silva",
      "email": "maria@exemplo.com",
      "phone": "(32) 99999-0000",
      "company": null,
      "message": null,
      "source": "/e/sua-empresa",
      "created_at": "2026-07-14T01:52:34.757Z"
    }
  ],
  "meta": { "code": 200, "total": 1, "page": 1, "per_page": 20, "pages": 1 }
}

Use meta.pages para paginar até o fim: incremente page enquanto for menor ou igual a pages.

---

Padrão recomendado

1. No seu formulário público, envie o lead com POST /public/leads usando a chave global e informe o source com a URL da página. 2. Do seu back-end, sincronize periodicamente com GET /public/leads usando a chave de empresa para trazer os novos leads ao seu CRM.