Buscar oportunidades - Homfy Public API

Busca paginada entre as oportunidades da imobiliária — TODAS elas, inclusive as que nasceram no painel (essas voltam sem partner_code, e as demais rotas só sabem falar por partner_code: use a busca para reconciliar a sua base).

page começa em 0 e o teto é 50 por página; itere até receber items vazio. Filtros por cliente (lead_partner_code ou lead_id, não os dois), corretor, situação e etapa. lead_partner_code que não existe devolve lista vazia.

Para sincronização incremental use filters.updated_since (data ISO 8601, borda inclusiva) com multiSort: [{ "field": "updated_at", "order": 1 }], paginando até items vir vazio, e guarde o maior updated_at recebido para a próxima execução. Mover a oportunidade de etapa no painel também a faz reaparecer na janela.

Oportunidade excluída não aparece. O token de corretor se comporta como nas demais rotas: o recorte é a imobiliária, e o corretor do token não restringe a lista.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "rows": 50,
    "page": 0,
    "multiSort": [
        {
            "field": "id",
            "order": 1
        }
    ],
    "filters": {
        "updated_since": "2026-08-19T20:33:39.719Z",
        "partner_code": "NEG-2210",
        "lead_partner_code": "CLI-8842",
        "status": "Em andamento",
        "lead_id": 900,
        "realstate_agent_id": 42,
        "deal_workflow_step_id": 31
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

Página de oportunidades, com total.

Bodyapplication/json

Example

{
    "total": 526,
    "items": [
        {
            "partner_code": "NEG-2210",
            "id": 322,
            "status": "Em andamento",
            "lead": {
                "id": 900,
                "partner_code": "CLI-8842",
                "name": "Ana Pereira"
            },
            "realstate_agent": {
                "id": 42,
                "name": "Bruno Souza"
            },
            "deal_workflow_id": 3,
            "deal_workflow_step": {
                "id": 31,
                "name": "Negociação"
            },
            "min_price": 300000,
            "max_price": 500000,
            "purpose": [
                "Residencial"
            ],
            "type": [
                "Apartamento"
            ],
            "contract": [
                "Venda"
            ],
            "dormitorio": [
                2,
                3
            ],
            "banheiro": [
                1
            ],
            "suite": [
                0
            ],
            "garagem": [
                1
            ],
            "expected_closing": "2026-12-01",
            "notes": "Quer varanda.",
            "created_at": "2026-10-08T14:03:11.000Z",
            "updated_at": "2026-10-08T14:03:11.000Z"
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500