v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Empreendimento

Retorna empreendimentos.

🔒 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)

A api retornará o resumo de todos os empreendimentos cadastrados e ativos no ambiente do cliente. Para obter mais detalhes do empreendimento utilize a api cadastros/empreendimentos/{idempreendimento}

get/v1/cadastros/empreendimentos

Headers

emailstring required

Example:email@email.com

E-mail de autenticação para retorno de empreendimento.

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para retorno de empreendimento.

Response

Retorno de todos os empreendimentos.

idempreendimentointeger

ID do empreendimento

idempreendimento_intstring

Código interno do empreendimento

referencia_externastring

Referência de externa.

nomestring

Nome do empreendimento

regiaostring

Região do empreendimento

cidadestring

Cidade do empreendimento

estadostring

Estado do empreendimento

bairrostring

Bairro do empreendimento

endereco_empstring

Endereço do empreendimento

numerostring

Número do empreendimento

logradourostring

Logradouro do empreendimento

cepstring

CEP do empreendimento

enderecostring

Endereço completo do empreendimento

idempresainteger

ID da empresa

siglastring

Sigla do empreendimento

link_disponibilidadestring

Link para disponibilidade do empreendimento

logostring

Logotipo do empreendimento

foto_listagemstring

Imagem do empreendimento na listagem

fotostring

Foto do empreendimento

app_exibirstring

Exibe no APP

app_cor_backgroundstring

Cor do Backgound no APP

data_entregastring

andamentostring

Andamento da obra em porcentagem

unidades_disponiveisinteger

Quantidade de unidades disponíveis

Example response

[
  {
    "idempreendimento": 3,
    "idempreendimento_int": "12345678",
    "referencia_externa": "123",
    "nome": "Varándãs Do Garcia 9",
    "regiao": "Nordeste",
    "cidade": "Aracaju",
    "estado": "Sergipe",
    "bairro": "Centro",
    "endereco_emp": "R. Julio Garcez",
    "numero": "123",
    "logradouro": "Rua",
    "cep": "49140000",
    "endereco": "Av. Gen. Djenal Tavares de Queroz, Aracaju - SE, 49045-423, Brasil",
    "idempresa": 1,
    "sigla": "SE",
    "link_disponibilidade": "http://cv.cvcrm.com.br/gestor/comercial/mapadisponibilidade/3",
    "logo": "http://cv.cvcrm.com.br/api/get/imagens/empreendimentos_logo/x/x/20200811143500_5f32d6c47e24a.jpg",
    "foto_listagem": "http://cv.cvcrm.com.br/api/get/imagens/empreendimentos_logo/x/x/20200811143500_5f32d6c47e24a.jpg",
    "foto": "http://cv.cvcrm.com.br/api/get/imagens/empreendimentos_logo/x/x/20200811143500_5f32d6c47e24a.jpg",
    "app_exibir": "S",
    "app_cor_background": "#332ec2",
    "data_entrega": "01/01/2024",
    "andamento": "15.72",
    "unidades_disponiveis": 1312,
    "campos_adicionais": [
      {
        "nome_referencia": "adc_valor_adicional",
        "valor": "1.000,00"
      }
    ],
    "situacao_obra": [
      {
        "nome": "Em andamento",
        "idsituacao_obra": 1234
      }
    ],
    "situacao_comercial": [
      {
        "nome": "Em Construção",
        "idsituacao_comercial": 1234
      }
    ],
    "tipo_empreendimento": [
      {
        "nome": "Horizontal",
        "idtipoemrpeendimento": 1234
      }
    ],
    "segmento": [
      {
        "nome": "Popular",
        "idsegmento": 1234
      }
    ]
  }
]