Imóveis

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Imóveis</aside>
get/buildings

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/buildings
  • Auth: HTTP bearer

Query parameters

sortstring

Campo para ordenar os registros

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:id,title,slug,type_id
filter[id]integer

ID do imóvel.

Example:1
filter[id2]integer

ID visível do imóvel.

Example:11
filter[condominium_id]integer

ID do condomínio.

Example:13
filter[reference]string

Referência.

Example:CA001
filter[status]string

Status.

Example:active
filter[lock]string

Bloqueio do imóvel.

Example:free
filter[type_id]integer

ID do Tipo do imóvel.

Example:1
filter[stage_id]integer

ID do estágio.

Example:2
filter[country_id]integer

ID do País.

Example:1
filter[state_id]integer

ID do estado.

Example:24
filter[city_id]integer

ID da cidade.

Example:8650
filter[district_id]integer

ID do bairro.

Example:1
filter[tags]integer[]

Tags do imóvel.

[
  1,
  2
]
filter[responsible]integer[]

IDs dos responsáveis.

[
  1
]
filter[constructor_id]integer

ID da construtora.

Example:1
filter[access]string

Tipo de Acesso.

Example:all
filter[pickup]integer

ID do usuário que captou o imóvel.

Example:123
filter[slug]string

Link permanente para site.

Example:exemplo-perma-link
filter[expiration]boolean

Expiração do imóvel ativa.

filter[expiration_date]string

Data da expiração do imóvel.

Example:2024-03-20
filter[active]boolean

Imóvel Ativo.

Example:true
filter[import_id]string

Referência do sistema externo.

Example:CA001
filter[principal_media]string

Mídia principal.

Example:https://...
filter[purpose_featured]string

Finalidade em destaque.

Example:rent
filter[position]integer

Ordem do imóvel.

Example:1
filter[occupancy]string

Ocupação do imóvel.

Example:vacant
filter[garage]integer

Quantidade mínima de garagens.

Example:1
filter[garage_number]integer

Número da Vaga.

Example:123
filter[suite]integer

Quantidade mínima de Suítes.

Example:1
filter[room]integer

Quantidade mínima de Salas.

Example:1
filter[bathroom]integer

Quantidade mínima de Banheiros.

Example:1
filter[bedroom]integer

Quantidade mínima de Quartos.

Example:3
filter[conservation]string

Conservação do imóvel.

Example:Bem conservado
filter[built_year]integer

Ano de construção.

Example:2000
filter[floor]integer

Andar do imóvel.

Example:2
filter[total_floors]integer

Quantidade de Andares.

Example:4
filter[total_by_floors]integer

Apartamentos por Andar.

Example:2
filter[blocks]integer

Quantidade de Blocos do condomínio.

Example:2
filter[accommodates]integer

Quantidade de Pessoas que acomoda.

Example:5
filter[furnishing]string

Status da mobília.

Example:furnished
filter[title]string

Titulo do imóvel.

Example:Título Exemplar
filter[plate]string

Status da placa.

Example:without
filter[content]string

HTML de Descrição do imóvel.

Example:<p>Imóvel de Exemplo!</p>
filter[lock_description]string

Observações do bloqueio.

Example:Fim da Locação
filter[area_total]string

numeric Área total mínima.

Example:123
filter[area_private]string

numeric Área privada mínima.

Example:123
filter[area_useful]string

numeric Área útil mínima.

Example:123
filter[area_ground]string

numeric Área do terreno.

Example:12
filter[area_front]string

numeric Frente do imóvel.

Example:21
filter[area_length]string

numeric Comprimento do imóvel.

Example:132
filter[area_back]string

numeric Fundos do imóvel.

Example:123
filter[street]string

Rua do imóvel.

Example:Rua Guanabara
filter[number]integer

número do imóvel.

Example:1
filter[complement]string

Complemento do imóvel.

Example:Apartamento
filter[reference_point]string

Ponto de referência.

Example:Bar do Seu Zé
filter[building_name]string

Nome do empreendimento.

Example:Guanabara Prime
filter[zip_code]integer

CEP do imóvel.

Example:89160000
filter[amount_updated_at]string

Date Data de Atualização dos valores.

Example:2024-01-01
filter[delivery_date]string

Date Data de entrega.

Example:2024-05-01
filter[show_address]boolean

Divulga Endereço.

Example:true
filter[show_number]boolean

Divulga Número.

Example:true
filter[show_complement]boolean

Divulga Complemento.

Example:true
filter[map]boolean

Divulga Mapa.

filter[map_street]boolean

Divulga Mapa da Rua.

filter[map_info]string[]

Infos do mapa.

filter[map_around]boolean

Ofuscar ponto exato no mapa.

filter[iptu_reference]string

Inscrição de IPTU.

Example:12321321
filter[energy_reference]string

Matrícula de inscrição de Energia.

Example:12321313
filter[water_reference]string

Matrícula de inscrição de Água.

Example:213213
filter[gas_reference]string

Matrícula de inscrição de gás.

Example:23213213-12
filter[incorporation_reference]string

Inscrição de Incorporação.

Example:213213123.223
filter[notes]string

Observações.

Example:Observações do imóvel
filter[virtual_tour]string

Link do Tour Virtual.

Example:https://...
filter[html_title]string

Título da página (HTML title).

Example:SEO Título
filter[html_keyword]string

Palavras Chave (HTML Keyword). Example:

Example:nesciunt
filter[html_description]string

descrição SEO.

Example:SEO,chave
filter[system_featured]boolean

Destaque no Site.

Example:true
filter[thirdparty_featured]string

Destaque nos Portais.

Example:disabled
filter[uses_calendar]string

Uso do calendário.

Example:disabled
filter[watermark]boolean

Usa Marca d'água.

Example:true
filter[exclusivity]boolean

Exclusividade.

filter[head_code]string

Códigos para Plugins Específicos dentro da tag Head.

Example:function example(foo,bar){...}
filter[status_bar]boolean

Barra de Status ativa.

filter[status_bar_content]string

Conteúdo da Barra de Status.

Example:Sem conteúdo
filter[status_bar_color]string

Cor da Barra de Status.

Example:ff00fa
filter[owner_report]boolean

Notificação para o Proprietário.

Example:true
include[purposes]string

Retorna os dados das finalidades do imóvel.

Example:type,amount
include[contracts]string

Retorna os dados de contratos do imóvel.

Example:type,status
include[rentActive]string

Retorna contrato de locação ativo/reservado.

Example:type,example
include[details]string

Retorna os dados dos detalhes do imóvel.

Example:id,description
include[tabs]string

Retorna os dados das abas do imóvel.

Example:id,tlte
include[keys]string

Retorna os dados das chaves do imóvel.

Example:id,reference
include[seasonPacks]string

Retorna os pacotes de temporadas do imóvel.

Example:id,description
include[unavailableDates]string

Retorna as datas indisponíveis do imóvel.

Example:id,date
include[tickets]string

Retorna os tickets abertos para o imóvel.

Example:id,title,notes
include[inspects]string

Retorna as vistorias do imóvel.

Example:id,type,status
include[constructor]string

Retorna a construtora.

Example:id,name
include[type]string

Retorna os dados do tipo do imóvel.

Example:id,description
include[category]string

Retorna os dados da categoria do imóvel.

Example:id,description
include[stage]string

Retorna os dados do estágio do imóvel.

Example:id,description
include[catcher]string

Retorna os dados dos corretores captadores do imóvel.

Example:id,name
include[responsibles]string

Retorna os dados dos corretores responsáveis do imóvel.

Example:id,name
include[responsibleGroups]string

Retorna os dados dos corretores responsáveis do imóvel.

Example:id,name
include[owners]string

Retorna os dados dos proprietários dos imóveis.

Example:id,name
include[ownersPivot]string

Retorna os dados de distribuição de renda dos proprietários.

Example:person_id,percentage,principal
include[country]string

Retorna o País do imóvel.

Example:id,name
include[city]string

Retorna a Cidade do imóvel.

Example:id,name
include[state]string

Retorna o Estado do imóvel.

Example:id,name
include[district]string

Retorna o Bairro do imóvel.

Example:id,name
include[principal]string

Retorna a imagem principal do imóvel.

Example:file_name
include[enterprise]string

Retorna as imagens do Empreendimento.

Example:file_name
include[images]string

Retorna a galeria de imagens do imóvel.

Example:file_name
include[plants]string

Retorna galeria de imagens de plantas do imóvel.

Example:file_name
include[documents]string

Retorna os documentos públicos do imóvel.

Example:file_name
include[files]string

Retorna os documentos do imóvel restritos à imobiliária.

Example:file_name
include[condominium]string

Retorna os dados do condomínio.

Example:id,title
include[tags]string

Retorna as Tags do imóvel. Example:

Example:quas
include[deals]string

Retorna os negócios com o imóvel.

Example:id,title
include[events]string

Retorna os eventos para o imóvel.

Example:id,type
include[leads]string

Retorna os leads desse imóvel.

Example:id,name,phone,email
include[proposals]string

Retorna as propostas feitas para o imóvel. Example:

Example:iusto
include[proposalsActive]string

Retorna os dados das propostas pendentes ou aceitas do imóvel.

Example:id,notes,status
include[proposalAccepted]string

Retorna os dados das propostas aceitas do imóvel.

Example:id,notes,deal_id
include[exchangeStage]string

Retorna os estágios de imóvel (radar de permuta).

Example:id,description
include[exchangeType]string

Retorna os tipos de imóvel (radar de permuta).

Example:id,description
include[exchangeDetails]string

Retorna os detalhes(radar de permuta).

Example:id,description
include[exchangeCity]string

Retorna as cidades (radar de permuta).

Example:id,name
include[exchangeDistrict]string

Retorna os bairros (radar de permuta).

Example:id,name,abbreviation

Changes

No recorded changes to this operation across all 1 revision of this API.