Consultar uma entrada de lead

POST

/partner/v1/lead-intake/find

Situação de uma entrada pelo external_id: status, quantas tentativas houve, os ids do Cliente, da Oportunidade, do imóvel e da Visita (preenchidos conforme cada passo é concluído), o encaminhamento do atendimento (attendance), os warnings e, se falhou, o error. Enquanto status for RECEIVED, PROCESSING ou RETRY o processamento não terminou: consulte de novo em alguns segundos. Só enxerga as entradas enviadas por POST /partner/v1/lead-intake desta imobiliária. É 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

{
    "external_id": "LEAD-2210"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/partner/v1/lead-intake/find' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "external_id": "LEAD-2210"
}'

Responses

🟢200

application/json

Situação da entrada.

Bodyapplication/json

Example

{
    "external_id": "LEAD-2210",
    "status": "RECEIVED",
    "attempts": 1,
    "received_at": "2026-10-09T14:03:11.000Z",
    "processed_at": "2026-10-09T14:03:13.000Z",
    "lead_id": 900,
    "lead_created": true,
    "opportunity_id": 322,
    "property_id": 1500,
    "visit_id": 77,
    "attendance": "AWAITING_ACCEPTANCE",
    "realstate_agent_id": 42,
    "warnings": [
        {
            "code": "PROPERTY_NOT_FOUND",
            "detail": "AP-0042"
        }
    ],
    "error": {
        "code": "NO_OPEN_STEP",
        "message": "A imobiliária não tem etapa em andamento."
    }
}

🟠400

🟠401

🟠403

🟠404

🟠429

🔴500

Modified at 2026-10-10 23:31:35

Entregar um lead

Cadastrar oportunidade