v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Unidades

Retorna situacao das unidades

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta api retorna a situação das unidades a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.

get/unidades/situacao

Query parameters

paginainteger

Página que deseja visualizar os registros

registros_por_paginainteger

Quantidade de registro por página, máximo 500 registros

a_partir_referenciainteger

Retornará os registros a partir deste id, lembrando que está ordenado por referencia_data.

a_partir_data_referenciastring

Retornará os registros com data referência a partir da data informada

ate_data_referenciastring

Retornará os registros com data referência até a data informada

Headers

emailstring required

E-mail de autenticação do usuário administrativo

tokenstring required

Token criado no usuário administrativo do e-mail

Response

Unidades Situação

paginainteger

Página atual do retorno dos registros

registrosinteger

Quantidade de registro da página, máximo 500 registros

total_de_registrosinteger

Total de registros encontrados

total_de_paginasinteger

Total de páginas encontradas

Example response

{
  "pagina": 1,
  "registros": 30,
  "total_de_registros": 1054,
  "total_de_paginas": 36,
  "dados": [
    {
      "referencia": "309 ou 309_103",
      "referencia_data": "2025-01-27 16:03:00",
      "idempreendimento": 3,
      "idempreendimento_int": "1A3E56",
      "nome_empreendimento": "9201 - Varandas do Garcia (CONF AVENDRE)",
      "idtipo_empreendimento": 2,
      "tipo_empreendimento": "Horizontal",
      "idetapa": 4,
      "idetapa_int": "98076",
      "etapa": "Única",
      "idbloco": 2216,
      "idbloco_int": "1A3E567",
      "bloco": "QUADRA A1",
      "area_privativa": "100.000000",
      "idunidade": 309,
      "nome": "401 - #309",
      "idunidade_int": "309",
      "modificou": "situação",
      "de_situacao": "Bloqueada",
      "para_situacao": "Disponível"
    }
  ]
}