Condomínios

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Condomínio</aside>
get/condominiums

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/condominiums
  • 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,id2,title
filter[id]integer

ID do condomínio.

Example:2
filter[id2]integer

ID visível do condomínio.

Example:9
filter[mode]string

Modo (condomínio ou lançamento).

Example:release
filter[status]string

Status.

Example:active
filter[lock]string

Status.

Example:active
filter[type_id]integer

ID da Subcategoria/Tipo do condomínio.

Example:4
filter[stage_id]integer

ID do estágio.

Example:2
filter[country_id]integer

ID do País.

Example:12
filter[state_id]integer

ID do estado.

Example:10
filter[city_id]integer

ID da cidade.

Example:7
filter[district_id]integer

ID do bairro

Example:4
filter[tag]integer[]

Tags.

[
  13,
  11,
  12
]
filter[responsible]integer[]

Corretores responsáveis.

[
  123,
  132
]
filter[constructor_id]integer

ID da construtora.

Example:10
filter[access]string

Tipo de Acesso.

Example:all
filter[pickup]integer[]

Corretores captadores.

[
  1123,
  1322
]
filter[slug]string

Link permanente para site.

Example:exemplo-perma-link
filter[updated_by]integer

ID do usuário que atualizou.

Example:1
filter[created_by]integer

ID do usuário que cadastrou.

Example:19
filter[principal_media]string

Mídia principal.

Example:laborum
filter[built_year]integer

Ano de construção.

Example:4
filter[total_floors]integer

Quantidade de andares.

Example:18
filter[total_by_floor]integer

Quantidade de unidades por andar.

Example:20
filter[blocks]integer

Quantidade de Blocos do condomínio.

Example:13
filter[title]string

Titulo do condomínio.

Example:Título Exemplar
filter[content]string

HTML do conteúdo da descrição.

Example:<p>Condomínio de frente para o mar...</p>
filter[lock_description]string

Motivo do bloqueio.

Example:Bloqueado para atualização
filter[street]string

Rua do condomínio.

Example:Rua Guanabara
filter[number]integer

número do condomínio

Example:11
filter[complement]string

Complemento do condomínio.

Example:Apartamento
filter[zip_code]integer

CEP do condomínio.

Example:3
filter[notes]string

Observações.

Example:voluptatibus
filter[html_title]string

Título da página (HTML title).

Example:SEO Título
filter[html_keyword]string

Palavras Chave (HTML Keyword).

Example:condomínio,grupo,venda
filter[html_description]string

descrição SEO.

Example:SEO
include[buildings]string

Imóveis do condomínio.

Example:id,title,slug
include[purposes]string

Finalidades do condomínio.

Example:type,amount
include[groups]string

Grupos do condomínio.

Example:id,title
include[units]string

Unidades do condomínio.

Example:id,title
include[related]string

Pessoas relacionadas ao condomínio.

Example:id,title,slug

Changes

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