--- title: "Retorna as reservas" method: GET path: "/reservas" tags: ["Reservas"] --- # Retorna as reservas `GET /reservas` ## Request - Base URL: `https://integracao.cvcrm.com.br/api/v1/cvdw` - URL: `https://integracao.cvcrm.com.br/api/v1/cvdw/reservas` - Auth: none declared. Required headers: `email`, `token` > 🔒 **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)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-apis-cvcrm-email-token) Esta api retorna os dados das reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema. ## Query parameters - `pagina` integer - `registros_por_pagina` integer - `a_partir_referencia` integer - `a_partir_data_referencia` string - `ate_data_referencia` string ## Headers - `email` string, required - `token` string, required ## Response `200` Reservas - object: Dados da reservas - `pagina` integer: Página atual do retorno dos registros - `registros` integer: Quantidade de registro da página, máximo 500 registros - `total_de_registros` integer: Total de registros encontrados - `total_de_paginas` integer: Total de páginas encontradas - `dados` Reservas[] - `referencia` string: Código identificador da reserva - `referencia_data` string: Data de referência da reserva - `ativo` string: Informa se está ativo ou não - `idreserva` integer: Código identificador da reserva - `data_cad` string: Data de cadastro da reserva - `codigointerno` string: Código interno da reserva - `numero_venda` string: Número da venda - `aprovada` string: Aprovação da reserva - `data_venda` string: Data de venda da reserva - `situacao` string: Situação da reserva - `idsituacao` integer: Código identificador da situação da reserva - `situacao_comercial` string: Nome da situação comercial - `idempreendimento` integer: Código identificador do empreendimento - `codigointerno_empreendimento` string: Código interno do empreendimento - `empreendimento` string: Empreendimento da reserva - `data_entrega_chaves_contrato_cliente` string: Data de entrega das chaves conforme contrato com cliente - `etapa` string: Etapa do empreendimento - `bloco` string: Bloco do empreendimento - `unidade` string: Unidade do empreendimento - `regiao` string: Região do empreendimento da reserva - `venda` string: Informa se a reserva foi vendida - `idcliente` integer: Código identificador do cliente - `documento_cliente` string: Número do documento (CPF/CNPJ) do cliente - `cliente` string: Nome do cliente da reserva - `email` string: E-mail do cliente da reserva - `cidade` string: Cidade de origem do cliente - `cep_cliente` string: CEP do cliente - `renda` number: Renda do cliente da reserva - `sexo` string: Sexo do cliente da reserva - `idade` integer: Idade do cliente da reserva - `estado_civil` string: Estado civil do cliente da reserva - `idcorretor` integer: Código identificador do corretor vinculado - `corretor` string: Corretor da reserva - `idimobiliaria` integer: Código identificador da imobiliária vinculada - `imobiliaria` string: Imobiliária da reserva - `idtime` integer: Código identificador do time vinculado - `time` string: Time da reserva - `valor_contrato` number: Valor do contrato da reserva - `valor_contrato_com_juros` number: Valor do contrato da reserva com juros - `vencimento` string: Vencimento da reserva - `campanha` string: Campanha da reserva - `cessao` string: Mudança de cliente da reserva - `motivo_cancelamento` string: Título da razão do cancelamento - `data_cancelamento` string: Data de cancelamento da reserva - `espacos_complementares` string: Nome do espaço complementar - `idlead` string: Código identificador dos leads vinculados separados por , - `data_ultima_alteracao_situacao` string: Data da última alteração de situação - `idempresa_correspondente` integer: Cóidgo da empresa correspondente vinculada à reserva - `empresa_correspondente` string: Empresa correspondente vinculada à reserva - `valor_fgts` number: Valor do FGTS usado na reserva - `valor_financiamento` number: Valor do financiamento - `valor_subsidio` number: Valor do subsidio da reserva - `nome_usuario` string: Nome do usuário - `idunidade` integer: Código identificador da unidade - `idprecadastro` integer: Código identificador do pré cadastro - `idmidia` integer: Código identificador da mídia - `midia` string: Nome da mídia - `descricao_motivo_cancelamento` string: Descrição da razão do cancelamento - `idsituacao_anterior` integer: Código identificador da situação anterior - `situacao_anterior` string: Nome da situação anterior - `idtabela` integer: Código identificador da tabela de preço - `nometabela` string: Nome da tabela de preço - `codigointernotabela` string: Código interno da tabela de preço - `idtipo_tabela` integer: Código identificador do tipo da tabela de preço - `nome_tabela` string: Nome do tipo da tabela de preço - `data_contrato` string: Data de contrato da reserva - `valor_proposta` number: Valor da proposta da reserva - `vpl_reserva` number: VPL da reserva - `valor_liquido_com_juros` number: Valor líquido com juros da reserva - `valor_liquido_sem_juros` number: Valor líquido sem juros da reserva - `vgv_tabela` number: Valor da tabela de preço da reserva - `vpl_tabela` number: VPL da tabela de preço da reserva - `vgv_tabela_minima` number: Valor da tabela de preço mínima da reserva - `vpl_tabela_minima` number: VPL da tabela de preço mínima da reserva - `usuario_aprovacao` string: Usuário que aprovou a reserva - `data_aprovacao` string: Data que o usuário aprovou a reserva - `juros_condicao_aprovada` number: Valor do juros da aprovação - `juros_apos_entrega_condicao_aprovada` number: Valor do juros futuro da aprovação - `idtabela_condicao_aprovada` integer: Id da tabela da condição aprovada - `data_primeira_aprovacao` string: Data que o usuário aprovou a reserva pela primeira vez - `aprovacao_absoluto` number: indicar o valor máximo (em porcentagem) para a aprovação. - `aprovacao_vpl_valor` number: Porcentagem máxima permitida para a aprovação do VPL - `idtipovenda` integer: Código identificador do tipo de venda - `tipovenda` string: Tipo de venda da reserva - `idgrupo` integer: Código identificador do grupo de situação - `grupo` string: Nome do grupo de situação - `data_modificacao` string: Data de modificação da reserva - `idtipo_reserva` integer: Código identificador do tipo de reserva - `tipo_reserva` string: Nome do tipo de reserva - `campos_adicionais` CamposAdicionais[] - `referencia` integer: Código identificador do campo adicional - `referencia_data` string: Data de referência - `idcampo_valores` integer: Código identificador do valor do campo adicional - `idcampo` integer: Código identificador do campo adicional - `nome` string: Descrição do campo adicional - `valor` string: Dado que foi inserido pelo usuário na funcionalidade - `tipo` string: Tipo do campo - `campos_adicionais_contrato` CamposAdicionais[] - `referencia` integer: Código identificador do campo adicional - `referencia_data` string: Data de referência - `idcampo_valores` integer: Código identificador do valor do campo adicional - `idcampo` integer: Código identificador do campo adicional - `nome` string: Descrição do campo adicional - `valor` string: Dado que foi inserido pelo usuário na funcionalidade - `tipo` string: Tipo do campo ## Other responses - `400`: Erro de solicitação da API de reservas, revise os parâmetros! - `401`: E-mail e/ou token incorreto(s). - `422`: Erro inesperado na API de reservas, por favor entre em contato com o suporte técnico. --- [API](https://skmtc.dev/cvcrm/apis/cvdw.md) - [All operations](https://skmtc.dev/cvcrm/apis/cvdw/llms.txt) - [OpenAPI document](https://skmtc.dev/cvcrm/apis/cvdw/revisions/ca413a559002?raw)