BETA

GET /properties

Duas formas: um imóvel pelo seu paId, ou a lista dos seus.

Um imóvel

GET https://property-api.mapaprop.com/property-v1/properties/{paId}

A lista

GET https://property-api.mapaprop.com/property-v1/properties

{ "total": 12, "items": [ { "…" } ] }

A lista é de UM clientRef, não de todo o seu inventário. Devolve os imóveis do cliente que você envia em x-client-ref. Para o inventário de outra, peça com o clientRef dela. Veja clientRef.

Autenticação

Authorization: Bearer <seu token>.

curl https://property-api.mapaprop.com/property-v1/properties/01M3PTZ8YBMM5DSNW03WP8VD9E \
  -H "Authorization: Bearer $TOKEN"

A resposta

A resposta traz o clientRef, o mesmo que você enviou no envelope. Nós o devolvemos nos seis caminhos (verify, cadastro, consulta, listagem, edição e exclusão) para que você possa cruzá-lo com a sua base sem ter que lembrar com qual clientRef perguntou.

O mesmo que o cadastro devolveu — object, portals, summary — mais o detalhe das imagens.

Os portais são recalculados a cada consulta. Não é uma foto do dia em que você cadastrou: se melhorarmos o mapeamento de um portal, você vê isso aqui sem enviar nada de novo.

`verdictAtCreation` — o veredito do dia do cadastro

Além de portals — que é recalculado — o GET traz o veredito tal como foi no dia em que você cadastrou, com a sua data:

"verdictAtCreation": {
  "at": "2026-09-29T21:52:43.549Z",
  "argenprop": { "status": "fields_complete", "blockers": [] },
  "zonaprop":  { "status": "fields_complete", "blockers": [] }
}

Para decidir se publica, olhe portals, não isto. Os dois convivem de propósito e dizem coisas diferentes:


`portals`	o que o sistema diria hoje
`verdictAtCreation`	o que disse no dia do cadastro, com a sua data

verdictAtCreation é registro histórico: serve para explicar por que um cadastro de um mês atrás passou ou não passou, com o mapeamento que existia então.

`published` — o que está publicado em cada portal

O que a publicação escreveu do outro lado. Enquanto você não publicar, vem como null:

"published": {
  "argenprop": { "itemId": null, "remoteStatus": null },
  "zonaprop":  { "itemId": null, "remoteStatus": null }
}

Campo	O que é
`itemId`	O id do anúncio nesse portal
`remoteStatus`	O seu estado do outro lado

`images` e `assets` — o estado das suas imagens

images dá o resumo e assets o detalhe, uma entrada por imagem:

"images": { "status": "partial", "total": 4, "processed": 3 },
"assets": [
  { "n": 1, "slot": "image", "source": "https://tu-cdn.com/frente.jpg",
    "url": "https://…/image-1.jpg", "ok": true },
  { "n": 2, "slot": "image", "source": "https://tu-cdn.com/living.jpg",
    "error": "el host del origen no existe (DNS no resuelve) [ENOTFOUND]", "ok": false }
]

Campo	O que é
`slot`	`image` ou `blueprint`
`source`	A URL que você nos enviou
`url`	Onde ficou. Somente se `ok`
`error`	Por que não pôde ser baixada. Somente se não `ok`

Os estados de images.status e o que fazer com cada um estão em POST /properties.

Erros

Código	Quando
`401`	Token ausente, vencido ou inválido
`404`	Esse `paId` não existe

O GET nunca devolve 409: consultar é sempre possível, mesmo enquanto as imagens estão sendo baixadas. Aliás, é assim que se acompanha o andamento.

Relacionados

POST /properties — o cadastro
DELETE /properties/{paId} — excluir