Consultar detalhes do cliente

POST

/partner/v1/lead/find

Qualificação completa pelo partner_code: contato, documento, perfil e o corretor responsável. É POST, e não GET com o código no caminho, porque o código é do sistema do parceiro e pode conter barra, espaço ou acento.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "partner_code": "CLI-8842"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/partner/v1/lead/find' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "partner_code": "CLI-8842"
}'

Responses

🟢200

application/json

Detalhe do cliente.

Bodyapplication/json

Example

{
    "partner_code": "AP-1024",
    "lead_id": 900,
    "status": 1,
    "realstate_agent_id": 42,
    "name": "Ana Corretora",
    "whatsapp": "48999998888",
    "email": "ana@imobiliaria.com.br",
    "segment": "Investidor",
    "message_consent": "GRANTED",
    "document_type": "cpf",
    "birth_date": "1985-03-14",
    "created_at": "2026-08-19T20:33:39.719Z",
    "updated_at": "2026-08-19T20:33:39.719Z",
    "phone": "string",
    "address_state": "string",
    "address_city": "string",
    "notes": "string",
    "document": "string",
    "rg": "string",
    "profession": "string",
    "marital_status": "string"
}

🟠400

🟠401

🟠403

🟠404

🟠429

🔴500

Modified at 2026-08-20 16:06:11

Cadastrar clientes em lote

Buscar clientes