Jump to Content

Home Documentação Referências das Apis Changelog

Referências das Apis

Home Documentação Referências das Apis Changelog

All

Pages

Start typing to search…

Atendimento API

Atendimento
Tarefas
Tarefas

Assistência Técnica API

Assistência
Visitas
Equipes
- Listar equipes disponíveisget
- Listar profissionais da equipeget
Itens
Localidade
- Listar localidades disponíveisget
Área Comum
- Listar áreas comuns configuradasget
Itens de Manutenção
- Listar tipos de itens de manutençãoget
- Cadastra item de manutençãopost
Mensagens
- Enviar mensagempost
Patologias
Upload
- Upload de anexospost
Mensagens
- Listar mensagens da assistênciaget
- Consultar mensagem específica da assistênciaget

Cadastro gerais do ambiente do CV

Kit Decoração
- Esta API é responsável por retornar os kits decoração cadastrados no CVget
Correspondentes

API de Clientes

Cliente

API de Comissões

Comissão
Comissão

APIS - Comunicações

Assuntos
Atendimentos
Contratos
- Solicitação de envio por e-mail dos contratos associados ao clientepost
Empreendimentos
- Retorna os dados dos empreendimentos ativos no sistemaget
- Retorna as unidades disponíveis do empreendimentoget
Financeiro
Leads
- Realiza o cadastro de um novo leadpost
- Altera o empreendimento vinculado ao leadput
Pessoa
- Retorna os dados da pessoaget
Unidades
- Retorna os dados da unidadeget
Agendamentos

API de Corretores

Corretor

CVDW

Leads
Agendamentos
- Retorna os dados das vistoriasget
Distratos
- Retorna os distratosget
Atendimentos
Vendas
- Retorna os dados das vendasget
Assistências
Pre-cadastro
Filas de Distribuição
- Retorna a distribuição dos leadsget
Processos
- Retorna os dados dos processosget
Imobiliarias
- Retorna os dados das imobiliariasget
Corretores
- Retorna os dados dos corretoresget
Pesquisas
Repasses
Pessoas
Correspondentes
Comissões
Reservas
Simulações
- Retorna os dados das simulaçõesget
Unidades
Usuários Administrativos
- Retorna os dados dos usuários administrativosget
Pesquisas
Campanhas de Ativação
- Retorna as campanhas de ativaçãoget
Campos Adicionais
- Retorna os campos adicionaisget
Correspondentes
- Retorna os usuários correspondentesget
- Retorna as empresas correspondentesget

Empresas

Empresas
- /empresasget

API de Empreendimentos

Empreendimento
Tipologias das Unidades
Etapa
- Cadastra etapa.post
Unidade
- Cadastra unidade.post
- Retorna unidade.get
Bloco
- Cadastra bloco.post
Empreendimento Corretores
- Retornar corretores associados a um empreendimentoget
- Associar corretor a um empreendimentopost
bloquear_unidade
- Bloqueia ou disponibiliza unidade.post
Empreendimento Imobiliárias
- Retornar imobiliárias associadas a um empreendimentoget
- Associar imobiliária a um empreendimentopost
campos_obrigatorios
- Retorna campos obrigatórios.get
Motivos de Bloqueio Unidade
- Retorna motivos de bloqueio de unidade.get
referencia_externa
- Atualiza referência externa.put
Dados ERP
- Retorna dados ERP Sienge do empreendimento.get

API de Imobiliárias

Imobiliária
- Cadastra imobiliária.post
- Retorna uma imobiliária cadastradaget
Usuários Imobiliárias
- Retorna usuários de imobiliáriasget
- Adicionar ou alterar usuário de imobiliáriapost

Indexadores

Indexadores
- /indexadorget

Integrações

Webhook

API de Leads

Leads
- Retorna leadsget
- Cadastra Leadspost
Atendentes das Filas de Distribuição de Leads por Tag
- Retorna os Atendentes das Filas de Distribuição de Leadsget
Consultar Atendimento do Lead
- Retorna os atendimentos dos Leadsget
Filas de Distribuição de Leads
- Retorna as Filas de Distribuição de Leadsget
Motivos de Cancelamento de Lead
- Retorna os Motivos de Cancelamento do Leadget
Conversões dos Leads
- Retorna as Conversões do Leadget
Tarefas
Interações
- Retorna as interações dos leadsget
- Atualiza as interações dos leadsput

Mapa Disponibilidade

Mapa Disponibilidade
- /mapadisponibilidade/{idEmpreendimento}get

Portal do Cliente API

Autenticação
Banners
- Retorna os banners ativos do painel do clienteget
Comunicados
- Retorna os comunicados dos empreendimentos referente ao cliente logadoget
Campos Adicionais
- Retorna os campos adicionais do clienteget
Configurações
Itens de Manutenção
- Retorna os itens de manutenção das assistências técnicasget
Assistências Técnicas
Contratos
- Retornar os contratos das unidades do clienteget
Endereço
Empreendimentos
Financeiro
Autenticação
Agendamentos
Localidade
- Retorna as localidades das assistências técnicasget
Associações de Pessoas
Notificações
Atendimentos
Documentos
- Retorna os documentos do síndico get
Financeiro CV
Portal de Benefícios
- Retorna os marketplaces vinculados a um portal do clienteget
Perguntas frequentes
- Retorna as perguntas frequentes do portalget
Pesquisas
- Retornar as pesquisas ativas para o usuárioget
- Retorna as resposta do cliente de uma pesquisaget
Permissões dos Perfis
- Retorna as permissões dos perfis do cliente de acordo com configuração do painel do clienteget
Pessoa
Permissões dos Síndicos
- Retorna as permissões do síndico de acordo com configuração do painel do clienteget
Pré Cadastros
- Retorna os pré cadastros do cliente pendentes de documentoget
Reservas
- Retorna as reservas do cliente pendentes de documentoget
Síndico
Resetar Senha
Termo de Aceite
- Retorna um termo a ser aceitado pelo clienteget
- Realiza o aceite do termopost
Unidades

API de Pré-cadastro

Pré-cadastro
Mensagens
- Retorna a lista de mensagens de um pré-cadastroget
- Cadastra uma mensagem para um pré-cadastropost
Documentos

API de Reservas

Reserva
Cancelamento
- Altera situação da reserva para canceladapost
- Altera situação da reserva para canceladapost
Alterar Situação
- Altera situação da reservapost
Distrato
Cessão
Repasse
Boletos
Lotes
Dados ERP
- Retorna dados do ERP Sienge da reservaget
- Atualiza dados do ERP Sienge em uma reservaput
Análises de Crédito
- Retorna a(s) análise(s) de crédito de uma reservaget
Kit Decoração
- Retorna os kits de decoração da reservaget
- Associa um kit de decoração a uma reservapost
Campanhas
- Retorna as campanhas cadastradas na reservaget
- Retorna as campanhas cadastradas na reservaget
Alterar Situação
- Altera situação da reservapost
Mensagens
- Cadastra uma nova mensagempost
- Retorna a(s) mensagem(s) de uma reservaget
Informar Venda
- Atualiza situação da reserva para vendidapost
- Atualiza situação da reserva para vendidapost
Contratos
Documentos
- Retorna os documentos cadastrados na reservaget
- Cadastra documentos na reservapost
Correspondente
- Altera o correspondente da reservaput
Condição de Pagamentos da Reserva
- Retorna as condições de pagamento de uma reservaget
- Retorna as condições de pagamento de uma reservaget
Dados ERP
- Retorna dados do ERP Sienge da reservaget
- Atualiza dados do ERP Sienge em uma reservaput
Mensagens
- Cadastra uma nova mensagempost
- Retorna a(s) mensagem(s) de uma reservaget
Análises de Crédito
- Retorna a(s) análise(s) de crédito de uma reservaget
Kit Decoração
- Retorna os kits de decoração da reservaget
- Associa um kit de decoração a uma reservapost
Contratos
Documentos
- Retorna os documentos cadastrados na reservaget
- Cadastra documentos na reservapost
Contratos
- Retorna os contratos da reserva que estão em assinatura eletrônicaget

API de Séries de Tabelas de Preços

Tabelas de Preços
Séries de Tabelas de Preços
- Cadastro de Séries de Tabelas de Preçospost
- Recupera a lista de tabelas de preço completaget

Usuários Administrativos

Usuários Administrativos
- /v1/configuracoes/usuariosadmget
Autenticação
- Envia o código de verificação para autenticação externapost
- Gera o token de autenticação externapost
Esqueci Senha
- Enviar código de recuperação de senhapost
- Validar código de recuperação de senhapost

Workflow API

Workflow

Geral API

Autenticação
- Gera um token de acesso para o usuáriopost

API do Financeiro

Boleto
Extrato
- Salva os boletos para serem exibidos no portal do clientepost
IR
- salva a renda para ser exibida no portal do clientepost
Mensagens da comissão
Pagamentos da comissão
Parcelas da reserva
- Retorna todas as parcelas de pagamento da reservaget
- Cadatra boletos das parcelas quando for tipo ato ou sinalput

Cadastros

Tipos de Arquivos
- Retorna os tipos de arquivos disponíveisget
Tipos de Associações
- Retorna os tipos de associações disponíveisget
Profissões
- /profissoesget
- Cadastrar uma profissão no CVpost
Localidades
- Retorna os estadosget
- Retorna as cidadesget

GESTÕES

Gestões de Contrato
- Retorna todas as gestões de contrato cadastradasget
Gestões de Distrato
- Retorna todas as gestões de distrato cadastradasget
Gestões de Cessão
- get gestão de cessãoget
Gestões de Time
- Retorna uma gestão de time cadastradaget

Renova a validade do token caso esteja expirado

post

https://{dominiodocliente}.cvcrm.com.br/api/v1/validar-token

Language

URL

Click Try It! to start a request and see the response here!