---
title: "Retorna os portais (anúncios) dos imóveis do Imoview CRM"
method: POST
path: "/Imovel/RetornarPortaisImoveis"
tags: ["Imóveis"]
---

# Retorna os portais (anúncios) dos imóveis do Imoview CRM

`POST /Imovel/RetornarPortaisImoveis`

## Request

- Base URL: `https://api.imoview.com.br`
- URL: `https://api.imoview.com.br/Imovel/RetornarPortaisImoveis`
- Auth: API key in header `chave`

Retorno JSON dos portais de cada imóvel do imoview CRM: situação, tipo de destaque, datas de envio, mensagem do último envio e código do imóvel no portal.<br><br>Informe <strong>codigosimoveis</strong> e/ou <strong>codigoportal</strong> - ao menos um dos dois é obrigatório.<br><strong>codigoportal = 0</strong> significa 'meu site', que não é um vínculo de portal: ele vem nos campos <strong>exibirmeusite</strong> e <strong>tipodestaquesite</strong> do imóvel (com codigoportal = 0 o array portais volta vazio).<br>Pesquisando por <strong>codigosimoveis</strong> (máximo 200 códigos), o retorno traz os portais em qualquer situação, sem paginação, e aceita também unidades de lançamento.<br>Pesquisando somente por <strong>codigoportal</strong>, a pesquisa é paginada, considera apenas imóveis com o portal <strong>ATIVO</strong> e as unidades de lançamento só entram enviando opcaoimovel = 3.<br><br>Tokens disponíveis:<br>codigosimoveis: OPCIONAL - Enviar os códigos dos imóveis separados por vírgula (,), máximo 200 - obrigatório se codigoportal não for enviado<br>codigoportal: OPCIONAL - Enviar o código do portal (0 = meu site) - obrigatório se codigosimoveis não for enviado<br>somenteportaisativos: OPCIONAL - Enviar true para retornar somente os portais com situação ativa, caso contrário assumirá false (retorna também os retirados)<br>codigounidade: OPCIONAL - Usado na pesquisa somente por portal. Enviar código da unidade, para mais de uma unidade, separar por vírgula (,) ou vazio para todas<br>finalidade: OPCIONAL - Usado na pesquisa somente por portal. Enviar 1 para ALUGUEL, 2 para VENDA ou 0 para todas<br>situacao: OPCIONAL - Usado na pesquisa somente por portal. Enviar 0 - Todos, 1 - Vago/Disponível, 2 - Alugado, 3 - Vendido, 4 - Em reforma, 5 - Em moderação, 6 - Desativado, 7 - Em desocupação<br>opcaoimovel: OPCIONAL - Usado na pesquisa somente por portal. Enviar 1 para somente avulsos, 2 para somente lançamentos, 3 para unidades de lançamentos, 0 para avulsos e lançamentos mãe<br>numeropagina: OPCIONAL - Usado na pesquisa somente por portal (paginação), enviar o nº da página atual<br>numeroregistros: OPCIONAL - Usado na pesquisa somente por portal, nº de registros para retorno, máximo 200 (assume 20 se não enviado)

## Request body

- object
  - `codigosimoveis` string, string
  - `codigoportal` string, string
  - `somenteportaisativos` string, string
  - `codigounidade` string, string
  - `finalidade` string, string
  - `situacao` string, string
  - `opcaoimovel` string, string
  - `numeropagina` string, string
  - `numeroregistros` string, string

## Response `200`

Retornado com sucesso

- object
  - `quantidade` integer
  - `lista` object[]
    - `codigoimovel` integer
    - `exibirmeusite` boolean
    - `codigotipodestaquesite` integer
    - `tipodestaquesite` string, string
    - `portais` object[]
      - `codigoportal` integer
      - `nomeportal` string, string
      - `codigosituacao` integer
      - `situacao` string, string
      - `codigotipodestaque` integer
      - `tipodestaque` string, string
      - `codigosituacaoproximoenvio` integer
      - `situacaoproximoenvio` string, string
      - `dataprimeiroenvio` string, string
      - `dataultimoenvio` string, string
      - `mensagemultimoenvio` string, string
      - `codigoimovelnoportal` integer
      - `quantidadediaspublicacao` integer

## Other responses

- `401`: Header 'chave' ausente ou inválido, ou chave/usuário sem permissão para a operação
- `403`: Regra de negócio violada ou limite de paginação excedido
- `404`: Parâmetro obrigatório ausente ou inválido, registro não encontrado ou consulta sem resultado
- `429`: Limite de requisições da chave excedido
- `500`: Falha interna não prevista

## Changes

- **2026-10-09** `d7f65bff1506`: 9 breaking, 5 info
  - the `lista/items/codigoimovel` response's property format changed from `Int64` to `int64` for status `200`
  - the `lista/items/codigotipodestaquesite` response's property format changed from `Int64` to `int64` for status `200`
  - the `lista/items/portais/items/codigoimovelnoportal` response's property format changed from `Int64` to `int64` for status `200`
  - the `lista/items/portais/items/codigoportal` response's property format changed from `Int64` to `int64` for status `200`
  - …10 more

[Operation history](https://skmtc.dev/imoview/apis/imoview-api/changes/Imovel/RetornarPortaisImoveis/post.md)

---

[API](https://skmtc.dev/imoview/apis/imoview-api.md) - [All operations](https://skmtc.dev/imoview/apis/imoview-api/llms.txt) - [OpenAPI document](https://skmtc.dev/imoview/apis/imoview-api/revisions/436e609983d0?raw)