# CV CRM - Portal do Desenvolvedor Documentation
> Documentation for CV CRM - Portal do Desenvolvedor
Append .md to any documentation page URL to get its markdown version.
## Guides
- [😄Bem-vindo aos tutoriais do CVCRM - API!](https://desenvolvedor.cvcrm.com.br/docs/bem-vindo-aos-tutoriais-do-cvcrm-api.md)
- [Informações gerais](https://desenvolvedor.cvcrm.com.br/docs/getting-started.md): ###Um guia para ajudá-lo a realizar suas primeiras requisições HTTP utilizando as APIs do CV CRM de forma simples e eficiente.
- [Atualização dos Endpoints da API – Padronização em andamento](https://desenvolvedor.cvcrm.com.br/docs/atualização-dos-endpoints-da-api-padronização-em-andamento.md)
- [Os módulos do CV](https://desenvolvedor.cvcrm.com.br/docs/melhores-práticas.md)
- [Prospectar](https://desenvolvedor.cvcrm.com.br/docs/prospectar.md)
- [Vender](https://desenvolvedor.cvcrm.com.br/docs/vender.md)
- [Relacionar](https://desenvolvedor.cvcrm.com.br/docs/relacionar.md)
- [Gerenciar](https://desenvolvedor.cvcrm.com.br/docs/gerenciar.md)
- [CVDW API](https://desenvolvedor.cvcrm.com.br/docs/usuário-de-acesso.md): ##Uma massa de dados para você chamar de seu.
- [Como autenticar nas APIs do CV CRM na v1 com E-mail e Token](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-apis-cvcrm-email-token.md): Um guia direto ao ponto para você configurar suas credenciais e fazer sua primeira requisição com sucesso no CV CRM.
- [Como autenticar nas APIs do CV CRM a partir da v3 com Bearer Token](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token.md): Um guia passo a passo para obter e utilizar o Bearer Token nas requisições do CV CRM.
- [Jornada do cliente: Do lead à reserva](https://desenvolvedor.cvcrm.com.br/docs/jornada-do-cliente-do-lead-à-reserva.md)
- [Envio de Leads ao CVCRM via API](https://desenvolvedor.cvcrm.com.br/docs/envio-de-leads-ao-cvcrm-via-api.md): Aprenda a enviar leads captados em canais externos — landing pages, portais imobiliários, chatbots e automações de marketing — diretamente ao CVCRM via API.
- [🔁 Do Distrato à Nova Venda: Automação para Recuperar Clientes Após Cancelamento de Reserva](https://desenvolvedor.cvcrm.com.br/docs/do-distrato-à-nova-venda-automação-para-recuperar-clientes-após-cancelamento-de-reserva.md)
- [📘Atendimentos e Tarefas no CVCRM](https://desenvolvedor.cvcrm.com.br/docs/atendimentos-e-tarefas-no-cvcrm.md): Este guia ajuda você a entender como funcionam os recursos de atendimentos e tarefas do pós-vendas no sistema, de forma simples e prática.
- [Integrando um ERP ao CVCRM](https://desenvolvedor.cvcrm.com.br/docs/integrando-um-erp-ao-cvcrm.md): Demonstração de um fluxo simplificado para integradores/desenvolvedores para conectar um ERP ao CVCRM
- [1ª Fase – Como cadastrar a Base de Dados](https://desenvolvedor.cvcrm.com.br/docs/1a-fase-como-cadastrar-a-base-de-dados.md): Descritivo das fases do fluxo simplificado de como integrar um ERP ao CVCRM
- [2ª Fase - Montando a Equipe de Vendas](https://desenvolvedor.cvcrm.com.br/docs/2a-fase-montando-a-equipe-de-vendas.md): Descritivo das fases do fluxo simplificado de como integrar um ERP ao CVCRM
- [ 3ª Fase – Enviando Contratos/Propostas](https://desenvolvedor.cvcrm.com.br/docs/3a-fase-enviando-contratospropostas.md): Descritivo das fases do fluxo simplificado de como integrar um ERP ao CVCRM
- [ 4ª Fase – Visualização para o Cliente Final](https://desenvolvedor.cvcrm.com.br/docs/4-afase-visualização-para-o-cliente-final.md): Descritivo das fases do fluxo simplificado de como integrar um ERP ao CVCRM
- [📘 Tutorial de Integração ERP ↔ CVCRM](https://desenvolvedor.cvcrm.com.br/docs/tutorial-de-integração-erp-cvcrm.md): Resumo dos endpoints no fluxo simplificado para integrar um ERP ao CVCRM
- [Integração Portal do Cliente CVCRM](https://desenvolvedor.cvcrm.com.br/docs/integração-portal-do-cliente-cvcrm.md)
- [Integrando o CVCRM com o n8n via API](https://desenvolvedor.cvcrm.com.br/docs/integrando-o-cvcrm-com-o-n8n-via-api.md)
- [Monte dashboards com o CVCRM!](https://desenvolvedor.cvcrm.com.br/docs/monte-dashboards-com-o-cvcrm.md): Consuma as APIs analíticas do CVCRM para construir um _data mart_ voltado a funil comercial, desempenho de mídia, reservas, workflow e contratos.
- [Como criar um chatbot usando a biblioteca de Comunicações do CV CRM](https://desenvolvedor.cvcrm.com.br/docs/como-criar-um-chatbot-usando-a-biblioteca-de-comunicações-do-cv-crm.md)
- [Criando um chatbot para abrir atendimentos no CV CRM](https://desenvolvedor.cvcrm.com.br/docs/criando-um-chatbot-para-abrir-atendimentos-no-cv-crm.md)
- [👉Permissões dos Endpoints da API CVCRM](https://desenvolvedor.cvcrm.com.br/docs/permissões-dos-endpoints-da-api-cvcrm.md)
- [Recuperação de Leads Descartados com CVCRM, Make e RD Station](https://desenvolvedor.cvcrm.com.br/docs/recuperação-de-leads-descartados-com-cvcrm-make-e-rd-station.md)
- [Como conectar várias contas do Facebook com o CVCRM](https://desenvolvedor.cvcrm.com.br/docs/como-conectar-várias-contas-do-facebook-com-o-cvcrm.md): Captação de Leads de múltiplas contas do Facebook para o CVCRM via Make
- [Projeto Multi CV](https://desenvolvedor.cvcrm.com.br/docs/projeto-multi-cv.md): O projeto Multi CV visa conectar quatro ambientes do CV simultaneamente para a venda de unidades unificada em um único ambiente.
- [Conhecendo o Make, sistema integrador](https://desenvolvedor.cvcrm.com.br/docs/ssssss.md)
- [CV & Exact Sales](https://desenvolvedor.cvcrm.com.br/docs/cv-exact-sales.md): Projeto de Integração conectando o CV com o Exact Sales, ferramenta de apoio a SDR's.
- [CV Call Connect](https://desenvolvedor.cvcrm.com.br/docs/cv-call-connect.md)
- [Integrando o TOTVS ao CVCRM](https://desenvolvedor.cvcrm.com.br/docs/integrando-o-totvs-ao-cvcrm.md)
## API Reference
- [Lista pessoas.](https://desenvolvedor.cvcrm.com.br/reference/listarpessoas.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna uma lista paginada de pessoas cadastradas no sistema. É possível filtrar por idpessoa, nome, documento, telefone ou e-mail.
- [Cadastra uma pessoa.](https://desenvolvedor.cvcrm.com.br/reference/criarpessoa.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Cadastra uma nova pessoa no sistema. O documento (CPF ou CNPJ) deve ser único e válido. Telefone e celular recebem DDI +55 automaticamente caso não informado e possuam 10 ou 11 dígitos.
- [Exibe uma pessoa.](https://desenvolvedor.cvcrm.com.br/reference/exibirpessoa.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna os dados completos de uma pessoa pelo seu identificador.
- [Atualiza parcialmente uma pessoa.](https://desenvolvedor.cvcrm.com.br/reference/atualizarpessoa.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Atualiza os campos informados de uma pessoa. Campos não enviados no body são mantidos com o valor atual (semântica PATCH). O documento só é verificado por unicidade se for diferente do atual.
- [Listar profissões do CV CRM](https://desenvolvedor.cvcrm.com.br/reference/retorarprofissoesprofissao.md): > 🔒 **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) Retorna, de forma paginada, as profissões cadastradas no CV. Os itens são retornados em **camelCase**. Para paginar use `pagina` e `registros_por_pagina`. O filtro segue o padrão **v1: por campo** (`campo=valor`, ex.: `nome=Engenheiro`), aplicado como **contém** (`like`). Campos aceitos: `nome`, `codigo`, `idprofissao`, `cbo`, `ativo_painel`, `enviar_sienge`.
- [Cadastrar uma profissão no CV CRM](https://desenvolvedor.cvcrm.com.br/reference/cadastrarprofissao.md): > 🔒 **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) Cadastra uma nova profissão. O corpo é um **objeto único**.
- [Retorna os estados](https://desenvolvedor.cvcrm.com.br/reference/getestados-1.md): > 🔒 **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)
- [Retorna as cidades](https://desenvolvedor.cvcrm.com.br/reference/getcidades-1.md): > 🔒 **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)
- [Adicionar webhook](https://desenvolvedor.cvcrm.com.br/reference/cadastrarusuariosadministrativos.md): > 🔒 **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 é responsável por adicionar um novo webhook
- [Deletar Webhook](https://desenvolvedor.cvcrm.com.br/reference/deletarwebhook-1.md): > 🔒 **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 é responsável por deletar um webhook cadastrado no CV.
- [Cadastra imobiliária.](https://desenvolvedor.cvcrm.com.br/reference/cadastrarimobiliaria-1.md): > 🔒 **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) Interface responsável por inserir novas imobiliárias dentro do Construtor de Vendas, quando o serviço for requisitado irá verificar se o dado inserido no campo idimobiliaria_int ou CNPJ existe ou não no Construtor de Vendas, se já existir uma imobiliária cadastrada com o mesmo idimobiliaria_int (código interno da imobiliária) ou com mesmo CNPJ a API irá atualizar os dados solicitados na requisição, senão irá cadastrá-los. **Obs: Para que essas informações sejam inseridas no Construtor de Vendas, o campo estado deve ser a sigla em letras maiúsculas e os campos de CNPJ devem ser válidos. O campo remover só deve ser informado caso a imobiliária precise ser excluída do CV, para esse processo acontecer o campo deve conter a informação do código interno da imobiliária.**
- [Retorna uma imobiliária cadastrada](https://desenvolvedor.cvcrm.com.br/reference/retornaimobiliaria-1.md): > 🔒 **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 serve como um informativo ao sistema legado acerca dos imobiliárias cadastrados no construtor de vendas, neste caso do tipo “get”, o usuário **pode escolher se quer uma imobiliária específica ou várias**, a resposta são os dados buscados. A requisição retorna os dados de uma determinada imobiliária **caso seja especifícado um id**, caso não, retorna todas as imobiliárias.
- [Retorna as imobiliárias cadastradas](https://desenvolvedor.cvcrm.com.br/reference/retornaimobiliarias.md): > 🔒 **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) Essa api serve como um informativo ao sistema legado acerca das imobiliárias cadastrados no construtor de vendas.
- [Retornar empresas do CV CRM](https://desenvolvedor.cvcrm.com.br/reference/retornaempresas.md): > 🔒 **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 é responsável por retornar todas as empresas cadastradas no CV, podendo filtrar pelo cnpj e Id da Empresa.
- [Cadastra cliente.](https://desenvolvedor.cvcrm.com.br/reference/cadastrarcliente-2.md): > 🔒 **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) Cliente é uma pessoa física ou jurídica que pode se tornar proprietário de uma unidade. Essa integração coleta informações de requisições realizadas por sistemas legados e verifica se o dado inserido no campo documento existe ou não no Construtor de Vendas. Se já existir uma pessoa cadastrada com o mesmo documento, essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los. **Obs: Para esta verificação, o documento pode ser tanto CPF quanto CNPJ, ambos devem ser documentos válidos. Somente será aceito um cadastro por CPF e CNPJ.**
- [Retorna clientes.](https://desenvolvedor.cvcrm.com.br/reference/retornarclientes-2.md): > 🔒 **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 serve como um informativo ao sistema legado acerca dos clientes cadastrados no Construtor de Vendas, neste caso do tipo “get”, o usuário não envia informações além da autenticação, a resposta são os dados buscados. A requisição retorna os dados de determinado cliente. É obrigatório o envio de pelo menos um dos campos como parâmetro na URL: Documento, Telefone ou E-mail do cliente.
- [Atualiza o Sinalizador Juridico de uma pessoa para ativo ou inativo.](https://desenvolvedor.cvcrm.com.br/reference/atualizarcliente-2.md): > 🔒 **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) Essa API atualiza a situação do sinalizador jurídico de uma pessoa no Construtor de Vendas através do identificador do cliente de um sistema legado.
- [Envia o código de verificação para autenticação externa](https://desenvolvedor.cvcrm.com.br/reference/codigoverificacao-3.md): Gera um código de verificação que é enviado via e-mail e SMS, com validade de 30 minutos, para ser utilizado no processo de autenticação.
- [Gera o token de autenticação externa](https://desenvolvedor.cvcrm.com.br/reference/validarautenticacao-3.md): Valida o código de verificação do usuário administrativo e retorna o token de acesso para o uso na autenticação das demais APIs
- [Enviar código de recuperação de senha](https://desenvolvedor.cvcrm.com.br/reference/enviarcodigoesquecisenha-3.md): Envia um código de recuperação de senha para o e-mail informado e, se o telefone fornecido corresponder ao cadastrado, também para o telefone.
- [Validar código de recuperação de senha](https://desenvolvedor.cvcrm.com.br/reference/validarcodigoesquecisenha-3.md): Valida o código de recuperação de senha enviado para o e-mail informado
- [Alterar senha do usuário](https://desenvolvedor.cvcrm.com.br/reference/alterarsenhaesquecisenha-3.md): Altera a senha do usuário utilizando o hash de validação
- [/v1/configuracoes/usuariosadm](https://desenvolvedor.cvcrm.com.br/reference/retornarusuariosadministrativos.md): > 🔒 **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 tem por finalidade apresentar os dados do usuário administrativo cadastrado no CVCRM. Para a consulta ser efetiva é necessário informar obrigatoriamente o CPF, o identificador no CV, o nome ou o documento de faturamento; O uso de um filtro é obrigatório.
- [Adicionar ou alterar usuário administrativos](https://desenvolvedor.cvcrm.com.br/reference/cadastrarusuariosadministrativos-3.md): > 🔒 **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) Adicionar ou alterar usuário administrativos
- [/v1/configuracoes/usuariosadm/perfil](https://desenvolvedor.cvcrm.com.br/reference/retornarusuariosadministrativosperfilacesso.md): > 🔒 **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 é responsável por retornar todas usuários administrativos cadastradas no CV, podendo filtrar pelo documento (cpf) ou id do usuário ou documento(cpf) do faturamento.
- [Cadastra corretor](https://desenvolvedor.cvcrm.com.br/reference/cadastrocorretor.md): > 🔒 **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) Essa integração coleta informações de requisições realizadas por sistemas legados e verifica se o dado inserido no campo documento ou idcorretor_int (identificador do sistema legado) existe ou não no Construtor de Vendas. Se já existir um corretor cadastrado com o mesmo documento ou identificador, essa API irá atualizar os dados solicitados na requisição, senão irá cadastrá-los. **Obs: Para esta verificação, o documento CPF deve ser válido. Somente será aceito um cadastro por CPF.**
- [Retorna um ou vários corretores](https://desenvolvedor.cvcrm.com.br/reference/retornacorretores.md): > 🔒 **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 serve como um informativo ao sistema legado acerca dos corretores cadastrados no Construtor de Vendas, neste caso do tipo “get”, o usuário não envia informações além da autenticação, a resposta são os dados buscados. A requisição pode retornar um objeto com dados de determinado corretor ou um array com os dados de todos os corretores, dependendo do parâmetro passado na URL.
- [Cadastra corretor PJ](https://desenvolvedor.cvcrm.com.br/reference/cadastrocorretorpessoajuridica.md): > 🔒 **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) Essa integração coleta informações de requisições realizadas por sistemas legados e verifica se o dado inserido no campo documento ou idcorretor_int (identificador do sistema legado) existe ou não no Construtor de Vendas. Se já existir um corretor cadastrado com o mesmo documento ou identificador, essa API irá atualizar os dados solicitados na requisição, senão irá cadastrá-los. **Obs: Para esta verificação, o documento CNPJ deve ser válido. Somente será aceito um cadastro por CNPJ.**
- [Retorna usuários de imobiliárias](https://desenvolvedor.cvcrm.com.br/reference/retornausuariosimobiliarias-1.md): > 🔒 **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 é responsável por retornar todas usuários imobiliarias cadastradas no CV, podendo filtrar pelo documento (cpf) ou id do usuário.
- [Adicionar ou alterar usuário de imobiliária](https://desenvolvedor.cvcrm.com.br/reference/cadastrarusuarioimobiliaria-1.md): > 🔒 **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) Adicionar ou alterar usuário de imobiliária
- [Retorna os tipos de associações disponíveis](https://desenvolvedor.cvcrm.com.br/reference/retornatiposassociacoes.md): > 🔒 **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) A api tem por objetivo demonstrar os tipos de associações cadastradas no ambiente do cliente. Denomina-se associação no construtor de vendas, a ligação das pessoas participantes da reserva com o titular. Ex.: Sócio, Conjuge, Repreentante. O campo exibir para pessoa (exibir_para_pessoa) faz a relação se o tipo de associação estará vinculado somente as pessoas do tipo Física, Jurídica ou ambos quando for pertinente aos dois tipos de pessoas. FISISCA (Física), JURIDICA (Jurídica), AMBOS (Física e Jurídica)
- [Retorna os tipos de arquivos disponíveis](https://desenvolvedor.cvcrm.com.br/reference/retornatiposarquivos.md): > 🔒 **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) A API retornará através do método GET os tipos de arquivos que poderão ser inseridos nos arquivos da reserva, dentre eles tipo_pessoa que retornará FISICA, JURIDICA ou AMBOS, quando este documento tiver relação com os dois tipos de pessoa. Também retornará a funcionalidade que este arquivo está ligado Reservas (RESERVAS), pré-cadastro (PRE_CADASTRO), AMBOS, quando o tipo de arquivo possuir ligação para as duas funcionalidades, e o exibir_painel_cliente, quando o tipo de arquivo for visível ao painel do cliente.
- [Esta API é responsável por retornar os kits decoração cadastrados no CV](https://desenvolvedor.cvcrm.com.br/reference/getkitdecoracao-3.md): > 🔒 **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 é responsável por retornar os kits decoração cadastrados no CV.
- [API responsável por retornar as variáveis](https://desenvolvedor.cvcrm.com.br/reference/retornarvariaveis-1.md): > 🔒 **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) API responsável por retornar as variáveis
- [Retorna todas as gestões de contrato cadastradas](https://desenvolvedor.cvcrm.com.br/reference/getgetoescontrato.md): > 🔒 **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 é responsável por retornar todas as gestões de contrato cadastradas no CV.
- [Retorna uma gestão de time cadastrada](https://desenvolvedor.cvcrm.com.br/reference/getgestoestime-1.md): > 🔒 **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 é responsável por retornar uma Gestão de time cadastrada no CV.
- [/workflows/{funcionalidade}](https://desenvolvedor.cvcrm.com.br/reference/retornarsituacoesworkflow.md): > 🔒 **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) API responsável por retornar as situações de um workflow
- [/workflows/{funcionalidade}/{idSituacao}](https://desenvolvedor.cvcrm.com.br/reference/retornarsituacoesedisponiveis.md): > 🔒 **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) API responsável por retornar as situações de um workflow e indica as situações disponíveis
- [Retornar tipologias das unidades](https://desenvolvedor.cvcrm.com.br/reference/retornartipologiasunidades-1.md): > 🔒 **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 é responsável por retornar todas as tipologias das unidades cadastradas no CV.
- [Adicionar tipologia das unidades](https://desenvolvedor.cvcrm.com.br/reference/cadastrartipologiaunidades-1.md): > 🔒 **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 é responsável por cadastrar uma tipologia das Unidades.
- [Atualiza tipologia das unidades](https://desenvolvedor.cvcrm.com.br/reference/editartipologiaunidades-1.md): > 🔒 **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 é responsável por atualizar uma tipologia das Unidades.
- [Deletar tipologia das unidades](https://desenvolvedor.cvcrm.com.br/reference/removertipologiaunidades-1.md): > 🔒 **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 é responsável por deletar uma tipologia das Unidades.
- [Retornar imobiliárias associadas a um empreendimento](https://desenvolvedor.cvcrm.com.br/reference/retornarimobiliariasempreendimento-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Esta API é responsável por retornar todas as imobiliárias associadas a um empreendimento no CV.
- [Associar imobiliária a um empreendimento](https://desenvolvedor.cvcrm.com.br/reference/associarimobiliariaempreendimento-1.md): > 🔒 **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 é responsável por associar uma imobiliária a um empreendimento.
- [Retornar corretores associados a um empreendimento](https://desenvolvedor.cvcrm.com.br/reference/retornarcorretoresempreendimento-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Esta API é responsável por retornar todos os corretores associados a um empreendimento no CV.
- [Associar corretor a um empreendimento](https://desenvolvedor.cvcrm.com.br/reference/associarcorretorempreendimento-1.md): > 🔒 **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 é responsável por associar um corretor a um empreendimento.
- [Cadastra etapa.](https://desenvolvedor.cvcrm.com.br/reference/cadastroetapa.md): > 🔒 **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) Etapa é um conjunto de blocos pertencentes a um empreendimento. Quando essa interface for consumida uma nova etapa será criada dentro de um empreendimento no Construtor de Vendas, ela irá verificar se o dado inserido no campo idetapa_int existe ou não no Construtor de Vendas, se já existir uma etapa cadastrada com o mesmo idetapa_int, essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los. **Obs: Para que a etapa seja inserida no Contrutor de Vendas, o identificador do empreendimento deve existir no sistema. Somente será aceito um cadastro por nome**
- [Cadastra bloco.](https://desenvolvedor.cvcrm.com.br/reference/cadastrobloco.md): > 🔒 **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) Bloco é um conjunto de unidades de um empreendimento. Quando essa interface for consumida um novo bloco será cadastrado no CV, logo após irá verificar se o dado inserido no campo idbloco_int existe ou não no CVs, se já existir um bloco cadastrado com o mesmo idbloco_int essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los. **Obs: Para que essas informações sejam inseridas no CV, os identificadores da etapa e do empreendimento devem existir no sistema.**
- [Cadastra unidade.](https://desenvolvedor.cvcrm.com.br/reference/cadastrounidade.md): > 🔒 **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) Unidade é um imóvel do empreendimento. Quando essa interface for consumida uma nova unidade será cadastrada no Construtor de Vendas. A interface irá verificar se o dado inserido no campo idbloco_int existe ou não no CV, se já existir um bloco cadastrado com o mesmo idbloco_int essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los. **Obs: Para que essas informações sejam inseridas no CV, os identificadores da etapa e do empreendimento devem existir no sistema.**
- [Retorna unidade.](https://desenvolvedor.cvcrm.com.br/reference/retornarempreendimentoporunidade.md): > 🔒 **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 de uma Unidade
- [Retorna motivos de bloqueio de unidade.](https://desenvolvedor.cvcrm.com.br/reference/retornarmotivosbloqueiounidade.md): > 🔒 **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 é responsável por retornar todos os motivos de bloqueios de unidade cadastradas no CV, podendo filtrar pelo idmotivo ou nome.
- [Retorna campos obrigatórios.](https://desenvolvedor.cvcrm.com.br/reference/camposobrigatoriosschema.md): > 🔒 **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) Filtro se o campo é obrigatório, se informado trará somente os obrigatórios ou não obrigatórios (S|N)
- [Atualiza referência externa.](https://desenvolvedor.cvcrm.com.br/reference/editarempreendimento-1.md): > 🔒 **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) Atualiza a referência externa do empreendimento informado.
- [Retorna dados ERP Sienge do empreendimento.](https://desenvolvedor.cvcrm.com.br/reference/retornarerpsiengeporempreendimento.md): > 🔒 **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) Esse endpoint retorna os dados do ERP Sienge no empreendimento informado.
- [/mapadisponibilidade/{idEmpreendimento}](https://desenvolvedor.cvcrm.com.br/reference/retornarmapadisponibilidade.md): > 🔒 **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 é responsável por retornar o mapa de disponibilidade
- [Retorna os usuários correspondentes](https://desenvolvedor.cvcrm.com.br/reference/retornarcorrespondentesusuarios-1.md): > 🔒 **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 é responsável por retornar os usuários correspondentes cadastrados no CV.
- [Cadastra um usuário correspondente](https://desenvolvedor.cvcrm.com.br/reference/cadastrarcorrespondente-1.md): > 🔒 **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 é responsável por cadastrar um usuário correspondente no CV.
- [Retorna as empresas correspondentes](https://desenvolvedor.cvcrm.com.br/reference/retornarcorrespondentesempresas-1.md): > 🔒 **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 é responsável por retornar as empresas correspondentes cadastradas no CV.
- [Cadastra empresa correspondente](https://desenvolvedor.cvcrm.com.br/reference/cadastrarcorrespondenteempresas-1.md): > 🔒 **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 é responsável por cadastrar empresa correspondente no CV.
- [Retorna as pastas dos arquivos de cliente no empreendimento.](https://desenvolvedor.cvcrm.com.br/reference/retornapastasarquivoclienteempreendimento-1.md): > 🔒 **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)
- [Bloqueia ou disponibiliza unidade.](https://desenvolvedor.cvcrm.com.br/reference/bloquear_unidade.md): > 🔒 **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) Unidade é um imóvel do empreendimento. Quando essa interface for consumida irá mudar a situação da unidade, seja para bloqueada temporariamente ou para disponivel. **Obs: Para que essas informações sejam inseridas no CV, os identificadores da etapa, bloco e empreendimento precisam existir no sistema quando forem utilizados para localizar a unidade.**
- [Cadastra novo arquivo de cliente no empreendimento.](https://desenvolvedor.cvcrm.com.br/reference/cadastraarquivoclienteempreendimento-1.md): > 🔒 **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)
- [Retorna empreendimento.](https://desenvolvedor.cvcrm.com.br/reference/retornarempreendimento.md): > 🔒 **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) Essa interface trará todos os dados de um determinado empreendimento, serão disponibilizadas as informações de todos os blocos, etapas e unidades do empreendimento selecionado.
- [Retorna empreendimentos.](https://desenvolvedor.cvcrm.com.br/reference/retornarempreendimentos.md): > 🔒 **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) 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}
- [Cadastra empreendimento.](https://desenvolvedor.cvcrm.com.br/reference/cadastrarempreendimento.md): > 🔒 **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) Empreendimento é um conjunto de unidades (imóveis) para venda ou aluguel. Esta integração coleta informações de requisições realizadas por sistemas legados e verifica se o dado inserido no campo 'nome' existe ou não no Construtor de Vendas. Se já existir um empreendimento cadastrado com o mesmo nome, essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los. **Obs: Somente será aceito um cadastro por nome. O campo estado deve ter a sigla em letras MAIÚSCULAS (Exemplo: São Paulo = SP).**
- [Retornar configurações do empreendimento](https://desenvolvedor.cvcrm.com.br/reference/retornarconfiguracoesempreendimento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Esta API é responsável por retornar as configurações do empreendimento no CV.
- [Retorna leads](https://desenvolvedor.cvcrm.com.br/reference/getlead-1.md): > 🔒 **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) A interface viabiliza a consulta dos leads. Pode ser enviado como parâmetro na URL os seguintes campos: idlead, email ou telefone (cada parâmetro deve ser usado exclusivamente). **Os leads exibidos são apenas os quais o usuário autenticado têm acesso.**
- [Cadastra Leads](https://desenvolvedor.cvcrm.com.br/reference/postlead-1.md): > 🔒 **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) # 1 INTRODUCAO ## 1.1 Definição A interface viabiliza o cadastro e a modificação de leads para o sistema CV. As ações são executadas através do envio de um JSON, referente à requisição, contendo os dados dos campos a serem cadastrados ou modificados. O cadastro pode ser proveniente do: **(1) Sistema CV** - cadastro, edição ou importação;
**(2) Site do cliente;**
**(3) Integrações** - RD Station, Facebook, Contako.
## 1.2 Usuários Os tipos de usuário que podem enviar requisições são: * **Gestor** (usuário administrativo) - pode cadastrar ou alterar todo e qualquer dado pertinente ao lead, estando a alteração restrita para os campos: (1) origem; (2) interações. * **Imobiliária** - pode cadastrar ou alterar todo e qualquer dado pertinente ao lead que seja responsável, estando a alteração restrita para os campos: (1) origem; (2) interações; (3) gestor; (4) imobiliária * **Corretor** - pode cadastrar ou alterar todo e qualquer dado pertinente ao lead que seja responsável, estando a alteração restrita para os campos: (1) origem; (2) interações; (3) gestor; (4) imobiliária; (5) corretor. ## 1.3 Influências Pode haver uma cadeia de funcionalidades que influencia o lead, assim como um lead poderá influenciar uma cadeia de funcionalidades. A cadeia de funcionalidades que influencia um lead é: * **Empreendimentos** - um lead pode possuir um, vários ou nenhum empreendimento associado. * **Responsáveis** - um lead pode possuir como responsáveis: (1) um gestor [usuário administrativo]; (2) uma imobiliária; e (2) um corretor, desde que esteja associado à imobiliária do lead. * **Simulações** - um lead pode possuir uma, várias ou nenhuma simulação associada. * **Reservas** - um lead pode possuir uma, várias ou nenhuma reserva associada. * **Pré-cadastros** - um lead pode possuir um, vários ou nenhum pré-cadastro associado. * **Contatos** - um lead pode possuir um, vários ou nenhum contato associado. * **Interações** - um lead pode possuir uma, várias ou nenhuma interação cadastrada. * **Conversões** - um lead pode possuir uma, várias ou nenhuma conversão cadastrada. ## 1.4 Pré-requisitos Alguns pré-requisitos precisam ser obrigatoriamente atendidos: - Situações - Precisam existir situações ativas com flag 'Início', 'Cancelado' e 'Fim'. - Permissão - Para editar um lead o campo 'permitir_alteracao' precisa existir no JSON da requisição e ter o valor 'true'. # 2 ESPECIFICAÇÕES DAS AÇÕES ## 2.1 Cadastro de leads O cadastro de um lead é efetuado utilizando dois campos principais: (1) e-mail; (2) telefone. Um lead pode ser cadastrado mediante a três situações desses campos: (1) com e-mail e telefone; (2) apenas com e-mail; (3) apenas com telefone. O telefone pode ser enviado com o DDI do país ou não, caso o código não seja informado será considerado o DDI do Brasil. O campo deve ser informado da seguinte forma nomedocampo_ddi, e no valor é sempre necessário colocar o simbolo de mais (+). Exemplo: 'telefone_ddi' : '+55', 'telefone_alternativo_ddi' : '+71'. Caso o JSON da requisição de cadastro do lead possua apenas o campo “e-mail”, o lead é cadastrado deixando o campo “telefone” vazio e o campo “e-mail” será sua chave. Não podem existir dois ou mais leads no sistema que tenham o mesmo e-mail. Caso o JSON da requisição de cadastro do lead possua apenas o campo “telefone”, o lead é cadastrado deixando o campo “e-mail” vazio e o campo “telefone” será sua chave. Não podem existir dois ou mais leads no sistema que tenham o mesmo número de telefone. ## 2.2 Situação Ao cadastrar um novo lead é verificado se o JSON da requisição possui o campo “idsituacao”: (1) caso o campo não exista ou o valor seja nulo, vazio ou numérico sem que esse ID retorne uma situação ativa, a situação do lead será cadastrada com a flag “Início”; (2) caso o valor seja numérico e o ID de uma situação ativa, a situação do lead será cadastrada com a flag “Início” e em seguida alterada para o novo valor enviado. Ao editar um lead é verificado se o JSON da requisição possui o campo “idsituacao”: (1) caso o campo não exista ou o valor seja nulo, vazio ou numérico sem que esse ID retorne uma situação ativa (1.1) e a situação atual do lead seja “Cancelado”, então a situação do lead será modificada para “Início” se não possuir responsável; (1.2) e a situação atual do lead seja diferente de “Cancelado”, a situação permanece a mesma; (2) caso o valor seja numérico, a situação do lead deve ser modificada para o novo valor enviado. ## 2.3 Empreendimentos Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “idempreendimento” preenchido. Caso exista um ou mais valores, adiciona ao lead apenas os valores que estiverem ativos tanto no banco de dados quanto no painel. ## 2.4 Unidades Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “idunidade” preenchido. Caso exista e esteja ativo é adicionado ao lead, assim como o “idempreendimento” desta unidade. ## 2.5 Responsável Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “idusuario” preenchido: (1) caso a requisição tenha sido enviada pelo módulo “gestor”, adiciona o novo gestor ao lead; (2) caso a requisição tenha sido enviada pelos módulos “imobiliária” ou “corretor”, segue para a verificação do próximo campo. Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “idimobiliaria” preenchido: (1) caso a requisição tenha sido enviada pelo módulo “gestor”, adiciona a nova imobiliária ao lead; (2) caso a requisição tenha sido enviada pelos módulos “imobiliária” ou “corretor”, segue para a verificação do próximo campo. Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “idcorretor” preenchido: (1) caso a requisição tenha sido enviada pelos módulos “gestor” ou “imobiliária”, se o corretor estiver vinculado a imobiliária, adiciona o novo corretor ao lead; (2) caso a requisição tenha sido enviada pelo módulo “corretor”, segue para a verificação do próximo campo. Se for uma reativação a situação poderá ser alterada para 'Enviado Gestor/SDR', 'Enviado Imobiliária' ou 'Enviado Corretor'. ## 2.6 Reservas Ao cadastrar um novo lead ou editar um lead existente é verificado se o e-mail ou o telefone no JSON da requisição pertence a alguma reserva existente no sistema CV, seja como titular ou associado da mesma. Existindo uma ou mais reservas elas são associadas ao lead. Durante essa ação, a situação do lead só será alterada para “Reserva”, caso uma das reservas associadas tenha a situação diferente de: (1) Distrato; (2) Cancelada; ou (3) Vencida. Havendo uma reserva com situação igual a “Vendida” e o ano da venda sendo igual ao ano de cadastro do lead, a situação do lead será alterada para “Fim”. ## 2.7 Pré-cadastros Ao cadastrar um novo lead ou editar um lead existente é verificado se o e-mail ou o telefone no JSON da requisição pertence a algum pré-cadastro existente no sistema CV, seja como titular ou associado do mesmo. Existindo um ou mais pré-cadastros eles são associados ao lead. Durante essa ação, a situação do lead só será alterada para “Pré-cadastro”, caso um dos pré-cadastros associados tenha a situação diferente de: (1) Fim; ou (2) Cancelado. ## 2.8 Origem Ao cadastrar um lead: (1) caso seja enviado o campo “origem” no JSON da requisição, ele será cadastrado como a origem do lead; (2) caso não exista uma “origem” no JSON da requisição, se existir o campo 'modulo', recebe esse valor, se não existir, recebe o valor padrão do sistema (ND). Desta forma, a “origem” de um lead sempre será preenchida. A origem de um lead é única e não pode ser editada. Ao editar um lead, caso seja enviado o campo “origem” no JSON da requisição, ele deve ser tratado como a origem de uma conversão, se existir o campo “conversao”. ## 2.9 Conversão Ao cadastrar um lead, uma “conversão” pode ser enviada no JSON da requisição. Caso seja enviada uma “conversão”, sua origem será a mesma origem do lead. Ao cadastrar ou editar um lead, caso seja enviada uma “conversão” que ainda não exista no sistema, ela será cadastrada. Existe um CRUD para registrar conversões. Se uma conversão for enviada no JSON da requisição com o nome diferente de alguma conversão já registrada no sistema, então ela será cadastrada como uma nova conversão. Ao editar um lead, uma “conversão” pode ser enviada no JSON da requisição: (1) caso seja enviado um campo “conversão” e um campo “origem”, essa origem deve ser tratada como a origem da conversão; (2) caso seja enviada uma “conversão” sem uma “origem”, se existir o campo 'modulo', recebe esse valor, se não existir, recebe o valor padrão do sistema (ND). ## 2.10 Interações Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “interacoes” preenchido. Caso exista um ou mais valores, adiciona a(s) interação(ões) ao lead, com seus respectivos valores de “tipo” e “descricao”, obrigatoriamente. A descrição possui limite máximo de 32000 caracteres. *Tipos: 'A' - 'Anotação' / 'L' - 'Ligação' / 'E' - 'E-mail' / 'S' - 'SMS' / 'W' - 'Whatsapp'. *Situações do tipo Ligação: 'A' - 'Atendida' / 'NA' - 'Não Atendida' / 'NE' - 'Não Existe'. Ao cadastrar a nova interação é verificado a existência do campo “audio_url” ou “audio_base64”. Caso exista é adicionado um áudio a interação. *Extensões permitidas: 'mp3', 'ogg' e 'wav'. Logo após é verificado se a interação possui o campo “tarefa” preenchido. Caso exista, adiciona a tarefa, com seus respectivos valores obrigatórios de “nome”, “data”, “situacao”, “prioridade”, “tipo_responsavel” e “idresponsavel” e opcional de “lembrete_tarefa” ('S' - 'Sim' / 'N' - 'Não'). *Situações: 'P' - 'Pendente' / 'C' - 'Concluído' / 'A' - 'Em andamento' / 'CA' - 'Cancelado'. *Prioridades: 'A' - 'Alta' / 'N' - 'Normal' / 'B' - 'Baixa'. *Tipo do responsável: 'G' - 'Gestor' / 'C' - 'Corretor' / 'I' - 'Imobiliária' / 'P' - 'PDV'. ## 2.11 Visitas Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “visita” preenchido. Caso exista um ou mais valores, adiciona a(s) visita(s) ao lead, com seus respectivos valores de “nome”, “data”, “idresponsavel” e “tipo_responsavel”. *Outros campos permitidos: “descricao”, “situacao” ['P' - 'Pendente' (valor padrão) / 'A' - 'Em Andamento' / 'C' - 'Concluído' / 'CA' - 'Cancelado'], “idpdv”, “visita_virtual” ['S' - 'Sim' / 'N' - 'Não'] e “idtipovisita”. Durante essa ação, se a automatização de leads estiver ativa, a situação do lead será alterada para “Visita Agendada”, caso a situação da visita seja 'Pendente' ou 'Em Andamento' ou para “Visita Concluída”, caso a situação da visita seja 'Concluído'. ## 2.12 Avatar Ao cadastrar um novo lead ou editar um lead existente, a imagem do avatar pode ser alterada por integração, via URL (endereço da imagem). ## 2.13 Ponto de Venda Ao cadastrar um novo lead ou editar um lead existente é verificado se o JSON da requisição possui o campo “idpdv” preenchido. Neste caso não existe uma verificação específica e o PDV é cadastrado no lead.
- [Retorna listagem de leads com data de vencimento](https://desenvolvedor.cvcrm.com.br/reference/getleadsvencimento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna a listagem paginada de leads que possuem data de vencimento definida, excluindo leads cujas situações de workflow estejam com fim, cancelada ou vencida. Os resultados podem ser filtrados por lead específico e ordenados por data de vencimento ou data de cadastro.
- [Retorna os Atendentes das Filas de Distribuição de Leads](https://desenvolvedor.cvcrm.com.br/reference/getatendentesfilasdistribuicaoleads.md): > 🔒 **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 serve como um informativo, neste caso do tipo “get”. Retornará alguns dados do atendente (corretor e imobiliária ou gestor, a depender do tipo da fila). A consulta é realizada através do dado enviado como parâmetro na URL chamado de tag, caso não seja passado o parâmetro, retorna todos os atendentes de todas as filas de distribuição de leads.
- [Retorna os atendimentos dos Leads](https://desenvolvedor.cvcrm.com.br/reference/getconsultaatendimentolead.md): > 🔒 **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 serve como um informativo, neste caso do tipo “get”. A consulta é realizada através dos dados enviados como parâmetros na URL, podendo conter idlead, telefone ou email, caso não seja passado nenhum dos parâmetros retorna o erro. Somente leads que não estejam nas situações do workflow com flag "cancelada", "vencida" e "fim"
- [Edita uma tarefa ou visita de um lead](https://desenvolvedor.cvcrm.com.br/reference/atualizartarefalead.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Edita os dados de uma tarefa ou visita vinculada a um lead. O campo `tipoInteracao` não pode ser alterado nesta operação.
- [Exclui uma tarefa ou visita de um lead](https://desenvolvedor.cvcrm.com.br/reference/excluirtarefalead.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Exclui (soft-delete) uma tarefa ou visita vinculada a um lead.
- [Conclui ou cancela uma tarefa/visita de um lead](https://desenvolvedor.cvcrm.com.br/reference/alterarsituacaotarefalead.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Altera apenas a situação de uma tarefa/visita para concluída (`C`) ou cancelada (`CA`), exigindo o motivo correspondente.
- [Lista as tarefas e visitas de um lead](https://desenvolvedor.cvcrm.com.br/reference/listartarefaslead.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Lista as tarefas e visitas (`tipo_interacao` 'T' ou 'V') vinculadas a um lead, com paginação e filtros opcionais.
- [Cria uma tarefa ou visita vinculada a um lead](https://desenvolvedor.cvcrm.com.br/reference/criartarefalead.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Cria uma tarefa (`tipoInteracao=T`) ou visita (`tipoInteracao=V`) vinculada a um lead. `idtipovisita` e `idempreendimentoVisita` são opcionais mesmo quando `tipoInteracao=V`. Toda criação reflete um evento correspondente na agenda do responsável.
- [Retorna as tarefas dos leads](https://desenvolvedor.cvcrm.com.br/reference/gettarefas-3.md): > 🔒 **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)
- [Retorna uma tarefa por id](https://desenvolvedor.cvcrm.com.br/reference/gettarefa-3.md): > 🔒 **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)
- [/v1/comercial/leads/tarefas](https://desenvolvedor.cvcrm.com.br/reference/cadastrartarefa.md): > 🔒 **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)
- [/v1/comercial/leads/tarefas](https://desenvolvedor.cvcrm.com.br/reference/atualizartarefa.md): > 🔒 **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)
- [Retorna uma tarefa específica de um lead](https://desenvolvedor.cvcrm.com.br/reference/gettarefaporlead.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Endpoint para buscar uma tarefa de um lead pelo id do lead e id da tarefa.
- [Retorna as interações dos leads](https://desenvolvedor.cvcrm.com.br/reference/getleadsinteracoes.md): > 🔒 **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)
- [Atualiza as interações dos leads](https://desenvolvedor.cvcrm.com.br/reference/atualizarleadsinteracoes-1.md): > 🔒 **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)
- [Retorna as Filas de Distribuição de Leads](https://desenvolvedor.cvcrm.com.br/reference/getfilasdistribuicaoleads.md): > 🔒 **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) A interface viabiliza a consulta das filas de distribuição de leads cadastradas do sistema CV, neste caso do tipo “get”. A consulta é realizada através dos dados enviados como parâmetros na URL, podendo conter idfila_distribuicao_leads, página ou limite, caso não seja passado nenhum dos parâmetros retorna todas as filas de distribuição de leads com o limite de 50 por página.
- [Retorna os Motivos de Cancelamento do Lead](https://desenvolvedor.cvcrm.com.br/reference/getmotivoscancelamentos.md): > 🔒 **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) A interface viabiliza a consulta de motivos de cancelamento de lead. A consulta é realizada através dos dados enviados na URL, podendo passar os seguintes parâmetros: pagina, registros_por_pagina, detalhamento e exibir_inativos.
- [Retorna as Conversões do Lead](https://desenvolvedor.cvcrm.com.br/reference/getconversoesleads.md): > 🔒 **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) A interface viabiliza a consulta de conversões de lead. A consulta é realizada através dos dados enviados na URL, podendo passar os seguintes parâmetros: pagina, registros_por_pagina e exibir_inativos.
- [Retorna a lista de mensagens de um pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/getmensagensprecadastro-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Endpoint para consultar mensagens de um pré-cadastro específico.
- [Cadastra uma mensagem para um pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/postmensagemprecadastro-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Endpoint para cadastrar mensagens de um pré-cadastro específico.
- [Retorna uma mensagem de um pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/getmensagemprecadastro.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Endpoint para consultar uma mensagem de um pré-cadastro específico.
- [Lista os pré-cadastros com filtros e paginação](https://desenvolvedor.cvcrm.com.br/reference/listarprecadastrosv3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna a listagem geral de pré-cadastros com suporte a filtros e paginação. Filtros disponíveis: idprecadastro, documento, idcorrespondente, idempresacorrespondente, idimobiliaria, idcorretor. Paginação: pagina, limite.
- [Cadastra o Pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/cadastraprecadastro.md): > 🔒 **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) A interface viabiliza o cadastro de um pré-cadastro do sistema CV, juntamente com o cadastro ou modificação da pessoa vinculada àquele pré-cadastro. É possível realizar associação de pessoas à pessoa titular do pré-cadastro. Todas as automações e associações disponíveis no sistema são possibilitadas nesta API, tais como envio de e-mail para os gestores informando o cadastro, envio de e-mail para a pessoa concluir o registro dos dados, criação de leads para cada pessoa do pré-cadastro.
- [Edita o Pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/editaprecadastro.md): > 🔒 **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) A interface viabiliza a edição dos dados de um pré-cadastro do sistema CV.
- [Retorna o Pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/retornaprecadastro.md): > 🔒 **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) A interface viabiliza a consulta de pré-cadastro. A consulta é realizada através dos dados enviados na URL, podendo conter idprecadastro ou documento do cliente, podendo também passar o limite e a página por parâmetro. A requisição retorna os dados do pré-cadastro caso seja especificado um idprecadastro ou documento do cliente, caso não, retorna todos os pré-cadastros.
- [Retorna a lista de pré-cadastros com filtro de indicador](https://desenvolvedor.cvcrm.com.br/reference/getprecadastros-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Endpoint para consultar pré-cadastros conforme indicador.
- [Retorna os Documentos do Pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/retornardocumento-3.md): > 🔒 **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) Retorna os documentos cadastrados no precadastro informado.
- [Cadastra Documentos no Pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/cadastrardocumento-3.md): > 🔒 **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) Interface responsável por cadastrar os documentos do precadastro dentro do Construtor de Vendas.
- [Altera Documentos no Pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/aprovardocumento-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Interface responsável por alterar situação de documentos do precadastro dentro do Construtor de Vendas.
- [Salva campos adicionais de um pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/postcamposadicionaisprecadastro.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Salva os valores dos campos adicionais configurados para a funcionalidade pré-cadastro. Cada chave do objeto campos_adicionais deve corresponder ao nome_referencia de um campo adicional ativo e vinculado à funcionalidade pré-cadastro.
- [Altera situação da reserva para cancelada](https://desenvolvedor.cvcrm.com.br/reference/cancelamento-4.md): > 🔒 **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) O sistema legado fará uma requisição a esta API para alterar a situação da reserva no Construtor de Vendas. A reserva terá sua situação modificada para a que tiver a flag 'cancelada. **Obs: Somente serão atualizadas as reservas em situação com flag diferente de 'cancelada', 'distrato', 'vendida' e 'vencida'. É necessário ter um 'Motivos de Cancelamento de Reserva' configurado como padrão.**
- [Retorna a reserva de acordo com os filtros](https://desenvolvedor.cvcrm.com.br/reference/getreserva-2.md): > 🔒 **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 serve como um informativo ao sistema legado acerca de determinada reserva que pode ser integrada como vendida. **Obs: Ela fará consultas no Construtor de Vendas pelo id da reserva que ainda não foi integrada.**
- [Cadastra uma reserva no Construtor de Vendas](https://desenvolvedor.cvcrm.com.br/reference/postreserva-2.md): > 🔒 **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 deve ser utilizada para cadastrar uma reserva no Construtor de Vendas. É necessário informar ao menos um dos campos de identificador ou identificador interno para cada campo que possue essa opção.
- [Atualiza uma reserva no Construtor de Vendas](https://desenvolvedor.cvcrm.com.br/reference/putreserva-2.md): > 🔒 **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 deve ser utilizada para atualizar uma reserva no Construtor de Vendas. É necessário informar ao menos um dos campos de identificador ou identificador interno para cada campo que possue essa opção.
- [Retorna as reservas de acordo com os filtros](https://desenvolvedor.cvcrm.com.br/reference/getreservas-4.md): > 🔒 **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 serve como um informativo ao sistema legado acerca das reservas que podem ser integradas como vendidas, por esse motivo não há solicitação de preenchimento de dados para a sua execução. Neste caso, como a requisição é do tipo 'GET', somente são necessários passar os parâmetros de autenticação por meio do HEADER, ou seja, a requisição não terá BODY. **Obs: Ela também fará consultas no Construtor de Vendas por reservas em situação com flag 'pode faturar' ou 'vendida', tendo o controle pelos parâmetros da query especificados exclusivamente (i.e. não pode especificar os dois num mesmo request).** **Obs2: Reservas que ainda não foram integradas (possuem a coluna codigointerno populada) não são listadas, este padrão pode ser configurado com o parâmetro retornar_integradas.**
- [Altera situação da reserva](https://desenvolvedor.cvcrm.com.br/reference/alterarsituacao.md): > 🔒 **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) Essa interface possibilita que outros sistemas realizem uma requisição para atualizar a situação.
- [Retorna dados do ERP Sienge da reserva](https://desenvolvedor.cvcrm.com.br/reference/getsiengereserva-2.md): > 🔒 **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) Esse endpoint retorna os dados do ERP Sienge na reserva informada.
- [Atualiza dados do ERP Sienge em uma reserva](https://desenvolvedor.cvcrm.com.br/reference/putsiengereserva-2.md): > 🔒 **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) Esse endpoint atualiza os dados enviado no corpo no ERP Sienge na reserva informada.
- [Retorna distratos de reservas](https://desenvolvedor.cvcrm.com.br/reference/distratoparticionado-2.md): > 🔒 **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) Retorna os distratos cadastrados no sistema, feito para integração com sistemas que necessitam um payload de informações menor
- [Altera situação da reserva para distrato](https://desenvolvedor.cvcrm.com.br/reference/distrato-4.md): > 🔒 **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) O sistema legado fará uma requisição a esta API para alterar a situação da reserva no Construtor de Vendas. A reserva terá sua situação modificada para a que tiver a flag 'distrato'. **Obs: Para que esta ação seja executada com êxito o campo preenchido idreserva deve existir no Construtor de Vendas. É obrigatório o preenchimento do campo relacionado no item body.**
- [Retorna as reservas com solicitações de distrato](https://desenvolvedor.cvcrm.com.br/reference/getsolicitacoesdistratos-1.md): > 🔒 **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) Retorna as reservas que possuem solicitações de distrato cadastradas no sistema.
- [Solicita o distrato da reserva](https://desenvolvedor.cvcrm.com.br/reference/postsolicitardistrato-1.md): > 🔒 **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) Solicita o distrato da reserva
- [Retorna a(s) análise(s) de crédito de uma reserva](https://desenvolvedor.cvcrm.com.br/reference/getanalisescredito-2.md): > 🔒 **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) Retorna a(s) análise(s) de crédito de uma reserva.
- [Retorna os kits de decoração da reserva](https://desenvolvedor.cvcrm.com.br/reference/getkitdecoracao-4.md): > 🔒 **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) Retorna os kits de decoração da reserva informada.
- [Associa um kit de decoração a uma reserva](https://desenvolvedor.cvcrm.com.br/reference/associarkitdecoracao-1.md): > 🔒 **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)
- [Retorna as cessões de direitos](https://desenvolvedor.cvcrm.com.br/reference/getcessao-2.md): > 🔒 **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) Retorna as cessões de direitos cadastradas no sistema.
- [Realiza cessão de direitos de uma reserva](https://desenvolvedor.cvcrm.com.br/reference/cessao-2.md): > 🔒 **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) Cessão é o processo de troca do cliente associado a unidade, como uma transferência de imóvel. Esta API fará requisições ao sistema legado para que lhe seja fornecido os dados da proposta que se deseja executar cessão no Construtor de Vendas, logo após irá verificar se os dados inseridos nos campos reserva, documento_novo_titular e documento_novo_associado existem ou não no Construtor de Vendas, somente se todos esses campos existirem será executada a troca do cliente. **Obs: Para que essas informações sejam inseridas no Construtor de Vendas, a reserva deve estar em situação com flag 'vendida'. Todos os documentos devem ser válidos.**
- [Retorna repasses](https://desenvolvedor.cvcrm.com.br/reference/getrepasses-2.md): > 🔒 **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) Retorna os repasses executados no CV, em todas as situações
- [Altera situação de um repasse](https://desenvolvedor.cvcrm.com.br/reference/postalterarsituacaorepasse-2.md): > 🔒 **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) Altera a situação de um repasse seguindo os pre-requisitos do workflow, realizando também a geração e aprovação de um protocolo
- [Cadastra mensagem no repasse](https://desenvolvedor.cvcrm.com.br/reference/postcadastrarmensagemrepasse-1.md): > 🔒 **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)
- [Retorna os números do Repasse ](https://desenvolvedor.cvcrm.com.br/reference/getnumerosrepasses-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna os números de repasses separado por situações. Todos, Ativos, Vencidos, Em Andamento e Novos
- [Retorna uma mensagem específica de um repasse](https://desenvolvedor.cvcrm.com.br/reference/getmensagemrepasse.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Consulta os dados de uma mensagem individual associada a um repasse. Requer autenticação JWT e retorna apenas mensagens ativas.
- [Atualiza situação da reserva para vendida](https://desenvolvedor.cvcrm.com.br/reference/informarvenda-2.md): > 🔒 **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) Essa interface possibilita que outros sistemas realizem uma requisição para atualizar a situação de uma reserva dentro do Construtor de Vendas para 'vendida'
- [Cadastra boleto para parcela de série do tipo Ato ou Sinal](https://desenvolvedor.cvcrm.com.br/reference/cadastrarboleto-2.md): > 🔒 **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) Interface responsável por cadastrar boletos dentro do Construtor de Vendas quando a parcela da reserva for da série do tipo Ato ou Sinal.
- [Atualiza boleto para parcela de série do tipo Ato ou Sinal](https://desenvolvedor.cvcrm.com.br/reference/atualizarboleto-2.md): > 🔒 **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) Interface responsável por atualizar a situação dos boletos dentro do Construtor de Vendas quando a parcela da reserva for da série do tipo Ato ou Sinal.
- [Retorna lote de pagamentos de comissão](https://desenvolvedor.cvcrm.com.br/reference/getlote-2.md): > 🔒 **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) A interface viabiliza a consulta de lote do sistema CV. A consulta é realizada através dos dados enviados na URL, podendo conter id do lote, podendo também passar o limite e a página por parâmetro. A requisição retorna os dados do(s) lote(s) caso seja especifícado um id do lote, caso não, retorna todos os lotes.
- [Cadastra lote de pagamentos de comissão](https://desenvolvedor.cvcrm.com.br/reference/cadastrarlote-2.md): > 🔒 **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) A interface viabiliza a criação de lote do sistema CV. A requisição cria o lote no CVCRM com os pagamentos das comissões, se não enviar os pagamentos irá inserir todos os pagamentos da comissão que não esteja num lote.
- [Altera lote de pagamentos de comissão](https://desenvolvedor.cvcrm.com.br/reference/alterarlote-2.md): > 🔒 **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) A interface viabiliza a alteração de lote do sistema CV. A requisição cria o lote no CVCRM com os pagamentos das comissões, se não enviar os pagamentos irá inserir todos os pagamentos da comissão que não esteja num lote.
- [Retorna as condições de pagamento de uma reserva](https://desenvolvedor.cvcrm.com.br/reference/getreservacondicaopagamentos-2.md): > 🔒 **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) A API tem o objetivo de apresentar a condição de pagamento da reserva com detalhamento de todas as séries, vencimentos e valores.**
- [Retornar contratos da reserva](https://desenvolvedor.cvcrm.com.br/reference/getreservacontratos-2.md): > 🔒 **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) A interface viabiliza a consulta dos contrato de uma reserva do sistema CV. A consulta é realizada através do id da reserva enviado na URL. A requisição retorna os dados do(s) contrato(s).
- [Cadastrar contratos na reserva](https://desenvolvedor.cvcrm.com.br/reference/cadastrarcontrato-2.md): > 🔒 **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) Interface responsável por cadastrar contratos da reserva dentro do Construtor de Vendas.
- [Envia contratos da reserva para a assinatura eletrônica](https://desenvolvedor.cvcrm.com.br/reference/assinturaeletronicacontrato-2.md): > 🔒 **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) Interface responsável por enviar os contratos da reserva para assinatura eletrônica.
- [Retorna os contratos assinados por assinatura eletrônica da reserva](https://desenvolvedor.cvcrm.com.br/reference/contratosassinados-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Interface responsável por retornar os contratos assinados por assinatura eletrônica da reserva.
- [Retorna os documentos cadastrados na reserva](https://desenvolvedor.cvcrm.com.br/reference/retornardocumento-4.md): > 🔒 **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) Retorna os documentos cadastrados na reserva informada.
- [Cadastra documentos na reserva](https://desenvolvedor.cvcrm.com.br/reference/cadastrardocumento-4.md): > 🔒 **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) Interface responsável por cadastrar os documentos da reserva dentro do Construtor de Vendas.
- [Retornar contrato específico da reserva (API v3)](https://desenvolvedor.cvcrm.com.br/reference/getcontratoreservav3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna um contrato específico de uma reserva através do ID da reserva e ID do contrato. Requer autenticação JWT.
- [Retorna os contratos da reserva que estão em assinatura eletrônica](https://desenvolvedor.cvcrm.com.br/reference/contratosassinaturaeletronica.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Interface responsável por retornar os contratos da reserva que estão em assinatura eletrônica.
- [Retorna as campanhas cadastradas na reserva](https://desenvolvedor.cvcrm.com.br/reference/retornarcampanha-2.md): > 🔒 **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) Retorna as campanhas cadastradas na reserva informada.
- [Cadastra mensagem na reserva](https://desenvolvedor.cvcrm.com.br/reference/cadastrarmensagem-1.md): > 🔒 **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)
- [Retorna a(s) mensagem(s) de uma reserva](https://desenvolvedor.cvcrm.com.br/reference/getmensagensreserva-1.md): > 🔒 **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)
- [Listar tipos de venda](https://desenvolvedor.cvcrm.com.br/reference/gettiposvenda.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna a lista de todos os tipos de venda ativos no painel
- [Cadastra as comissões de uma reserva no Construtor de Vendas](https://desenvolvedor.cvcrm.com.br/reference/cadastrarcomissoesreserva.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Interface responsável por cadastrar as comissões de uma reserva no Construtor de Vendas.
- [Deleta as comissões de uma reserva no Construtor de Vendas](https://desenvolvedor.cvcrm.com.br/reference/deletarcomissoesreserva.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Interface responsável por deletar as comissões de uma reserva no Construtor de Vendas.
- [Altera o correspondente da reserva](https://desenvolvedor.cvcrm.com.br/reference/alterarusuariocorrespondente-1.md): > 🔒 **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)
- [Retorna os indexadores](https://desenvolvedor.cvcrm.com.br/reference/retornarindexadores-1.md): > 🔒 **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 é responsável por retornar todos os indexadores cadastradas no CV, podendo filtrar pelo id, idindexador_int e nome do Indexador.
- [Recupera uma tabela de preço específica](https://desenvolvedor.cvcrm.com.br/reference/getexibirtabeladeprecov3-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) A interface viabiliza a consulta de uma tabela de preço de um empreendimento.
- [Recupera a lista de tabelas de preço](https://desenvolvedor.cvcrm.com.br/reference/getlistartabeladeprecov3-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) A interface viabiliza a consulta de tabelas de preços de um empreendimento.
- [Recupera a lista de tabelas de preço](https://desenvolvedor.cvcrm.com.br/reference/getabeladepreco.md): > 🔒 **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) A interface viabiliza a consulta de uma ou várias tabelas de preços de um empreendimento, retornando uma URL que redireciona para um arquivo de download ou retorna um JSON contendo os dados solicitados. (as unidades só retornarão quando enviar o idtabela)
- [Retorna as tabelas de preço ou uma tabela de preço mais detalhada](https://desenvolvedor.cvcrm.com.br/reference/gettabelasdeprecodetalhada-1.md): > 🔒 **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) A interface viabiliza a consulta de uma ou várias tabelas de preços de um empreendimento, retornando uma URL que redireciona para um arquivo de download ou retorna um JSON contendo os dados solicitados.
- [Retorna as tabelas de preço ou uma tabela de preço mais detalhada](https://desenvolvedor.cvcrm.com.br/reference/gettabelasdeprecoidtabeladetalhada-1.md): > 🔒 **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) A interface viabiliza a consulta de uma ou várias tabelas de preços de um empreendimento, retornando uma URL que redireciona para um arquivo de download ou retorna um JSON contendo os dados solicitados.
- [Cadastro de Séries de Tabelas de Preços](https://desenvolvedor.cvcrm.com.br/reference/cadastrarserietabelapreco.md): > 🔒 **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) A interface viabiliza o cadastro, a modificação e a remoção de uma série de tabela de preço no sistema CV. Verificando se o dado inserido no campo 'idserie_int' é compatível com algum código interno de uma série já cadastrada no CV, se não existir vai ocorrer a ação de cadastro, caso contrário vai ocorrer a ação de modificação. Para remover é preciso preencher o campo 'remover' com o código interno da série que deseja inativar.
- [Recupera a lista de tabelas de preço completa](https://desenvolvedor.cvcrm.com.br/reference/getseriestabeladepreco.md): > 🔒 **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) A interface viabiliza a consulta de uma ou várias séries de tabela de preços.
- [Retorna todas as gestões de distrato cadastradas](https://desenvolvedor.cvcrm.com.br/reference/getgestoesdistrato-1.md): > 🔒 **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) Este endpoint retorna uma lista de gestões de distrato cadastradas no sistema CV. Você pode filtrar os resultados usando parâmetros como `iddistrato`, `idreserva`, `idpessoa`, ou o número do `documento`. A resposta também inclui informações detalhadas sobre as gestões, como datas, motivos de cancelamento, observações, e outros metadados relevantes.
- [get gestão de cessão](https://desenvolvedor.cvcrm.com.br/reference/getgestoescessao.md): > 🔒 **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 é responsável por retornar todas as gestões de cessão cadastradas no CV.
- [Retorna todas as parcelas de pagamento da reserva](https://desenvolvedor.cvcrm.com.br/reference/getpagamentosparcelas.md): > 🔒 **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) A interface viabiliza a consulta das parcelas de pagamento das reservas retornando os dados, seu pagador e seu beneficiário.
- [Cadatra boletos das parcelas quando for tipo ato ou sinal](https://desenvolvedor.cvcrm.com.br/reference/alterarpagamentoparcela.md): > 🔒 **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) Interface responsável por cadastrar boletos dentro do Construtor de Vendas quando a parcela da reserva for da série do tipo ato ou sinal.
- [Cadastra um pagamento para uma comissão](https://desenvolvedor.cvcrm.com.br/reference/salvarpagamentocomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Cria um pagamento vinculado à comissão informada.
- [Retorna os pagamentos da comissão](https://desenvolvedor.cvcrm.com.br/reference/getcomissao.md): > 🔒 **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) Endpoint destinado à consulta das parcelas de pagamento das comissões registradas no sistema CVCRM. A interface retorna informações detalhadas de cada parcela, incluindo os dados do pagador e do beneficiário, permitindo o acompanhamento completo do fluxo de pagamento das comissões. Permite-se consultar por identificadores dos sistemas parceiros, terminados em _int. A consulta suporta paginação e filtros por data de criação ou vencimento, garantindo controle sobre o volume de dados retornados. A autenticação é realizada via headers utilizando e-mail e token.
- [Atualiza um pagamento de comissão](https://desenvolvedor.cvcrm.com.br/reference/atualizarpagamentocomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Atualiza os dados de um pagamento vinculado a uma comissão.
- [Remove pagamento de uma comissão](https://desenvolvedor.cvcrm.com.br/reference/removerpagamentocomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Remove um pagamento vinculado à comissão informada.
- [Alterar pagamento da comissão](https://desenvolvedor.cvcrm.com.br/reference/alterarpagamentocomissao.md): > 🔒 **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) Atualizar pagamentos de comissão. Permite alterar a situação do pagamento e/ou associar dados de boleto. O endpoint aceita dois grupos de dados independentes: - **Situação do pagamento** (`idsituacao_cv` ou `situacao`): obrigatório informar um dos dois. - **Dados do boleto** (`idpagamento_int` + `boleto_url` ou `boleto_base64`): opcional. Quando enviado, deve vir completo (o `idpagamento_int` é obrigatório junto com `boleto_url` ou `boleto_base64`). Caso contrário o sistema retorna erro 400. Se a requisição enviar apenas a situação, somente ela será alterada e os dados de boleto existentes permanecem intocados. Quando enviados vários `idpagamentos` junto com dados de boleto, um único registro de boleto é criado e vinculado a todos eles. Nesse caso, todos os pagamentos devem pertencer à mesma comissão. Autenticação: Requer email e token nos Headers da requisição.
- [Libera os pagamentos da comissão](https://desenvolvedor.cvcrm.com.br/reference/liberarpagamento.md): > 🔒 **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 rota permite que sistemas parceiros informem ao CVCRM que o valor de um pagamento está disponível para ser sacado pela equipe de venda. Requisitos: Obrigatório fornecer o identificador do pagamento (idpagamento_cv ou similar) no corpo da requisição. A autenticação é exigida no Header, usando email e token.
- [Bloqueia os pagamentos da comissão](https://desenvolvedor.cvcrm.com.br/reference/bloquearpagamento.md): > 🔒 **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) Este endpoint é a interface de gestão para bloquear pagamentos individuais de parcelas de comissões dentro do sistema Construtor de Vendas (CVCRM). O bloqueio impede que o pagamento seja processado ou disponibilizado para saque, sendo essencial para ações de retenção ou auditoria.
- [Anexa um documento a um pagamento de comissão](https://desenvolvedor.cvcrm.com.br/reference/anexardocumentopagamentocomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por anexar um documento a um pagamento de comissão
- [Retorna o pagamento de uma comissão](https://desenvolvedor.cvcrm.com.br/reference/pagamentocomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por retornar o pagamento de uma comissão
- [Retorna as mensagens de uma comissão](https://desenvolvedor.cvcrm.com.br/reference/mensagenscomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por retornar as mensagens de uma comissão
- [Cadastra uma mensagem em uma comissão](https://desenvolvedor.cvcrm.com.br/reference/mensagemcomissaocadastro.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por cadastrar as mensagens de uma comissão
- [Retorna a mensagem de uma comissão](https://desenvolvedor.cvcrm.com.br/reference/mensagemcomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por retornar a mensagem de uma comissão
- [Retorna os arquivos de uma mensagem da comissão](https://desenvolvedor.cvcrm.com.br/reference/mensagemarquivoscomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por retornar os arquivos de uma mensagem da comissão
- [Retorna o arquivo de uma mensagem da comissão](https://desenvolvedor.cvcrm.com.br/reference/mensagemarquivocomissao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por retornar o arquivo de uma mensagem da comissão
- [Atualiza as comissões de uma reserva no Construtor de Vendas](https://desenvolvedor.cvcrm.com.br/reference/atualizarcomissoesreserva.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Interface responsável por atualizar as comissões de uma reserva no Construtor de Vendas.
- [Recupera a lista de tipos de arquivos de pagamento de comissões](https://desenvolvedor.cvcrm.com.br/reference/gettiposarquivospagamentoscomissoes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Esta rota permite consultar e recuperar uma lista paginada de tipos de arquivos de pagamento de comissões registrados no sistema CVCRM. Os tipos de arquivos são utilizados para categorizar os documentos anexados aos pagamentos de comissões.
- [Altera a situação de uma comissão.](https://desenvolvedor.cvcrm.com.br/reference/alterarsituacao-7.md): > 🔒 **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) Endpoint destinado à movimentação da situação de uma comissão conforme o seu workflow. Para realizar a atualização, informe um identificador, seja ele do CVCRM ou do sistema parceiro e a nova situação do workflow desejada. Para o correto preenchimento deste endpoint, utilize as informações disponíveis na API de Workflow desta biblioteca, garantindo a utilização dos status e transições válidas definidos no fluxo de atendimento.
- [Cadastrar nova comissão](https://desenvolvedor.cvcrm.com.br/reference/postcomissao-2.md): > 🔒 **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) Endpoint destinado ao cadastro de uma comissão no sistema CVCRM. A comissão representa um valor percentual ou fixo pago a um profissional (corretor e/ou equipe de vendas) com base no valor do contrato ou em outra base definida pela incorporadora, conforme as regras configuradas no sistema. Para o cadastro, é necessário informar: Código da reserva à qual a comissão será vinculada; Empreendimento, bloco e unidade; Código da comissão no sistema parceiro (quando aplicável); Valor da comissão; Dados do beneficiário, como documento ou identificador; Classificação da comissão (comissão, prêmio ou extra). Caso a comissão seja parcelada, os dados das parcelas devem ser informados, incluindo as datas de vencimento correspondentes. Se já existir uma comissão ativa vinculada à reserva, o endpoint retornará erro de validação.
- [Recupera a lista de comissões](https://desenvolvedor.cvcrm.com.br/reference/getcomissoes-2.md): > 🔒 **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 rota permite consultar e recuperar uma lista paginada de comissões registradas no sistema CVCRM. A comissão representa um valor percentual ou fixo pago a um profissional (corretor e/ou equipe de vendas) com base no valor do contrato ou em outra base definida pela incorporadora, conforme suas regras configuradas no sistema. Para garantir a eficiência da consulta e evitar retornos excessivamente amplos, a requisição deve ser filtrada obrigatoriamente por pelo menos um dos seguintes parâmetros (além dos headers de autenticação): ID da comissão ID da reserva Documento do pagador Data de cadastro (a_partir_de) O endpoint utiliza paginação para controle do volume de registros retornados, permitindo melhor desempenho e previsibilidade nas integrações.
- [Retorna as regras de comissão da reserva no Construtor de Vendas](https://desenvolvedor.cvcrm.com.br/reference/listarcomissoesreservav3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Esta API deve ser utilizada para retornas as regras de comissão uma reserva no Construtor de Vendas.
- [Retorna as tarefas criadas do atendimento](https://desenvolvedor.cvcrm.com.br/reference/gettarefas-4.md): > 🔒 **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)
- [Retorna uma tarefa criada](https://desenvolvedor.cvcrm.com.br/reference/gettarefa-4.md): > 🔒 **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)
- [Encerra uma tarefa criada](https://desenvolvedor.cvcrm.com.br/reference/encerrartarefa-2.md): > 🔒 **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)
- [Obtém uma mensagem específica](https://desenvolvedor.cvcrm.com.br/reference/obtermensagemespecifica.md): > 🔒 **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)
- [Lista as mensagens de um atendimento](https://desenvolvedor.cvcrm.com.br/reference/listarmensagensatendimento.md): > 🔒 **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) Retorna o histórico de mensagens e respostas enviadas em um atendimento específico.
- [Altera os dados do atendimento](https://desenvolvedor.cvcrm.com.br/reference/alteraratendimento-1.md): > 🔒 **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)
- [Cadastrar Atendimento](https://desenvolvedor.cvcrm.com.br/reference/cadastrocv-2.md): > 🔒 **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) Formato de cadastro para cliente no CV
- [Adiciona uma mensagem no atendimento](https://desenvolvedor.cvcrm.com.br/reference/mensagematendimento-2.md): > ⚠️ **Substituído por `POST /v4/relacionamento/atendimentos/{idAtendimento}/mensagens`** > > Este endpoint continua publicado e com o mesmo comportamento — quem já integra com ele não > precisa fazer nada agora. Integrações novas devem usar o v4, que responde `201` na criação, > `409` quando o atendimento está finalizado e `404` quando ele não existe, em vez de `200` > com `erro: true` no corpo. > > 🔒 **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)
- [Lista os atendimentos](https://desenvolvedor.cvcrm.com.br/reference/listaratendimentos-2.md): > 🔒 **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)
- [Alterar situação do atendimento](https://desenvolvedor.cvcrm.com.br/reference/alterarsituacao-6.md): > 🔒 **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)
- [/workflows/{funcionalidade}/subworkflows](https://desenvolvedor.cvcrm.com.br/reference/retornarsubworkflows-1.md): > 🔒 **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) API responsável por retornar os subworkflows de uma funcionalidade
- [Realiza o cadastro de uma nova assistência técnica para o síndico](https://desenvolvedor.cvcrm.com.br/reference/cadastrarassistenciasindico.md): > 🔒 **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) Para o cadastro de uma assistência técnica é necessário o documento ou o 'idsindico' de um síndico cadastrado no sistema, pelo menos um item da assistência e os valores de um dos atributos de entre 'unidade', 'unidade_avulsa', 'area' e 'localidade'.
- [Criar nova assistência](https://desenvolvedor.cvcrm.com.br/reference/cadastrarassistencia-2.md): > 🔒 **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) Cria um novo chamado de manutenção/atendimento técnico, iniciando o fluxo completo de assistência. **Finalidade funcional:** Permitir que clientes, equipes internas, pós-obra ou SAC iniciem uma solicitação de reparo. **O que normalmente é enviado:** - Identificação da unidade ou empreendimento - Descrição clara do problema - Possíveis itens pré-classificados **Dados do solicitante:** - Informações complementares exigidas pela política interna da empresa **Valor para o negócio:** É o ponto de partida para gerar rastreabilidade de problemas construtivos e atendimento ao cliente.
- [Listar assistências](https://desenvolvedor.cvcrm.com.br/reference/getallassistenciasativas.md): > 🔒 **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) Retorna todas as assistências disponíveis para o usuário autenticado, considerando permissões, filtros internos e parametrizações do módulo. **Finalidade funcional:** Exibir ao cliente ou equipe técnica uma visão consolidada de todos os chamados, permitindo acompanhamento completo do ciclo de atendimento. **Principais usos:** - Tela inicial de Assistências no app - Painéis operacionais internos - Filtros por status, data, situação ou prioridade **Retorno típico:** - Dados resumidos (status atual, descrição principal, solicitante) - Indicadores de progresso - Última atualização - Situação operacional (aberta, em análise, concluída etc.)
- [Consultar detalhes completos da assistência](https://desenvolvedor.cvcrm.com.br/reference/getassistenciabyid.md): > 🔒 **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) Retorna todas as informações de uma assistência específica, incluindo: - Dados gerais do chamado - Itens associados - Histórico de mensagens - Visitas agendadas - Situação atual - Anexos enviados - Dados de diagnóstico (quando aplicável) **Uso:** Tela de detalhes completa no aplicativo, proporcionando transparência total ao usuário final e suporte interno.
- [Atualizar informações da assistência](https://desenvolvedor.cvcrm.com.br/reference/alterarassistencia.md): > 🔒 **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) Permite alterar dados gerais do chamado, como: - Descrição - Informações de contato - Dados complementares - Ajustes operacionais **Uso típico:** Correção de informações enviadas incorretamente pelo solicitante ou atualização realizada por equipes internas após triagem.
- [Alterar situação do chamado](https://desenvolvedor.cvcrm.com.br/reference/alterarsituacaoassistencia.md): > 🔒 **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) Atualiza o status da assistência conforme o fluxo operacional definido pela empresa. **Exemplos de situações possíveis:** - Aberta - Em análise - Aguardando visita - Em atendimento - Concluída - Cancelada **Quando é usado:** Após triagem, conclusão de visitas, finalização de reparos ou quando o cliente solicita cancelamento. **Impacto funcional:** Esta rota é o motor do workflow da assistência.
- [Alterar situação de uma visita técnica](https://desenvolvedor.cvcrm.com.br/reference/alterarsituacaovisitaassistencia.md): > 🔒 **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) Atualiza o status de uma visita específica. **Situações comuns:** - Agendada - Em rota - Realizada - Não realizada (cliente ausente) - Cancelada **Impacto:** Garante rastreamento operacional e coordenação entre equipes e cliente.
- [Agendar nova visita](https://desenvolvedor.cvcrm.com.br/reference/cadastrarvisita.md): > 🔒 **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) Permite registrar uma visita técnica, definindo: - Data - Período (manhã/tarde) - Técnico responsável - Observações **Papel no fluxo:** Etapa essencial para execução do atendimento.
- [Altera os dados da visita](https://desenvolvedor.cvcrm.com.br/reference/alterarvisitaassistencia.md): > 🔒 **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)
- [Listar visitas técnicas da assistência (V3)](https://desenvolvedor.cvcrm.com.br/reference/listarvisitastecnicasv3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token)
- [Consultar detalhes da visita técnica (V3)](https://desenvolvedor.cvcrm.com.br/reference/getvisitatecnicav3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token)
- [Listar equipes disponíveis](https://desenvolvedor.cvcrm.com.br/reference/getequipes.md): > 🔒 **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) Retorna equipes técnica cadastradas, responsáveis pelos atendimentos. **Informações comuns:** - Nome da equipe - Área de atuação - Disponibilidade
- [Listar profissionais da equipe](https://desenvolvedor.cvcrm.com.br/reference/getequipeusuarios.md): > 🔒 **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) Retorna os usuários associados à equipe selecionada. **Usado para:** - Escalar atendimentos - Vincular técnicos a visitas - Exibir responsáveis no app
- [Adicionar item](https://desenvolvedor.cvcrm.com.br/reference/adicionaritem.md): > 🔒 **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) Inclui um novo item (patologia ou categoria de problema) no chamado. **Uso típico:** Cliente envia descrição de novos problemas durante o atendimento, ou a equipe técnica detecta itens adicionais durante uma visita.
- [Atualizar situação de um item específico](https://desenvolvedor.cvcrm.com.br/reference/alterarsituacaoitemassistencia.md): > 🔒 **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) Permite alterar o status de um item dentro da assistência. **Situações comuns:** - Pendente - Em execução - Resolvido - Não procedente (item indeferido) **Finalidade:** Acompanhar, individualmente, a evolução de cada problema registrado.
- [Modifica os dados do item](https://desenvolvedor.cvcrm.com.br/reference/alteraritemassistencia.md): > 🔒 **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)
- [Remover item da assistência](https://desenvolvedor.cvcrm.com.br/reference/removeritemassistencia.md): > 🔒 **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) Remove um item específico vinculado ao chamado. **Usado quando:** O item foi registrado incorretamente ou se refere a um problema duplicado.
- [Listar mensagens da assistência](https://desenvolvedor.cvcrm.com.br/reference/listarmensagensassistencia.md): > 🔒 **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) Retorna o histórico de mensagens trocadas na assistência técnica, permitindo filtrar pelo tipo de mensagem (ex: visita).
- [Consultar mensagem específica da assistência](https://desenvolvedor.cvcrm.com.br/reference/consultarmensagemespecifica.md): > 🔒 **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) Retorna os detalhes de uma mensagem específica trocada na assistência técnica.
- [Enviar mensagem](https://desenvolvedor.cvcrm.com.br/reference/adicionarmensagem.md): > 🔒 **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) Adiciona uma nova mensagem ao chat. **Por que é importante:** Evita comunicação dispersa e concentra todas as evidências dentro do chamado.
- [Listar tipos de itens de manutenção](https://desenvolvedor.cvcrm.com.br/reference/getitensmanutencao.md): > 🔒 **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) Retorna o catálogo de itens/patologias disponíveis para uso. **Por que isso importa?** Permite padronizar o registro de problemas, facilitando: - Relatórios gerenciais - Controle de garantia - Indicadores de qualidade
- [Cadastra item de manutenção](https://desenvolvedor.cvcrm.com.br/reference/cadastraritemmanutencao.md): > 🔒 **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)
- [Listar áreas comuns configuradas](https://desenvolvedor.cvcrm.com.br/reference/getareascomuns.md): > 🔒 **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) Retorna áreas comuns cadastradas (ex.: piscina, salão de festas, hall social). **Finalidade:** Assistências relacionadas à infraestrutura do condomínio.
- [Listar patologias cadastradas](https://desenvolvedor.cvcrm.com.br/reference/getpatologias.md): > 🔒 **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) Retorna todas as patologias/tipos de problema registradas no sistema. **Importância operacional:** Define os itens que podem ser vinculados a assistências, garantindo padrão e clareza no registro.
- [Criar nova patologia](https://desenvolvedor.cvcrm.com.br/reference/cadastrarpatologia.md): > 🔒 **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) Adiciona uma nova tipologia de problema ao catálogo.
- [Retorna uma patologia](https://desenvolvedor.cvcrm.com.br/reference/getpatologia.md): > 🔒 **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)
- [Atualizar patologia existente](https://desenvolvedor.cvcrm.com.br/reference/atualizarpatologia.md): > 🔒 **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) Permite alterar nome, descrição ou status (ativo/inativo).
- [Remover patologia](https://desenvolvedor.cvcrm.com.br/reference/removerpatologia.md): > 🔒 **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) Remove a patologia indicada (desde que não vinculada a assistências).
- [Upload de anexos](https://desenvolvedor.cvcrm.com.br/reference/assistenciaupload.md): > 🔒 **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) Realiza o envio de arquivos, como: - Fotos do problema - Vídeos - Documentos - PDFs de laudos **Funcionalidades atendidas:** - Assistência - Itens - Visitas - Conversas **Impacto funcional:** Aumenta a precisão do diagnóstico e reduz retrabalho.
- [Listar localidades disponíveis](https://desenvolvedor.cvcrm.com.br/reference/getlocalidades.md): > 🔒 **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) Retorna regiões, cidades ou localidades configuradas para o módulo. **Utilização funcional:** Popular dropdowns no app e auxiliar na triagem de assistências por área.
- [Listar vistorias de um agendamento](https://desenvolvedor.cvcrm.com.br/reference/getvistoriasagendamento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna a lista de vistorias vinculadas a um agendamento específico.
- [Consultar uma vistoria específica](https://desenvolvedor.cvcrm.com.br/reference/getvistoriabyid.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna os detalhes de uma vistoria técnica específica vinculada ao agendamento.
- [Listar visitas de um agendamento](https://desenvolvedor.cvcrm.com.br/reference/getvisitasagendamento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna a lista de todas as visitas técnicas vinculadas a um agendamento.
- [Consultar uma visita específica](https://desenvolvedor.cvcrm.com.br/reference/getvisitabyid.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna os dados de uma única visita técnica vinculada ao agendamento.
- [Consultar detalhes de um agendamento](https://desenvolvedor.cvcrm.com.br/reference/getagendamentobyid.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna os dados detalhados de uma campanha de agendamento específica. Requer Bearer Token V3.
- [Realizar login](https://desenvolvedor.cvcrm.com.br/reference/auth-1.md): Realizar o login e gera o token com validade de 1 hora
- [Realizar login como síndico](https://desenvolvedor.cvcrm.com.br/reference/authsindico.md): Realizar o login do síndico e gera o token com validade de 1 hora
- [Realizar login](https://desenvolvedor.cvcrm.com.br/reference/authexterna.md): Realizar o login a partir de um SSO externo.
- [Envia o código de verificação para autenticação externa](https://desenvolvedor.cvcrm.com.br/reference/codigoverificacao-2.md): Faz o envio de um código de verificação, valido por 30min, que deve ser utilizado para autenticação externa.
- [Gera o token de autenticação externa](https://desenvolvedor.cvcrm.com.br/reference/validarautenticacao-2.md): Valida o código de verificação de um cliente e retorna o Token de acesso do portal do cliente.
- [Salva os boletos para o Portal do cliente](https://desenvolvedor.cvcrm.com.br/reference/uploadboleto.md): > 🔒 **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) Interface responsável salvar boletos para exibição no Portal do Cliente.
- [Retorna os boletos de uma reserva](https://desenvolvedor.cvcrm.com.br/reference/getboletosegundaviacv.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Api responsável por retornar os boletos de uma reserva
- [Atualiza a situação do pagamento no cv](https://desenvolvedor.cvcrm.com.br/reference/informarpagamento.md): > 🔒 **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) Interface responsável por informar a situação de pagamento de um boleto.
- [Salva os boletos para serem exibidos no portal do cliente](https://desenvolvedor.cvcrm.com.br/reference/uploadextrato.md): > 🔒 **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) Interface responsável salvar extratos para exibição no Portal do Cliente.
- [salva a renda para ser exibida no portal do cliente](https://desenvolvedor.cvcrm.com.br/reference/uploadir.md): > 🔒 **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) Interface responsável salvar o demnostrativo de renda para exibição no Portal do Cliente.
- [Retorna as datas disponíveis para agendamento de determinado empreendimento](https://desenvolvedor.cvcrm.com.br/reference/dadosdataagendamento-3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os horários disponíveis para agendamento em uma determinada unidade em uma data](https://desenvolvedor.cvcrm.com.br/reference/agendamentohorarios-3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Cancelar um determinado agendamento, seja visita ou vistoria](https://desenvolvedor.cvcrm.com.br/reference/cancelaragendamento-3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as unidades do cliente disponíveis para agendamento](https://desenvolvedor.cvcrm.com.br/reference/listagemnovo.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna dados de um determinado agendamento com a unidade](https://desenvolvedor.cvcrm.com.br/reference/dadosagendamento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Cadastrar um agendamento para o cliente](https://desenvolvedor.cvcrm.com.br/reference/cadastraragendamento-3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os agendamentos ativos que o cliente está associado](https://desenvolvedor.cvcrm.com.br/reference/agendamentos-8.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as situações possíveis para um agendamento](https://desenvolvedor.cvcrm.com.br/reference/listaragendamentossituacoes.md): > 🔒 **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)
- [Retorna os dados de uma assistência técnica](https://desenvolvedor.cvcrm.com.br/reference/assistenciacompleta.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Retornará um dos atributos 'unidade', 'unidade_avulsa', 'area' ou 'localidade' de acordo com os dados cadastrados na assistência.
- [Realiza o cadastro de uma nova assistência técnica](https://desenvolvedor.cvcrm.com.br/reference/cadastrarassistencia-4.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Para o cadastro de uma assistência técnica é pelo menos um item da assistência e os valores de um dos atributos de entre 'unidade', 'unidade_avulsa', 'area' e 'localidade'.
- [Faz o upload dos arquivos na mensagem da assistência](https://desenvolvedor.cvcrm.com.br/reference/assistenciauploadarquivos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Faz o upload dos arquivos da assistência](https://desenvolvedor.cvcrm.com.br/reference/assistenciauploaddocumentos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Cadastra uma mensagem na assistência](https://desenvolvedor.cvcrm.com.br/reference/cadastrarmensagemassistencia-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as datas disponíveis para visita técnica de acordo com o item](https://desenvolvedor.cvcrm.com.br/reference/dataitem.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os horários disponíveis para visita técnica para a data informada](https://desenvolvedor.cvcrm.com.br/reference/visita.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Cadastra uma visita técnica](https://desenvolvedor.cvcrm.com.br/reference/cadastrarvisitatecnica-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Faz o upload dos arquivos de um item da assistência](https://desenvolvedor.cvcrm.com.br/reference/assistenciauploaddocumentositem.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Envie os arquivos de um item da assistência antes do cadastro. Use o mesmo `uniqid` informado no item correspondente em `itens` no `POST /assistencia` para que os arquivos sejam vinculados ao item criado.
- [Retorna as assistências técnicas do cliente](https://desenvolvedor.cvcrm.com.br/reference/listarassistenciastecnicas.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Retornará um dos atributos 'unidade', 'unidade_avulsa', 'area' ou 'localidade' de acordo com os dados cadastrados na assistência.
- [Retorna as situações possíveis para uma assistência tecnica](https://desenvolvedor.cvcrm.com.br/reference/listarassistenciasituacoes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as áreas comuns das assistências técnicas](https://desenvolvedor.cvcrm.com.br/reference/listarassistenciaareacomum.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar as associações ao cliente](https://desenvolvedor.cvcrm.com.br/reference/listarassociacoes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Adiciona uma associação do cliente](https://desenvolvedor.cvcrm.com.br/reference/adicionarassociacao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Adiciona uma associação de uma pessoa não cadastrada no sistema](https://desenvolvedor.cvcrm.com.br/reference/adicionarassociacaopessoa.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Remove uma associação do cliente](https://desenvolvedor.cvcrm.com.br/reference/removerassociacao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Atualiza os dados de uma associação do cliente](https://desenvolvedor.cvcrm.com.br/reference/atualizaassociacao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar os tipos de associações cadastrados no sistema](https://desenvolvedor.cvcrm.com.br/reference/listarassociacaotipos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os dados de um atendimento](https://desenvolvedor.cvcrm.com.br/reference/atendimentocompleto.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os atendimentos ativos que o cliente está associado e é permitido a visualização](https://desenvolvedor.cvcrm.com.br/reference/atendimentos-19.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realiza o cadastro de um atendimento](https://desenvolvedor.cvcrm.com.br/reference/cadastroatendimento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Faz o upload dos arquivos do atendimento](https://desenvolvedor.cvcrm.com.br/reference/atendimentoupload.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Responde um determinado atendimento](https://desenvolvedor.cvcrm.com.br/reference/responderatendimento-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Avalia um atendimento](https://desenvolvedor.cvcrm.com.br/reference/avaliaratendimento-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os assuntos do atendimento](https://desenvolvedor.cvcrm.com.br/reference/assuntos-3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os subassuntos de assunto do atendimento](https://desenvolvedor.cvcrm.com.br/reference/subassuntos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as areas comum do atendimento](https://desenvolvedor.cvcrm.com.br/reference/areacomum.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as situaçõea possíveis em um atendimento](https://desenvolvedor.cvcrm.com.br/reference/listaratendimentossituacoes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os banners ativos do painel do cliente](https://desenvolvedor.cvcrm.com.br/reference/banners-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os campos adicionais do cliente](https://desenvolvedor.cvcrm.com.br/reference/retornacamposadicionais-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os comunicados dos empreendimentos referente ao cliente logado](https://desenvolvedor.cvcrm.com.br/reference/retornacomunicados.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as configurações do painel do cliente](https://desenvolvedor.cvcrm.com.br/reference/configuracao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Retorna uma única configuração que estiver ativa
- [Retorna o dominio dos múltiplos portais cadastrados](https://desenvolvedor.cvcrm.com.br/reference/dominiosportais.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna se o slug informado é válido](https://desenvolvedor.cvcrm.com.br/reference/validarslug.md)
- [Retornar os contratos das unidades do cliente](https://desenvolvedor.cvcrm.com.br/reference/listarcontratos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os documentos do síndico ](https://desenvolvedor.cvcrm.com.br/reference/documentossindico.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retona os dados dos empreendimentos associados ao cliente](https://desenvolvedor.cvcrm.com.br/reference/listarempreendimentos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retona os dados dos empreendimentos ativos no sistemas](https://desenvolvedor.cvcrm.com.br/reference/listarempreendimentosativos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Opcionalmente pode ser informado o parâmetro **documento** para filtrar os empreendimentos. Mostrando, assim, apenas os empreendimentos quais possuem reservas com o CPF/CNPJ do cliente informado.
- [Retorna a galeria de fotos de um empreendimento](https://desenvolvedor.cvcrm.com.br/reference/listargaleriafotosempreendimento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna a galeria de fotos de uma unidade](https://desenvolvedor.cvcrm.com.br/reference/listargaleriafotosunidade.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os estágios do andamento da obra de um empreendimento](https://desenvolvedor.cvcrm.com.br/reference/andamentoobraempreendimento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os estágios do andamento da obra de uma unidade](https://desenvolvedor.cvcrm.com.br/reference/andamentoobraunidade.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os comunicados do empreendimento buscado](https://desenvolvedor.cvcrm.com.br/reference/retornacomunicadosporempreendimento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os documentos do empreendimento do cliente](https://desenvolvedor.cvcrm.com.br/reference/listardocumentos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os documentos do síndico do empreendimento](https://desenvolvedor.cvcrm.com.br/reference/documentossindicoempreendimento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realiza o cadastro dos arquivos do síndico no empreendimento](https://desenvolvedor.cvcrm.com.br/reference/empreendimentocadastroarquivos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Faz o upload dos arquivos do síndico do empreendimento](https://desenvolvedor.cvcrm.com.br/reference/empreendimentouploadarquivos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar os logradouros cadastrados no sistema](https://desenvolvedor.cvcrm.com.br/reference/listarlogradouros.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar os estados cadastrados no sistema](https://desenvolvedor.cvcrm.com.br/reference/listarestados.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar as cidades de um estado cadastrados no sistema](https://desenvolvedor.cvcrm.com.br/reference/listarcidades.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os boletos que o cliente possui](https://desenvolvedor.cvcrm.com.br/reference/getboletosegundavia.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna um link com o pdf gerado do boleto](https://desenvolvedor.cvcrm.com.br/reference/gerarboleto.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as unidades que é possivel requisitar o relatório de imposto de renda](https://desenvolvedor.cvcrm.com.br/reference/retornorelatorioir.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Solicitação o envio do relatório do imposto de renda no Sienge](https://desenvolvedor.cvcrm.com.br/reference/enviarrelatorioir.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Link para download do relatório do imposto de renda no Sienge](https://desenvolvedor.cvcrm.com.br/reference/baixarrelatorioir.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna o extrato do cliente](https://desenvolvedor.cvcrm.com.br/reference/retornoextratos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna um link com o pdf gerado do extrato](https://desenvolvedor.cvcrm.com.br/reference/gerarextrato.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna um link com o pdf do saldo devedor](https://desenvolvedor.cvcrm.com.br/reference/retornarsaldodevedor.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Envia o extrato do cliente por e-mail](https://desenvolvedor.cvcrm.com.br/reference/retornoextratoenviar.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os parcelas disponiveis para antecipação de uma unidade](https://desenvolvedor.cvcrm.com.br/reference/getparcelasantecipacao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as parcelas antecipadas de uma unidade que foram confirmadas](https://desenvolvedor.cvcrm.com.br/reference/getparcelasconfirmadas.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realiza a simulação de Antecipação de Parcelas](https://desenvolvedor.cvcrm.com.br/reference/simularantecipacao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realiza a solicitação de Antecipação de Parcelas](https://desenvolvedor.cvcrm.com.br/reference/efetuarantecipacao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os reparcelamentos realizados de uma unidade](https://desenvolvedor.cvcrm.com.br/reference/retornarreparcelamentos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realiza o reparcelamento de uma ou mais parcelas](https://desenvolvedor.cvcrm.com.br/reference/efetuarreparcelamento.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os boletos que o cliente possui em determinada unidade](https://desenvolvedor.cvcrm.com.br/reference/getboletosegundaviacv-3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os extratos que o cliente possui em determinada unidade](https://desenvolvedor.cvcrm.com.br/reference/getextratocv.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna o IR que o cliente possui em determinada unidade](https://desenvolvedor.cvcrm.com.br/reference/getircv.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os itens de manutenção das assistências técnicas](https://desenvolvedor.cvcrm.com.br/reference/listarassistenciaitensmanutencao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as localidades das assistências técnicas](https://desenvolvedor.cvcrm.com.br/reference/listarassistencialocalidade.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Cadastra um novo dispositivo](https://desenvolvedor.cvcrm.com.br/reference/cadastrardispositivo-4.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Remove um dispositivo](https://desenvolvedor.cvcrm.com.br/reference/removerdispositivo-4.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as últimas notificações de um cliente](https://desenvolvedor.cvcrm.com.br/reference/listarnotificacoes-4.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Marca uma notificação como lida](https://desenvolvedor.cvcrm.com.br/reference/marcarnotificacaocomolida-4.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as permissões de notificação de um cliente](https://desenvolvedor.cvcrm.com.br/reference/listarconfiguracaonotificacoes-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Cria ou atualiza uma permissão de notificação de um cliente](https://desenvolvedor.cvcrm.com.br/reference/criaatualizaconfiguracaonotificacao-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna os marketplaces vinculados a um portal do cliente](https://desenvolvedor.cvcrm.com.br/reference/listarportalbeneficios.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar o espaço de Patrimônio de Afetação do empreendimento](https://desenvolvedor.cvcrm.com.br/reference/retornarespacopatrimonioafetacao.md): > 🔒 **Autenticação necessária** Retorna o espaço de Patrimônio de Afetação do empreendimento selecionado no portal, desde que o cliente autenticado seja **membro ativo** da comissão de representantes. O portal usa esta resposta para decidir se exibe o item de menu (200 exibe; 403/404 oculta).
- [Listar as mensagens do chat do espaço](https://desenvolvedor.cvcrm.com.br/reference/listarmensagenspatrimonioafetacao.md): > 🔒 **Autenticação necessária** Lista as mensagens do chat do espaço em ordem cronológica (autores gestor e clientes), com filtro opcional por período. Restrito a clientes membros ativos da comissão.
- [Enviar mensagem no chat do espaço](https://desenvolvedor.cvcrm.com.br/reference/criarmensagempatrimonioafetacao.md): > 🔒 **Autenticação necessária** Cria uma mensagem no chat com autor cliente (multipart/form-data). Texto e/ou anexos — formatos aceitos: PDF, DOCX, XLSX, JPG, PNG; máximo de 20 MB por arquivo. Restrito a clientes membros ativos da comissão. O cliente não remove mensagens.
- [Remover a própria mensagem do chat](https://desenvolvedor.cvcrm.com.br/reference/removermensagempatrimonioafetacao.md): > 🔒 **Autenticação necessária** Remove uma mensagem do chat. O cliente só pode remover mensagens de **sua própria autoria** — mensagens do gestor ou de outros membros retornam 403.
- [Baixar um anexo de mensagem do chat](https://desenvolvedor.cvcrm.com.br/reference/obterarquivomensagempatrimonioafetacao.md): > 🔒 **Autenticação necessária** Retorna o anexo da mensagem conforme a ação solicitada (link temporário ou download). Valida que o anexo pertence à mensagem e a mensagem ao espaço do empreendimento. Restrito a clientes membros ativos da comissão.
- [Listar os documentos do espaço](https://desenvolvedor.cvcrm.com.br/reference/listardocumentospatrimonioafetacao.md): > 🔒 **Autenticação necessária** Lista os documentos (biblioteca do gestor) do espaço do empreendimento selecionado. Somente leitura — o cliente não faz upload nem remove. Restrito a clientes membros ativos da comissão.
- [Baixar um documento do espaço](https://desenvolvedor.cvcrm.com.br/reference/obterdocumentopatrimonioafetacao.md): > 🔒 **Autenticação necessária** Retorna o documento conforme a ação solicitada (link temporário ou download). Valida que o documento pertence ao espaço do empreendimento (anti-IDOR). Restrito a clientes membros ativos da comissão.
- [Listar a comissão de representantes do empreendimento](https://desenvolvedor.cvcrm.com.br/reference/listarcomissaopatrimonioafetacao.md): > 🔒 **Autenticação necessária** Lista os membros ativos da comissão de representantes do empreendimento para o cliente que **já faz parte da comissão** — o espaço é de acesso exclusivo, e quem está na lista enxerga quem são os demais integrantes. Retorna somente nome e cargo, nenhum dado de contato. A ordenação é fixa: hierarquia do cargo (presidente, secretário, membro, suplente) e, dentro do mesmo cargo, ordem alfabética por nome.
- [Retorna as perguntas frequentes do portal](https://desenvolvedor.cvcrm.com.br/reference/listarperguntasfrequentes.md)
- [Retorna as permissões dos perfis do cliente de acordo com configuração do painel do cliente](https://desenvolvedor.cvcrm.com.br/reference/permissoesperfis.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as permissões do síndico de acordo com configuração do painel do cliente](https://desenvolvedor.cvcrm.com.br/reference/permissoesperfissindico.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar as pesquisas ativas para o usuário](https://desenvolvedor.cvcrm.com.br/reference/listarpesquisas.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as resposta do cliente de uma pesquisa](https://desenvolvedor.cvcrm.com.br/reference/retornarrespostapesquisa.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realizar cadastro de um novo cliente](https://desenvolvedor.cvcrm.com.br/reference/cadastrocliente.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Realizar cadastro de um novo cliente
- [Retorna os dados do cliente logado](https://desenvolvedor.cvcrm.com.br/reference/getuser.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Modifica o cliente de acordo com os dados passados](https://desenvolvedor.cvcrm.com.br/reference/modificar.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Modifica o endereço do usuário](https://desenvolvedor.cvcrm.com.br/reference/atualizarendereco.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna o token do cliente](https://desenvolvedor.cvcrm.com.br/reference/pessoatoken.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retornar os dados de uma pessoa pelo seu documento](https://desenvolvedor.cvcrm.com.br/reference/pessoadados.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Ativa a conta de uma pessoa](https://desenvolvedor.cvcrm.com.br/reference/pessoaativar.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Define a unidade padrão de um cliente](https://desenvolvedor.cvcrm.com.br/reference/pessoaunidadepadrao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realizar exclusão de dados ](https://desenvolvedor.cvcrm.com.br/reference/pessoaexcluirdados-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Realiza exclusão de dados do cliente
- [Retorna os pré cadastros do cliente pendentes de documento](https://desenvolvedor.cvcrm.com.br/reference/retornarprecadastrospendentes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna as reservas do cliente pendentes de documento](https://desenvolvedor.cvcrm.com.br/reference/retornarreservaspendentes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Resetar senha recebendo pelo email](https://desenvolvedor.cvcrm.com.br/reference/resetporemail.md): Envia e-mail ao cliente do endereço informado com um link que será usado para redefinir a senha
- [Resetar senha do síndico por email](https://desenvolvedor.cvcrm.com.br/reference/resetporemailsindico.md): Envia um e-mail ao síndico informado com um link que será usado para redefinir a senha
- [Resetar senha recebendo por SMS](https://desenvolvedor.cvcrm.com.br/reference/resetporsms.md): Envia SMS ao cliente com o número selecionado com um link que será usado para redefinir a senha
- [Resetar senha do síndico por SMS](https://desenvolvedor.cvcrm.com.br/reference/resetporsmssindico.md): Envia um SMS ao síndico com um link que será usado para redefinir a senha
- [Retorna os dados do síndico logado](https://desenvolvedor.cvcrm.com.br/reference/getsindico.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Modifica o síndico de acordo com os dados passados](https://desenvolvedor.cvcrm.com.br/reference/modificarsindico.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Modifica o avatar do síndico](https://desenvolvedor.cvcrm.com.br/reference/alterar_avatar.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retorna um termo a ser aceitado pelo cliente](https://desenvolvedor.cvcrm.com.br/reference/listtermoaceite.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Realiza o aceite do termo](https://desenvolvedor.cvcrm.com.br/reference/aceitartermo.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retona os dados das unidades ativas associadas ao usuário](https://desenvolvedor.cvcrm.com.br/reference/listarunidades.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retona os dados da unidade ativas filtrada pelo seu id](https://desenvolvedor.cvcrm.com.br/reference/retornaunidade.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retona os documentos da unidade](https://desenvolvedor.cvcrm.com.br/reference/retornaunidadedocumentospastas-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Retona os documentos da unidade](https://desenvolvedor.cvcrm.com.br/reference/retornaunidadedocumentos.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.
- [Gera token curto de autenticação](https://desenvolvedor.cvcrm.com.br/reference/tinitokencadastro.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Cadastra e retorna o Token de acesso as APIs do portal do cliente
- [Lista tokens curtos de autenticação cadastrados](https://desenvolvedor.cvcrm.com.br/reference/tinitokenlistagem.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Lista os Tokens de acesso as APIs do portal do cliente
- [Atualiza um token curto de autenticação](https://desenvolvedor.cvcrm.com.br/reference/tinitokenatualizacao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Atualiza um Token de acesso as APIs do portal do cliente
- [Remove um token curto de autenticação](https://desenvolvedor.cvcrm.com.br/reference/tinitokenremocao.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Remove um Token de acesso as APIs do portal do cliente
- [Envia o token curto de autenticação por e-mail](https://desenvolvedor.cvcrm.com.br/reference/tinitokenemail.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: `POST /api/v1/cliente/autenticacao` (documento e senha do cliente) ou `POST /api/v1/cliente/autenticacao/sindico` (síndicos). > ⚠️ O token de integração das APIs v2/v3 (`POST /api/v3/auth/token`) **não é válido** para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos. Envia o Token de acesso as APIs do portal do cliente por e-mail para o cliente
- [Retorna os assuntos de atendimento](https://desenvolvedor.cvcrm.com.br/reference/getassuntos-1.md): > 🔒 **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)
- [Realiza o cadastro de um novo atendimento](https://desenvolvedor.cvcrm.com.br/reference/cadastraratendimento.md): > 🔒 **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)
- [Finaliza um atendimento](https://desenvolvedor.cvcrm.com.br/reference/finalizaratendimento.md): > 🔒 **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)
- [Solicitação de envio por e-mail dos contratos associados ao cliente](https://desenvolvedor.cvcrm.com.br/reference/contratos-6.md): > 🔒 **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)
- [Solicitação de envio por e-mail da segunda via dos boletos da unidade](https://desenvolvedor.cvcrm.com.br/reference/segundavia.md): > 🔒 **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)
- [Solicitação de envio por e-mail do extrato financeiro do cliente](https://desenvolvedor.cvcrm.com.br/reference/extratofinanceiro.md): > 🔒 **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)
- [Solicitação de envio por e-mail o imposto de renda](https://desenvolvedor.cvcrm.com.br/reference/impostoderenda.md): > 🔒 **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)
- [Realiza o cadastro de um novo lead](https://desenvolvedor.cvcrm.com.br/reference/cadastrarassistencia-3.md): > 🔒 **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)
- [Altera o empreendimento vinculado ao lead](https://desenvolvedor.cvcrm.com.br/reference/alterarempreendimentolead-1.md): > 🔒 **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)
- [Retorna os agendamentos ativos que o gestor está associado](https://desenvolvedor.cvcrm.com.br/reference/agendamentos-4.md): > 🔒 **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)
- [Cadastrar um agendamento](https://desenvolvedor.cvcrm.com.br/reference/cadastraragendamento-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token)
- [Retorna os agendamentos ativos que uma pessoa está associada](https://desenvolvedor.cvcrm.com.br/reference/agendamentospessoa.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token)
- [Retorna os horários disponíveis para agendamento em uma determinada unidade](https://desenvolvedor.cvcrm.com.br/reference/agendamentohorarios-1.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token)
- [Cancelar um determinado agendamento, seja visita ou vistoria](https://desenvolvedor.cvcrm.com.br/reference/cancelaragendamento-1.md): > 🔒 **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)
- [Retorna os ids de todos os agendamentos ativos da base do cliente](https://desenvolvedor.cvcrm.com.br/reference/agendamentostodos.md): > 🔒 **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)
- [Retorna as datas disponíveis para agendamento de determinado empreendimento](https://desenvolvedor.cvcrm.com.br/reference/dadosdataagendamento-1.md): > 🔒 **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)
- [Retorna as unidades disponiveis para agendamentos](https://desenvolvedor.cvcrm.com.br/reference/unidadesdisponiveisagendamento.md): > 🔒 **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)
- [Retorna os horários disponíveis para agendamento em uma ou de todas as unidade da pessoa](https://desenvolvedor.cvcrm.com.br/reference/dadosagendamentohorarios.md): > 🔒 **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)
- [Retorna as comissões](https://desenvolvedor.cvcrm.com.br/reference/comissoes.md): > 🔒 **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 comissões a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os pagamentos das comissões](https://desenvolvedor.cvcrm.com.br/reference/comissoespagamentos.md): > 🔒 **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 dos pagamentos das comissões a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna o tempo da comissão em cada situação do workflow](https://desenvolvedor.cvcrm.com.br/reference/comissoesworkflowtempo.md): > 🔒 **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 o tempo das comissões em cada situação do workflow a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os distratos](https://desenvolvedor.cvcrm.com.br/reference/distratos-1.md): > 🔒 **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 dos distratos a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna as reservas](https://desenvolvedor.cvcrm.com.br/reference/reservas-4.md): > 🔒 **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.
- [Retorna os dados de comissão na reserva](https://desenvolvedor.cvcrm.com.br/reference/reservascomissoes.md): > 🔒 **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 comissões na reserva a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados da programação da comissão na reserva](https://desenvolvedor.cvcrm.com.br/reference/reservascomissoesprogramacao.md): > 🔒 **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 da programação da comissão na reserva a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados dos coordenadores da reserva](https://desenvolvedor.cvcrm.com.br/reference/reservascoordenador.md): > 🔒 **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 dos coordenadores do produto da reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados históricos das situações das reservas](https://desenvolvedor.cvcrm.com.br/reference/reservashistoricosituacoes.md): > 🔒 **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 dos históricos das situações das reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados do histórico da reserva](https://desenvolvedor.cvcrm.com.br/reference/reservashistorico.md): > 🔒 **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 dos históricos das reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados das condições da reserva](https://desenvolvedor.cvcrm.com.br/reference/reservascondicoes.md): > 🔒 **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 condições da reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados dos associados da reserva](https://desenvolvedor.cvcrm.com.br/reference/reservasassociados.md): > 🔒 **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 dos associados das reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados dos contratos da reserva](https://desenvolvedor.cvcrm.com.br/reference/reservascontratos.md): > 🔒 **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 dos contratos das reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados do workflow de reservas](https://desenvolvedor.cvcrm.com.br/reference/reservasworkflowtempo.md): > 🔒 **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 workflow de reservas tempo a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados dos campos adicionais de reservas](https://desenvolvedor.cvcrm.com.br/reference/reservascamposadicionais.md): > 🔒 **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 campos adicionais preenchidos das reservas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema. Lembrando que está ordenado em ordem decrescente da data de cadastro.
- [Retorna os dados das reservas do Sienge](https://desenvolvedor.cvcrm.com.br/reference/reservassienge.md): > 🔒 **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 do Sienge a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna as situações em que a reserva passou](https://desenvolvedor.cvcrm.com.br/reference/reservasregistrosflag.md): > 🔒 **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 registros das situações em que a reserva passou a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados das simulações](https://desenvolvedor.cvcrm.com.br/reference/simulacoes-1.md): > 🔒 **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 simulações a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados das vendas](https://desenvolvedor.cvcrm.com.br/reference/vendas-1.md): > 🔒 **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 vendidas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna situacao das unidades](https://desenvolvedor.cvcrm.com.br/reference/unidadessituacao-1.md): > 🔒 **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 a situação das unidades a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Valores das unidades das tabelas dinâmicas (Valor unidades)](https://desenvolvedor.cvcrm.com.br/reference/unidadesprecos.md): > 🔒 **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 valores das unidades das tabelas dinâmicas (Valor unidades) a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados das unidades](https://desenvolvedor.cvcrm.com.br/reference/unidades-5.md): > 🔒 **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 unidades
- [Retorna os dados das vistorias](https://desenvolvedor.cvcrm.com.br/reference/agendamentosvistorias-1.md): > 🔒 **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 vistorias a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados das assistências](https://desenvolvedor.cvcrm.com.br/reference/assistencias-1.md): > 🔒 **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 assistências a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna o tempo que a assistência passou em cada situação.](https://desenvolvedor.cvcrm.com.br/reference/assistenciasworkflowtempo-1.md): > 🔒 **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 o tempo que a assistência passou em cada situação.
- [Retorna os dados dos itens das assistências](https://desenvolvedor.cvcrm.com.br/reference/assistenciasitens-1.md): > 🔒 **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 dos itens das assistências a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna o tempo que o item da assistência passou em cada situação.](https://desenvolvedor.cvcrm.com.br/reference/assistenciasitensworkflowtempo-1.md): > 🔒 **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 o tempo que o item da assistência passou em cada situação.
- [Retorna o tempo que a visita da assistência passou em cada situação.](https://desenvolvedor.cvcrm.com.br/reference/assistenciasvisitasworkflowtempo-1.md): > 🔒 **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 o tempo que a visita da assistência passou em cada situação.
- [Retorna os integrantes dos times de atendimentos](https://desenvolvedor.cvcrm.com.br/reference/atendimentostimesintegrantes-1.md): > 🔒 **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 integrantes dos times de atendimentos.
- [Retorna os times de atendimentos](https://desenvolvedor.cvcrm.com.br/reference/atendimentostimes-1.md): > 🔒 **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 times de atendimentos.
- [Retorna as tarefas dos atendimentos](https://desenvolvedor.cvcrm.com.br/reference/atendimentostarefas-1.md): > 🔒 **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 as tarefas dos atendimentos.
- [Retorna as respostas dos atendimentos](https://desenvolvedor.cvcrm.com.br/reference/atendimentosrespostas-1.md): > 🔒 **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 as respostas dos atendimentos.
- [Retorna as interações dos atendimentos](https://desenvolvedor.cvcrm.com.br/reference/atendimentosinteracoes-1.md): > 🔒 **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 as interações dos atendimentos.
- [Retorna o tempo que o atendimento passou em cada situação.](https://desenvolvedor.cvcrm.com.br/reference/atendimentosworkflowtempo-1.md): > 🔒 **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 o tempo que o atendimento passou em cada situação.
- [Retorna os dados dos atendimentos](https://desenvolvedor.cvcrm.com.br/reference/atendimentos-16.md): > 🔒 **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 dos atendimentos a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados do corretor do lead](https://desenvolvedor.cvcrm.com.br/reference/leadscorretores-1.md): > 🔒 **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 dos corretores que atenderam o lead.
- [Retorna os dados dos leads](https://desenvolvedor.cvcrm.com.br/reference/leads-20.md): > 🔒 **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 dos leads a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados das conversões dos leads](https://desenvolvedor.cvcrm.com.br/reference/leadsconversoes-1.md): > 🔒 **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 conversões dos leads. A data de referência é equivalente a data de cadastro da conversão
- [Retorna os dados dos leads ganhos](https://desenvolvedor.cvcrm.com.br/reference/leadsganhos-1.md): > 🔒 **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 dos leads ganhos.
- [Retorna o histórico das situações dos leads](https://desenvolvedor.cvcrm.com.br/reference/leadshistoricosituacoes-1.md): > 🔒 **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 o histórico das situações dos leads.
- [Retorna alguns dados dos leads](https://desenvolvedor.cvcrm.com.br/reference/leadsinfos-1.md): > 🔒 **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 alguns dados dos leads.
- [Retorna a listagem de interações dos leads.](https://desenvolvedor.cvcrm.com.br/reference/leadsinteracoes-1.md): > 🔒 **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 a listagem de interações dos leads.
- [Retorna os dados dos momentos dos leads](https://desenvolvedor.cvcrm.com.br/reference/leadsmomentos-1.md): > 🔒 **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 dos momentos dos leads a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna as informações de perda do leads](https://desenvolvedor.cvcrm.com.br/reference/leadsperdas-1.md): > 🔒 **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 as informações de perda do leads.
- [Retorna as tarefas dos leads](https://desenvolvedor.cvcrm.com.br/reference/leadstarefas-1.md): > 🔒 **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 a listagem as tarefas dos leads.
- [Retorna a listagem de interações de visitas de leads.](https://desenvolvedor.cvcrm.com.br/reference/leadsvisitas-1.md): > 🔒 **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 a listagem de interações de visitas de leads.
- [Retorna o tempo em que o lead passou em determinada situação.](https://desenvolvedor.cvcrm.com.br/reference/leadsworkflowtempo-1.md): > 🔒 **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 o tempo em que o lead passou em determinada situação.
- [Retorna as alterações na possibilidade de vendas dos leads.](https://desenvolvedor.cvcrm.com.br/reference/leadspossibilidade-1.md): > 🔒 **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 as alterações na possibilidade de vendas dos leads.
- [Retorna a distribuição dos leads](https://desenvolvedor.cvcrm.com.br/reference/distribuicaoleads-1.md): > 🔒 **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 a listagem de distribuição de leads.
- [Retorna os dados dos usuários administrativos](https://desenvolvedor.cvcrm.com.br/reference/getusuariosadministrativos-1.md): > 🔒 **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 dos usuários administativos a partir dos filtros solicitados
- [Retorna os dados dos processos](https://desenvolvedor.cvcrm.com.br/reference/processos-2.md): > 🔒 **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 dos processos a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados dos pré-cadastros](https://desenvolvedor.cvcrm.com.br/reference/precadastros-1.md): > 🔒 **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 os dados dos pré-cadastros a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna o tempo do pré-cadastro em cada situação](https://desenvolvedor.cvcrm.com.br/reference/precadastroworkflowtempo-1.md): > 🔒 **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 o tempo que o pré-cadastro ficou em uma determinada situação.
- [Retorna o histórico de situações do pré-cadastro](https://desenvolvedor.cvcrm.com.br/reference/precadastrohistoricosituacoes-1.md): > 🔒 **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 o histórico de situações do pré-cadastro.
- [Retorna os dados das imobiliarias](https://desenvolvedor.cvcrm.com.br/reference/imobiliarias-2.md): > 🔒 **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 imobiliarias a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados dos corretores](https://desenvolvedor.cvcrm.com.br/reference/corretores-2.md): > 🔒 **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 dos Corretores a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna as pesquisas ativas](https://desenvolvedor.cvcrm.com.br/reference/getpesquisas-1.md): > 🔒 **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) Lista as pesquisas ativas
- [Retorna as perguntas das pesquisas](https://desenvolvedor.cvcrm.com.br/reference/getpesquisasperguntas-1.md): > 🔒 **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) Lista as perguntas das pesquisas
- [Retorna as respostas das pesquisas](https://desenvolvedor.cvcrm.com.br/reference/getpesquisasrespostas-1.md): > 🔒 **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) Lista as respostas das pesquisas
- [Retorna os dados dos repasses](https://desenvolvedor.cvcrm.com.br/reference/repasses-2.md): > 🔒 **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 dos repasses a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna o tempo que o repasse ficou em uma determinada situação.](https://desenvolvedor.cvcrm.com.br/reference/repassesworkflowtempo-1.md): > 🔒 **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 o tempo que o repasse ficou em uma determinada situação.
- [Retorna o histórico das situações do repasse](https://desenvolvedor.cvcrm.com.br/reference/repasseshistoricosituacoes-1.md): > 🔒 **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 o historico das situações do repasse.
- [Retorna as campanhas de ativação](https://desenvolvedor.cvcrm.com.br/reference/campanhasativacao-1.md): > 🔒 **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 de campanhas de ativação ativas.
- [Retorna os campos adicionais](https://desenvolvedor.cvcrm.com.br/reference/camposadicionais-1.md): > 🔒 **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 valores dos Campos Adicionais a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados das pessoas](https://desenvolvedor.cvcrm.com.br/reference/pessoas-2.md): > 🔒 **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 valores das pessoas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
- [Retorna os dados de contatos das pessoas](https://desenvolvedor.cvcrm.com.br/reference/pessoascontatos-1.md): > 🔒 **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 valores dos dados de contatos das pessoas a partir dos filtros solicitados.
- [Retorna os dados profissionais e outras rendas das pessoas](https://desenvolvedor.cvcrm.com.br/reference/pessoasprofissional-1.md): > 🔒 **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 valores dos dados profissionais e outras rendas das pessoas a partir dos filtros solicitados.
- [Retorna os dados patrimoniais das pessoas](https://desenvolvedor.cvcrm.com.br/reference/pessoaspatrimoniais-1.md): > 🔒 **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 valores dos dados patrimoniais das pessoas a partir dos filtros solicitados.
- [Retorna os dados bancários das pessoas](https://desenvolvedor.cvcrm.com.br/reference/pessoasbancarios-1.md): > 🔒 **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 valores dos dados bancários das pessoas a partir dos filtros solicitados.
- [Retorna os bens da empresa das pessoas](https://desenvolvedor.cvcrm.com.br/reference/pessoasbensempresa-1.md): > 🔒 **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 valores dos bens da empresa das pessoas (PJ) a partir dos filtros solicitados.
- [Retorna os dados financeiros das pessoas](https://desenvolvedor.cvcrm.com.br/reference/getpessoas-1.md): > 🔒 **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 valores dos dados financeiros das pessoas (PJ) a partir dos filtros solicitados.
- [Retorna as tags associadas a pessoa](https://desenvolvedor.cvcrm.com.br/reference/getpessoastagsassociadas-1.md): > 🔒 **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 valores das tags associadas a pessoa a partir dos filtros solicitados.
- [Retorna os usuários correspondentes](https://desenvolvedor.cvcrm.com.br/reference/getcorrespondentesusuarios-1.md): > 🔒 **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) Lista os usuários correspondentes
- [Retorna as empresas correspondentes](https://desenvolvedor.cvcrm.com.br/reference/getcorrespondentesempresas-1.md): > 🔒 **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) Lista de empresas correspondentes
- [Gera um token de acesso para o usuário](https://desenvolvedor.cvcrm.com.br/reference/autenticarusuario.md): Gera um token de acesso válido por 6 horas, que deve ser utilizado como autenticação do tipo Bearer nas consultas.
- [Listar Permissões de Acesso, é necessário enviar o header Authorization com o Bearer token V3.](https://desenvolvedor.cvcrm.com.br/reference/listarpermissoesacesso.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token)
- [Listar campos adicionais](https://desenvolvedor.cvcrm.com.br/reference/listarcamposadicionaisv4.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna listagem paginada de campos adicionais cadastrados.
- [Lista os tipos de reserva cadastrados](https://desenvolvedor.cvcrm.com.br/reference/listartiposreservav3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna listagem paginada de tipos de reserva cadastrados.
- [Retorna um tipo de reserva pelo identificador](https://desenvolvedor.cvcrm.com.br/reference/retornartiporeservaporidv3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) > ⚠️ **Descontinuação**: esta versão será substituída por `/v4/configuracoes/tipos-reserva/{idTipo}`. Utilize a v4 em novas integrações. Retorna um tipo de reserva pelo identificador.
- [Alterar titularidade da reserva](https://desenvolvedor.cvcrm.com.br/reference/alterartitularidadereservav3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Promove um associado ativo da reserva a titular, trocando de posição com o titular atual. O `idassociado` informado deve ser um associado **ativo** da própria reserva, obtido previamente em `GET /v3/comercial/reservas/{idReserva}/associados`. A API não aceita promover uma pessoa nova ou externa à reserva — apenas associados já existentes. A troca é cruzada: o titular atual passa a ocupar a posição de associado que era do associado promovido, preservando o vínculo de cônjuge quando existente. A operação é bloqueada se a pessoa do novo titular estiver com bloqueio de reserva ativo e não houver exceção para o corretor da reserva.
- [Listar associados de uma reserva](https://desenvolvedor.cvcrm.com.br/reference/listarassociadosreservav3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna listagem paginada dos associados vinculados a uma reserva (compradores, cônjuges, avalistas, etc.).
- [Exibir associado por ID](https://desenvolvedor.cvcrm.com.br/reference/exibirassociadoreservav3.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna os dados de um associado específico da reserva.
- [Listar tipos de associações (v4)](https://desenvolvedor.cvcrm.com.br/reference/listarcadastrostiposassociacoes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna a lista paginada de tipos de associações cadastrados. Autenticação via JWT.
- [Criar tipo de associação (v4)](https://desenvolvedor.cvcrm.com.br/reference/cadastrarcadastrostiposassociacoes.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Cria um novo tipo de associação. Autenticação via JWT.
- [Exibir tipo de associação por ID (v4)](https://desenvolvedor.cvcrm.com.br/reference/obtercadastrostiposassociacoesportipo.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna um tipo de associação pelo ID. Autenticação via JWT.
- [Atualizar tipo de associação (v4)](https://desenvolvedor.cvcrm.com.br/reference/atualizarcadastrostiposassociacoesportipo.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Atualiza um tipo de associação existente. Autenticação via JWT.
- [Remover tipo de associação (v4)](https://desenvolvedor.cvcrm.com.br/reference/removercadastrostiposassociacoesportipo.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Remove (soft delete) um tipo de associação. Autenticação via JWT.
- [Retorna os assuntos do atendimento](https://desenvolvedor.cvcrm.com.br/reference/listarcvbotassuntos.md): > 🔒 **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)
- [Retorna os Subassuntos do assunto](https://desenvolvedor.cvcrm.com.br/reference/listarcvbotassuntossubassuntos.md): > 🔒 **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)
- [Lista os atendimentos](https://desenvolvedor.cvcrm.com.br/reference/listarcvbotatendimentos.md): > 🔒 **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)
- [Retorna os dados dos empreendimentos ativos no sistema](https://desenvolvedor.cvcrm.com.br/reference/listarcvbotempreendimentos.md): > 🔒 **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)
- [Retorna as unidades disponíveis do empreendimento](https://desenvolvedor.cvcrm.com.br/reference/listarcvbotempreendimentosunidades.md): > 🔒 **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)
- [Retorna os dados da pessoa](https://desenvolvedor.cvcrm.com.br/reference/listarcvbotpessoa.md): > 🔒 **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)
- [Retorna os dados da unidade](https://desenvolvedor.cvcrm.com.br/reference/obtercvbotunidadesporunidade.md): > 🔒 **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)
- [Retornar Webhooks](https://desenvolvedor.cvcrm.com.br/reference/listarwebhooks.md): > 🔒 **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 é responsável por retornar todos os webhooks cadastradas no CV.
- [Retornar Gatilhos](https://desenvolvedor.cvcrm.com.br/reference/listarwebhooksgatilhos.md): > 🔒 **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 é responsável por retornar todos os gatilhos cadastrados no CV.
- [Retorna o listagem de leads por indicadores](https://desenvolvedor.cvcrm.com.br/reference/listarcomercialleads.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Esta API é responsável por retornar a listagem de leads por indicadores dos leads cadastrados no CV, é necessário informar o indicador por parâmetro.
- [Lista as visitas de um lead](https://desenvolvedor.cvcrm.com.br/reference/listarleadvisitas.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) **Changelog vs v1:** agendar e atualizar visitas hoje acontecem dentro do endpoint "God Endpoint" `POST /v1/comercial/leads` (chave `visita` do payload, ver seção acima) e do endpoint legado `/api/cvio/lead_tarefas` — nenhum dos dois oferece rota própria para listar ou para atualizar uma visita específica. Este sub-recurso isola visitas com listagem paginada (filtros e ordenação) e atualização por `idVisita`. Visita de lead não é uma entidade própria no banco: é um registro de tarefa (`tarefas`) com `tipoInteracao = V` — por isso as mesmas visitas também aparecem em `/v3/comercial/leads/{idLead}/tarefas`. Lista as visitas (estande, virtual, PDV) de um lead, paginado. Corretor/imobiliária/PDV veem apenas as visitas em que são o responsável (`tipoResponsavel`/`idResponsavel`); gestor vê todas as visitas do lead. Aceita `page`/`limit` e também `pagina`/`limitePagina` (os dois pares produzem o mesmo resultado); `limit` tem padrão 20 e máximo 100.
- [Agenda uma visita para o lead](https://desenvolvedor.cvcrm.com.br/reference/agendarleadvisita.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Agenda uma visita (estande, virtual, PDV) para o lead. `idResponsavel` é validado contra o lead e o painel autenticado, conforme `tipoResponsavel`: `I` exige usuário ativo da imobiliária do lead, `C` exige o próprio corretor do lead, `P` exige usuário ativo do PDV do lead, `G` exige usuário gestor ativo com vínculo aos empreendimentos/imobiliária do lead — responsável inválido retorna 422. `idPdv`, `idTipoVisita` e `idEmpreendimentoVisita` são opcionais; quando informados, precisam existir (e, no caso de `idEmpreendimentoVisita`, estar associado ao lead) — senão 422. `situacao = C` exige `motivoConcluido`; `situacao = CA` exige `motivoCancelamento` — senão 422. Com a automatização de leads ativa, agendar a visita em situação `P`/`A` altera a situação do lead para "Visita Agendada"; `C` altera para "Visita Concluída"; `CA` altera para "Visita Cancelada" — só quando a situação atual do lead for diferente da situação-alvo.
- [Atualiza a situação e/ou a descrição de uma visita do lead](https://desenvolvedor.cvcrm.com.br/reference/atualizarleadvisita.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Atualiza a situação e/ou a descrição de uma visita do lead. Ao menos um dos dois campos precisa ser enviado. `situacao = C` exige `motivoConcluido`; `situacao = CA` exige `motivoCancelamento` — senão 422. A mudança de situação segue a mesma automatização de situação do lead descrita no agendamento. Corretor/imobiliária/PDV só atualizam visitas em que são o responsável.
- [Atualiza o status de uma mensagem enviada por serviço externo](https://desenvolvedor.cvcrm.com.br/reference/postreceberstatusmensagem.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, com o token do canal. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Informa ao CV o que aconteceu com uma mensagem que o comunicador entregou ao integrador. A mensagem é localizada por `mensagem.idmensagem`, o mesmo identificador enviado no webhook.
- [Registra a reação do cliente a uma mensagem](https://desenvolvedor.cvcrm.com.br/reference/postreceberreacaomensagem.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, com o token do canal. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Envia o emoji com que o cliente reagiu a uma mensagem já registrada no chat.
- [Informa a presença do cliente no chat (digitando, gravando)](https://desenvolvedor.cvcrm.com.br/reference/postreceberpresencachat.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, com o token do canal. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) ⚠️ **Não implementado para canal de terceiros.** A conversão de presença do canal de terceiros não devolve eventos, então a chamada é aceita e nada é registrado no chat. O endpoint existe para os serviços que suportam o recurso.
- [Encerra uma conversa do canal de terceiros](https://desenvolvedor.cvcrm.com.br/reference/postencerrarchatservicoexterno.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization, com o token do canal. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Encerra o chat identificado por `identificador`. O encerramento vindo da integração é registrado como do painel `sistema`.
- [Busca pessoas para vincular a uma conversa](https://desenvolvedor.cvcrm.com.br/reference/buscarpessoasparavinculo.md): Lista pessoas candidatas a receber o contato de uma conversa ainda sem cliente identificado, para o operador escolher qual delas é o interlocutor. Termos com menos de 3 caracteres não consultam a base e retornam lista vazia. O retorno é limitado a 10 pessoas, ordenadas por nome.
- [Vincula uma pessoa a uma conversa](https://desenvolvedor.cvcrm.com.br/reference/vincularpessoaaochat.md)
- [Detalhar disparo de pesquisa](https://desenvolvedor.cvcrm.com.br/reference/detalhardisparopesquisa.md): > 🔒 **Autenticação necessária** > > Esta API utiliza **Bearer Token** no header Authorization. > Consulte o tutorial completo antes de fazer sua primeira chamada: > [Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-nas-apis-do-cv-crm-com-bearer-token) Retorna o detalhe de um disparo de pesquisa.
## Pages
- [Casos de uso](https://desenvolvedor.cvcrm.com.br/page/casos-de-uso.md)
## Changelog
- [26.06 - Campo CIB nas APIs de unidades](https://desenvolvedor.cvcrm.com.br/changelog/2606-campo-cib-nas-apis-de-unidades.md)
- [26.06 - [PUT] Assistência Técnica](https://desenvolvedor.cvcrm.com.br/changelog/2606-put-assistência-técnica.md)
- [26.05 - [GET] Jornada do cliente](https://desenvolvedor.cvcrm.com.br/changelog/2605-get-jornada-do-cliente.md)
- [Changelog Janeiro 2026](https://desenvolvedor.cvcrm.com.br/changelog/changelog-janeiro-2026.md)
- [Nov/25 - Reservas (GET)](https://desenvolvedor.cvcrm.com.br/changelog/nov25-reservas-get.md)
- [Nov/25 - Webhook - Tabela de Preços](https://desenvolvedor.cvcrm.com.br/changelog/nov25-webhook-tabela-de-preços.md)
- [Nov/25 - Webhook - Cliente](https://desenvolvedor.cvcrm.com.br/changelog/nov25-webhook-cliente.md)
- [Nov/25 - CVDW - Leads/Corretores](https://desenvolvedor.cvcrm.com.br/changelog/nov25-cvdw-leadscorretores.md)
- [Nov/25 - CVDW - Corretores](https://desenvolvedor.cvcrm.com.br/changelog/nov25-cvdw-corretores.md)
- [Nov/25 - CVDW - Leads](https://desenvolvedor.cvcrm.com.br/changelog/nov25-cvdw-leads.md)