Consultar empreendimento - Homfy Public API

Devolve o empreendimento pelo partner_code OU pelo realty_cluster_id — informe um dos dois. Mandando os dois, vale o partner_code.

A consulta por id existe porque o id já circula fora daqui: POST /partner/v1/property/find e a busca de imóveis devolvem realty_cluster_id. É também o único jeito de consultar um empreendimento que a imobiliária cadastrou no painel, que não tem partner_code — nesse caso a resposta traz partner_code: null, e ele NÃO pode ser atualizado por esta API.

code é o código da Homfy, derivado da UF do endereço, e vem vazio enquanto não houver endereço. realty_cluster_id é o id interno — é ele que POST /partner/v1/property e PUT /partner/v1/property aceitam no campo realty_cluster_id, embora vincular pelos códigos, em POST /partner/v1/realty-cluster/link-property, seja o caminho recomendado.

O que esta rota não tem: não devolve a lista de imóveis do empreendimento, nem a contagem deles, nem as fotos, nem as comodidades do condomínio. Também não há rota de busca: a consulta é sempre por um código que você já conhece.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200

application/json

O empreendimento.

Bodyapplication/json

Example

{
    "partner_code": "AP-1024",
    "realty_cluster_id": 42,
    "code": "SC1547",
    "name": "Ana Corretora",
    "email": "ana@imobiliaria.com.br",
    "whatsapp": "48999998888",
    "created_at": "2026-08-19T20:33:39.719Z",
    "updated_at": "2026-08-19T20:33:39.719Z",
    "type": "string",
    "is_active": true,
    "description": "string",
    "phone": "string",
    "address": {
        "zipcode": "string",
        "state": "string",
        "city": "string",
        "district": "string",
        "street": "string",
        "street_number": "string",
        "street_type": "string",
        "reference": "string",
        "complement": "string",
        "block": "string",
        "latitude": "string",
        "longitude": "string"
    }
}

🟠400

🟠401

🟠403

🟠404

🟠429

🔴500