Endpoints disponíveis

Todos os endpoints abaixo requerem o header:

Authorization: Bearer {seu-token}

O token deve ter a permissão correspondente ao contexto da rota. Veja Autenticação para detalhes.

Empresa

Dados da empresa

GET /v2/api/company

Retorna os dados da empresa associada ao token.

Permissão necessária: COMPANY

Resposta: 200 OK

{
  "id": "uuid",
  "name": "string",
  ...
}

Imóveis

Listar imóveis

GET /v2/api/property/search

Lista imóveis com filtros. Retorna apenas imóveis aprovados, publicados, não vendidos e ativos. Imagens de uso interno são automaticamente filtradas.

Permissão necessária: PROPERTY

Query params: PropertySearchParamsDTO

Resposta: 200 OK — lista paginada de imóveis

Imóveis por localização

GET /v2/api/property/location/search

Busca imóveis por localização geográfica. Aplica os mesmos filtros automáticos de property/search.

Permissão necessária: PROPERTY

Query params: PropertyLocationSearchParamsDTO

Resposta: 200 OK — lista paginada de imóveis

Buscar imóvel por ID

GET /v2/api/property/:id

Retorna um imóvel pelo ID. Retorna 404 se o imóvel estiver inativo.

Permissão necessária: PROPERTY

Path params:

Resposta: 200 OK — dados do imóvel

Erros:

Cidades disponíveis

GET /v2/api/property/cities

Retorna as cidades com imóveis disponíveis.

Permissão necessária: PROPERTY

Query params:

Resposta: 200 OK — string[]

Status de imóvel

GET /v2/api/property-status/search

Lista os status de imóvel cadastrados.

Permissão necessária: PROPERTY

Resposta: 200 OK — lista de status

Padrões de imóvel

GET /v2/api/property-standard/search

Lista os padrões de imóvel cadastrados.

Permissão necessária: PROPERTY

Resposta: 200 OK — lista de padrões

Subcategorias de imóvel

GET /v2/api/property-sub-category/search

Lista as subcategorias de imóvel cadastradas.

Permissão necessária: PROPERTY

Resposta: 200 OK — lista de subcategorias

Empreendimentos

Listar empreendimentos

GET /v2/api/enterprise/search

Lista empreendimentos publicados e ativos. Imagens de uso interno são filtradas.

Permissão necessária: ENTERPRISE

Query params: EnterpriseSearchParamsDTO

Resposta: 200 OK — lista paginada de empreendimentos

Empreendimentos por localização

GET /v2/api/enterprise/location/search

Busca unidades de empreendimento por localização. Retorna apenas unidades não vendidas e não reservadas.

Permissão necessária: ENTERPRISE

Resposta: 200 OK — lista paginada de unidades

Buscar empreendimento por ID

GET /v2/api/enterprise/:id

Retorna um empreendimento pelo ID.

Permissão necessária: ENTERPRISE

Path params:

Resposta: 200 OK — dados do empreendimento

Erros:

Usuários

Listar usuários

GET /v2/api/user/search

Lista usuários (corretores e equipe) da empresa.

Permissão necessária: USER

Resposta: 200 OK — lista de usuários

Leads

Enviar lead

POST /v2/api/lead

Envia um lead para o Luno CRM. O processamento é assíncrono — o lead é colocado em fila e processado em seguida.

Permissão necessária: LEAD

Headers:

Content-Type: application/json

Body: CreateLeadDTO

Resposta: 201 Created

{ "message": "lead recebido" }

Eventos

Registrar evento

POST /v2/api/event

Registra um evento no Luno CRM. O processamento é assíncrono.

Permissão necessária: EVENT

Headers:

Content-Type: application/json

Body: AddEventDTO

Resposta: 201 Created

{ "message": "event recebido" }

Códigos de erro