Listar imóveis urbanos de um cliente

GET

/assets/{clientId}/properties/urban/list

Lista os imóveis urbanos não removidos do cliente informado em clientId, de um ano por vez, em páginas de 60 itens. Com year, devolve os imóveis desse ano, do cadastro mais recente para o mais antigo. Sem year, devolve os imóveis do ano mais recente encontrado na página pedida. totalProperties é a quantidade de imóveis do ano e totalValueProperties é a soma dos valores, considerando todos os imóveis do ano e não só a página. page começa em 1, e valor menor ou igual a 0 vale 1. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200

application/json

Imóveis urbanos do cliente

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/assets/7c9e6679-7425-40de-944b-e07fc1f90ae7/properties/urban/list?page=1&year=2026' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "items": [
        {
            "_id": "f1a2b3c4-0000-4000-8000-000000000201",
            "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "type": "house",
            "description": "CASA SEDE NA ÁREA URBANA",
            "totalArea": 250,
            "value": 850000,
            "state": "MT",
            "county": "SORRISO",
            "year": "2026",
            "situationAt": [],
            "trashed": false
        }
    ],
    "totalProperties": 1,
    "totalValueProperties": 850000
}

Modificado em 2026-10-13 09:47:06

Página anterior

Listar bens móveis de um cliente

Próxima página

Listar notificações vigentes do usuário