Listar produção própria
GET /leads
Lista, paginada, a produção (leads) que o próprio parceiro originou via esta API. Escopada
pelo parceiro autenticado a partir do token — nunca é possível ver produção de outro parceiro,
nem produção originada fora desta integração (ex.: Portal do Parceiro), em nenhuma combinação
de filtros.
Query params
| Param | Tipo | Obrigatório | Regras |
|---|---|---|---|
realEstateCnpj | string | Não | Exatamente 14 dígitos, sem pontuação, CNPJ válido — restringe a uma imobiliária, dentro da própria produção |
idApplication | string | Não | Identificador do lead — busca direta |
creId | string | Não | CRE-ID do corretor |
cpf | string | Não | CPF do lead — 11 dígitos, formatado ou não (12345678901 ou 123.456.789-01) |
zipcode | string | Não | CEP do imóvel — 8 dígitos, formatado ou não (01310100 ou 01310-100) |
page | integer | Não | Default 0. Mínimo 0 |
pageSize | integer | Não | Default 20. Entre 1 e 100 |
Filtros se combinam (E lógico). Parâmetro presente e vazio (?cpf=) é tratado como ausente.
cpfezipcodeaceitam máscara;realEstateCnpjnão. Divergência real do contrato —
os dois primeiros espelham a validação do serviço interno, que aceita as duas formas; o CNPJ
exige dígitos puros. Envie CNPJ sem pontuação.
Sucesso — 200 OK
{
"items": [
{
"idApplication": "rentals_abc123",
"profileAnalysisId": "rentals_pa_abc123xyz",
"idProtocol": "PROTO-0001",
"applicationStatus": "APPROVED",
"product": "RENT_GUARANTEE",
"createDate": "2026-09-01T12:00:00Z",
"realEstateCnpj": "11444777000161",
"realEstateName": "Real Estate Ltda.",
"rentAmount": 2500.0,
"contractStartDate": "2026-10-01",
"closingDate": null
}
],
"hasNext": true
}| Campo | Tipo | Descrição |
|---|---|---|
items[].idApplication | string | Identificador do lead — mesmo idApplication retornado por 6.2 |
items[].profileAnalysisId | string | null | preProfileAnalysisId de origem |
items[].idProtocol | string | null | Protocolo interno, quando existente |
items[].applicationStatus | string | Status interno da aplicação. Conjunto aberto — trate valor desconhecido defensivamente (seção 4); não é o mesmo enum fechado de decision em 6.2 |
items[].product | string | Produto de origem do lead |
items[].createDate | string (timestamp) | null | Data de criação |
items[].realEstateCnpj | string | null | CNPJ da imobiliária dona do lead |
items[].realEstateName | string | null | Nome da imobiliária |
items[].rentAmount | number | null | Valor do aluguel informado na originação |
items[].contractStartDate | string (date) | null | Data de início do contrato, quando já definida (objeto completo em 6.14) |
items[].closingDate | string (timestamp) | null | Data de fechamento, quando aplicável |
hasNext | boolean | Indica se há próxima página |
Paginação por offset, não por cursor. Divergência consciente do padrão desta API (a
paginação de 8.10 usa cursor) — dívida técnica assumida conscientemente para não introduzir
tradução de cursor nesta entrega. A resposta não traztotalElements/totalPages, só
hasNext. Para percorrer tudo, incrementepageatéhasNextvirfalse.
Só produção via API. Produção originada no Portal do Parceiro não aparece aqui, mesmo que
seja de uma imobiliária da sua rede.
Erros mapeados
| HTTP | code | Quando ocorre |
|---|---|---|
| 400 | LEAD_QUERY_INVALID | Qualquer filtro inválido: page/pageSize fora dos limites, ou realEstateCnpj/cpf/zipcode com formato inválido. details[] aponta o campo |
| 500 | LEAD_INTEGRATION_FAILURE | Falha de comunicação interna — repetir com backoff |
Updated about 2 hours ago
