Vistorias

Pesquisar

get/inspects

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/inspects
  • 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,type,status,date
filter[id]integer

Filtra por código da vistoria.

Example:12
filter[reference]string

Filtra por referência única da vistoria.

Example:VIS-2024-01
filter[type]string

Filtra por tipo da vistoria. Valores possíveis: entrance, exit, capture, maintenance.

Example:entrance
filter[status]string

Filtra por status da vistoria. Valores: pending, requested, progress, signature, canceled, finished.

Example:pending
filter[contract_id]integer

Filtra por ID do contrato vinculado.

Example:123
filter[building_id]integer

Filtra por ID do imóvel vinculado.

Example:456
filter[user_id]integer

Filtra por responsável pela vistoria.

Example:3
filter[business_id]integer

Filtra por ID da empresa vinculada.

Example:1
filter[date]string

Filtra por data da vistoria (YYYY-MM-DD).

Example:2025-05-01
filter[area]number

Filtra por metragem da vistoria.

Example:120.5
filter[furniture]string

Filtra por mobília. Valores possíveis: furnished, semi_furnished, unfurnished.

Example:furnished
filter[tag]integer

Filtra por ID da tag vinculada.

Example:7
filter[notes]string

Filtra por observações gerais (busca no array JSON). Suporta busca parcial.

Example:pintura
filter[father_id]integer

Filtra por ID da vistoria principal (quando esta for uma reedição).

Example:10
filter[withImageCount]boolean

Inclui a contagem de imagens da vistoria via scope.

Example:true
include[building]string

Inclui dados do imóvel vinculado.

Example:id,reference,title
include[contract]integer

Inclui dados do contrato vinculado.

include[user]string

Inclui dados do usuário responsável.

Example:id,name,email
include[tags]string

Inclui as tags vinculadas.

Example:id,description
include[business]string

Inclui dados da empresa responsável.

Example:id,name
include[environments]string

Inclui ambientes da vistoria.

Example:id,name
include[keys]string

Inclui os itens do tipo chave.

Example:id,name
include[meters]string

Inclui os itens do tipo medidor.

Example:id,name
include[files]string

Inclui arquivos relacionados à vistoria.

Example:id,name,file_name
include[father]string

Inclui os dados da vistoria pai (original).

Example:id,type,date

Changes

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