1. Imóvel
Homfy Public API
  • Bem vindo
  • Autenticação
    • Emitir token
      POST
    • Renovar token
      POST
  • Empreendimento
    • Cadastrar empreendimento
      POST
    • Atualizar empreendimento
      PUT
    • Cadastrar empreendimentos em lote
      POST
    • Consultar empreendimento
      POST
    • Vincular imóveis ao empreendimento
      POST
  • Imóvel
    • Cadastrar imóvel
      POST
    • Atualizar imóvel
      PUT
    • Cadastrar imóveis em lote
      POST
    • Consultar detalhes do imóvel
      POST
    • Enviar fotos — passo 1: obter URLs
      POST
    • Enviar fotos — passo 2: concluir
      POST
    • Andamento do processamento das fotos
      POST
    • Enviar documento — passo 1: obter URL
      POST
    • Enviar documento — passo 2: concluir
      POST
    • Buscar imóveis
      POST
  • Proprietário
    • Cadastrar proprietário
      POST
    • Atualizar proprietário
      PUT
    • Cadastrar proprietários em lote
      POST
    • Consultar detalhes do proprietário
      POST
    • Buscar proprietários
      POST
    • Vincular proprietário a imóvel
      POST
  • Cliente
    • Cadastrar cliente
      POST
    • Atualizar cliente
      PUT
    • Cadastrar clientes em lote
      POST
    • Consultar detalhes do cliente
      POST
    • Buscar clientes
      POST
    • Atribuir cliente a corretor
      POST
  • Corretor
    • Consultar corretores
  • Schemas
    • ApiPartnerAuthTokenDTO
    • ApiPartnerAuthTokenResponseDTO
    • ApiPartnerErrorResponseDTO
    • ApiPartnerAuthRefreshTokenDTO
    • ApiPartnerAddressDTO
    • ApiPartnerPropertyDetailDTO
    • ApiPartnerPropertyPriceDTO
    • ApiPartnerPropertyListingDTO
    • ApiPartnerPropertyRegisterDTO
    • ApiPartnerPropertyCreatedDTO
    • ApiPartnerPropertySkippedDTO
    • ApiPartnerPropertyErrorItemDTO
    • ApiPartnerPropertyRegisterResponseDTO
    • ApiPartnerPropertyItemDTO
    • ApiPartnerPropertyBatchRegisterDTO
    • ApiPartnerPropertyUpdateDTO
    • ApiPartnerPropertyUpdateResponseDTO
    • ApiPartnerPropertyFindDTO
    • ApiPartnerListingPriceDTO
    • ApiPartnerListingImageDTO
    • ApiPartnerListingVideoDTO
    • ApiPartnerListingResponseDTO
    • ApiPartnerPropertyDetailResponseDTO
    • ApiPartnerPhotoFileDTO
    • ApiPartnerPhotosInitDTO
    • ApiPartnerPresignedPartDTO
    • ApiPartnerPhotoUploadTargetDTO
    • ApiPartnerPhotosInitResponseDTO
    • ApiPartnerUploadPartDTO
    • ApiPartnerPhotoUploadDTO
    • ApiPartnerPhotosCompleteDTO
    • ApiPartnerPhotoCompleteItemDTO
    • ApiPartnerPhotosCompleteResponseDTO
    • ApiPartnerPhotosStatusDTO
    • ApiPartnerPhotoVariantDTO
    • ApiPartnerPhotoStatusItemDTO
    • ApiPartnerPhotosStatusResponseDTO
    • ApiPartnerDocumentInitDTO
    • ApiPartnerDocumentInitResponseDTO
    • ApiPartnerDocumentCompleteDTO
    • ApiPartnerDocumentCompleteResponseDTO
    • ApiPartnerPropertyFiltroDTO
    • ApiPartnerPropertySearchFiltersDTO
    • ApiPartnerSearchSortDTO
    • ApiPartnerPropertySearchDTO
    • ApiPartnerPropertySummaryDTO
    • ApiPartnerPropertySearchResponseDTO
    • ApiPartnerOwnerSpouseDTO
    • ApiPartnerOwnerRegisterDTO
    • ApiPartnerOwnerCreatedDTO
    • ApiPartnerOwnerSkippedDTO
    • ApiPartnerOwnerErrorItemDTO
    • ApiPartnerOwnerRegisterResponseDTO
    • ApiPartnerOwnerItemDTO
    • ApiPartnerOwnerBatchRegisterDTO
    • ApiPartnerOwnerUpdateDTO
    • ApiPartnerOwnerUpdateResponseDTO
    • ApiPartnerOwnerFindDTO
    • ApiPartnerOwnerSpouseResponseDTO
    • ApiPartnerOwnerDetailResponseDTO
    • ApiPartnerOwnerSearchSortDTO
    • ApiPartnerOwnerSearchFiltersDTO
    • ApiPartnerOwnerSearchDTO
    • ApiPartnerOwnerSummaryDTO
    • ApiPartnerOwnerSearchResponseDTO
    • ApiPartnerOwnerLinkPropertyDTO
    • ApiPartnerOwnerLinkResponseDTO
    • ApiPartnerLeadRegisterDTO
    • ApiPartnerLeadCreatedDTO
    • ApiPartnerLeadSkippedDTO
    • ApiPartnerLeadErrorItemDTO
    • ApiPartnerLeadRegisterResponseDTO
    • ApiPartnerLeadItemDTO
    • ApiPartnerLeadBatchRegisterDTO
    • ApiPartnerLeadUpdateDTO
    • ApiPartnerLeadUpdateResponseDTO
    • ApiPartnerLeadFindDTO
    • ApiPartnerLeadDetailResponseDTO
    • ApiPartnerLeadSearchSortDTO
    • ApiPartnerLeadSearchFiltersDTO
    • ApiPartnerLeadSearchDTO
    • ApiPartnerLeadSummaryDTO
    • ApiPartnerLeadSearchResponseDTO
    • ApiPartnerLeadAssignAgentDTO
    • ApiPartnerLeadAssignAgentResponseDTO
    • ApiPartnerAgentSearchFiltersDTO
    • ApiPartnerAgentSearchDTO
    • ApiPartnerAgentSummaryDTO
    • ApiPartnerAgentSearchResponseDTO
    • ApiPartnerRealtyClusterRegisterDTO
    • ApiPartnerRealtyClusterCreatedDTO
    • ApiPartnerRealtyClusterSkippedDTO
    • ApiPartnerRealtyClusterErrorItemDTO
    • ApiPartnerRealtyClusterRegisterResponseDTO
    • ApiPartnerRealtyClusterItemDTO
    • ApiPartnerRealtyClusterBatchRegisterDTO
    • ApiPartnerRealtyClusterUpdateDTO
    • ApiPartnerRealtyClusterAddressResponseDTO
    • ApiPartnerRealtyClusterDetailResponseDTO
    • ApiPartnerRealtyClusterFindDTO
    • ApiPartnerRealtyClusterLinkPropertiesDTO
    • ApiPartnerRealtyClusterLinkedDTO
    • ApiPartnerRealtyClusterLinkErrorDTO
    • ApiPartnerRealtyClusterLinkResponseDTO
  1. Imóvel

Buscar imóveis

POST
/partner/v1/property/search
Busca paginada no acervo da imobiliária. rows e page são OBRIGATÓRIOS para paginar: sem os dois a resposta é sempre a primeira página. page começa em 0 e o teto é 50 itens por página; itere até receber items vazio.
Os itens vêm em forma de resumo, com o partner_code de cada um — é por ele que você casa a lista com a sua base, sem uma chamada por imóvel. Imóvel que não veio da sua integração vem com partner_code: null: ele existe no acervo, aparece aqui, e não pode ser atualizado por esta API.
Para o imóvel inteiro, use POST /partner/v1/property/find com o partner_code.

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Example
{
    "rows": 50,
    "filters": {
        "code": {
            "value": "string",
            "matchMode": "in"
        },
        "status": {
            "value": "string",
            "matchMode": "in"
        },
        "type": {
            "value": "string",
            "matchMode": "in"
        },
        "purpose": {
            "value": "string",
            "matchMode": "in"
        },
        "contract": {
            "value": "string",
            "matchMode": "in"
        },
        "state": {
            "value": "string",
            "matchMode": "in"
        },
        "cities": {
            "value": "string",
            "matchMode": "in"
        },
        "dormitorios": {
            "value": "string",
            "matchMode": "in"
        },
        "banheiros": {
            "value": "string",
            "matchMode": "in"
        },
        "suites": {
            "value": "string",
            "matchMode": "in"
        },
        "garagens": {
            "value": "string",
            "matchMode": "in"
        },
        "area_total": {
            "value": "string",
            "matchMode": "in"
        },
        "price_sale": {
            "value": "string",
            "matchMode": "in"
        },
        "price_rental": {
            "value": "string",
            "matchMode": "in"
        },
        "nro_matricula": {
            "value": "string",
            "matchMode": "in"
        },
        "listing_display_on_site": {
            "value": "string",
            "matchMode": "in"
        },
        "realty_cluster_id": {
            "value": "string",
            "matchMode": "in"
        },
        "realty_cluster_code": {
            "value": "string",
            "matchMode": "in"
        },
        "search_text": {
            "value": "string",
            "matchMode": "in"
        },
        "id": {
            "value": "string",
            "matchMode": "in"
        },
        "property_owner_id": {
            "value": "string",
            "matchMode": "in"
        },
        "updated_since": {
            "value": "string",
            "matchMode": "in"
        }
    },
    "page": 0,
    "select": [
        "id",
        "code",
        "status"
    ],
    "selectAll": false,
    "multiSort": [
        {
            "field": "id",
            "order": 1
        }
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/partner/v1/property/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "rows": 50,
    "filters": {
        "code": {
            "value": "string",
            "matchMode": "in"
        },
        "status": {
            "value": "string",
            "matchMode": "in"
        },
        "type": {
            "value": "string",
            "matchMode": "in"
        },
        "purpose": {
            "value": "string",
            "matchMode": "in"
        },
        "contract": {
            "value": "string",
            "matchMode": "in"
        },
        "state": {
            "value": "string",
            "matchMode": "in"
        },
        "cities": {
            "value": "string",
            "matchMode": "in"
        },
        "dormitorios": {
            "value": "string",
            "matchMode": "in"
        },
        "banheiros": {
            "value": "string",
            "matchMode": "in"
        },
        "suites": {
            "value": "string",
            "matchMode": "in"
        },
        "garagens": {
            "value": "string",
            "matchMode": "in"
        },
        "area_total": {
            "value": "string",
            "matchMode": "in"
        },
        "price_sale": {
            "value": "string",
            "matchMode": "in"
        },
        "price_rental": {
            "value": "string",
            "matchMode": "in"
        },
        "nro_matricula": {
            "value": "string",
            "matchMode": "in"
        },
        "listing_display_on_site": {
            "value": "string",
            "matchMode": "in"
        },
        "realty_cluster_id": {
            "value": "string",
            "matchMode": "in"
        },
        "realty_cluster_code": {
            "value": "string",
            "matchMode": "in"
        },
        "search_text": {
            "value": "string",
            "matchMode": "in"
        },
        "id": {
            "value": "string",
            "matchMode": "in"
        },
        "property_owner_id": {
            "value": "string",
            "matchMode": "in"
        },
        "updated_since": {
            "value": "string",
            "matchMode": "in"
        }
    },
    "page": 0,
    "select": [
        "id",
        "code",
        "status"
    ],
    "selectAll": false,
    "multiSort": [
        {
            "field": "id",
            "order": 1
        }
    ]
}'

Responses

🟢200
application/json
Página de imóveis, com total.
Bodyapplication/json

Example
{
    "total": 526,
    "items": [
        {
            "partner_code": "AP-1024",
            "code": "SC1547",
            "realty_cluster_id": 42,
            "created_at": "2026-08-19T20:33:39.719Z",
            "updated_at": "2026-08-19T20:33:39.719Z",
            "id": 0,
            "type": "string",
            "purpose": "string",
            "contract": "string",
            "status": 0
        }
    ]
}
🟠400
🟠401
🟠403
🟠429
🔴500
Modified at 2026-08-20 16:06:11
Previous
Enviar documento — passo 2: concluir
Next
Cadastrar proprietário
Built with