Skip to main content
CV CRM is a customer relationship management system designed specifically for Brazilian businesses. It provides tools for managing customer data, sales pipelines, and business relationships, helping companies organize and optimize their customer interactions and sales processes.

​
Configuring CV CRM as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the CV CRM option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

You’ll need to authorize Nekt to access your CV CRM data. The following configurations are available:
  • Email: the email address used to authenticate against the API service. This should be a valid email address with enough permissions to access the CV CRM data you want to extract. The email should be in the format user@example.com.
  • API token: the authentication token required to access the API service. Please check this documentation to find more information about how to generate the token.
  • Company subdomain: the subdomain identifier for your company account. For example, if your CRM URL is https://mycompany.cvcrm.com.br, then your company subdomain would be mycompany.
  • Start date: the date from which you want to begin synchronizing data. This defines the earliest point in time for historical extraction. Any data created or modified before this date will not be included in the synchronization.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
    • Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
    • Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:
  • Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
  • Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

​
Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description.

​
Fields by stream

Below you’ll find all available data streams from CV CRM and their corresponding key fields:
Stream name: leads.Endpoint:
  • /cvdw/leads
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: additional_fields.Endpoint:
  • /cvdw/campos_adicionais
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: sales.Endpoint:
  • /cvdw/vendas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: reservas.Endpoint:
  • /cvdw/reservas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: reservas_flags.Endpoint:
  • /cvdw/reservas/registros/flags
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: pre_cadastros.Endpoint:
  • /cvdw/precadastros
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: leads_visitas.Endpoint:
  • /cvdw/leads/visitas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: corretores.Endpoint:
  • /cvdw/corretores
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: imobiliarias.Endpoint:
  • /cvdw/imobiliarias
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: pessoas.Endpoint:
  • /cvdw/pessoas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: empreendimentos.Endpoint:
  • /cadastros/empreendimentos
Sync Strategy:
  • Full table (no replication key configured)
  • Primary key(s): idempreendimento
Key Fields:
Stream name: campanhas_ativacao.Endpoint:
  • /cvdw/campanhas_ativacao
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: unidades.Endpoint:
  • /cvdw/unidades
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: distratos.Endpoint:
  • /cvdw/distratos
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: leads_interacoes.Endpoint:
  • /cvdw/leads/interacoes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: leads_tarefas.Endpoint:
  • /cvdw/leads/tarefas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: leads_historico_situacoes.Endpoint:
  • /cvdw/leads/historico/situacoes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: comissoes.Endpoint:
  • /cvdw/comissoes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: comissoes_detalhes.Endpoint:
  • /financeiro/comissoes
Sync Strategy:
  • Full table (no replication key configured)
  • Primary key(s): idcomissao_cv
Unlike the standard comissoes stream, this endpoint exposes the payer, the beneficiaries with their payment schedule, payment batches, payment document metadata, and payment records.Key Fields:
Stream name: atendimentos.Endpoint:
  • /cvdw/atendimentos
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: assistencias.Endpoint:
  • /cvdw/assistencias
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: leads_conversoes.Endpoint:
  • /cvdw/leads/conversoes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: repasses.Endpoint:
  • /cvdw/repasses
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: leads_workflow_tempo.Endpoint:
  • /cvdw/leads/workflow/tempo
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: reservas_condicoes.Endpoint:
  • /cvdw/reservas/condicoes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: reservas_contratos.Endpoint:
  • /cvdw/reservas/contratos
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: reservas_sienge.Endpoint:
  • /cvdw/reservas/sienge
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: leads_corretores.Endpoint:
  • /cvdw/leads/corretores
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): idlead, idcorretor, data_cad
Key Fields:
Stream name: unidades_situacao.Endpoint:
  • /cvdw/unidades/situacao
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: pre_cadastros_historico_situacoes.Endpoint:
  • /cvdw/precadastro/historico/situacoes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: distribuicao_leads.Endpoint:
  • /cvdw/distribuicao/leads
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: empreendimentos_cvbot.Endpoint:
  • /cvbot/empreendimentos
Sync Strategy:
  • Full table (no replication key configured)
  • Primary key(s): idempreendimento
Key Fields:
Stream name: empreendimentos_unidades_cvbot.Endpoint:
  • /cvbot/empreendimentos/{idempreendimento}/unidades
Sync Strategy:
  • Full table (no replication key configured)
  • Primary key(s): idunidade
Key Fields:
Stream name: pessoas_profissional.Endpoint:
  • /cvdw/pessoas/profissional
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: tipologias_unidades.Endpoint:
  • /configuracoes/tipologias-unidades
Sync Strategy:
  • Full table (no replication key configured)
  • Primary key(s): idtipologia
Key Fields:
Stream name: reservas_associados.Endpoint:
  • /cvdw/reservas/associados
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: usuarios_administrativos.Endpoint:
  • /cvdw/usuarios_administrativos
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: pesquisas.Endpoint:
  • /cvdw/pesquisas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: pesquisas_perguntas.Endpoint:
  • /cvdw/pesquisas/perguntas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: pesquisas_respostas.Endpoint:
  • /cvdw/pesquisas/respostas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: assistencias_itens.Endpoint:
  • /cvdw/assistencias/itens
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: assistencias_workflow_tempo.Endpoint:
  • /cvdw/assistencias/workflow/tempo
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: assistencias_itens_workflow_tempo.Endpoint:
  • /cvdw/assistencias/itens/workflow/tempo
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: assistencias_visitas_workflow_tempo.Endpoint:
  • /cvdw/assistencias/visitas/workflow/tempo
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: atendimentos_respostas.Endpoint:
  • /cvdw/atendimentos/respostas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: atendimentos_workflow_tempo.Endpoint:
  • /cvdw/atendimentos/workflow/tempo
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: atendimentos_interacoes.Endpoint:
  • /cvdw/atendimentos/interacoes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: unidades_precos.Endpoint:
  • /cvdw/unidades/precos
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: atendimentos_times.Endpoint:
  • /cvdw/atendimentos/times
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: atendimentos_times_integrantes.Endpoint:
  • /cvdw/atendimentos/times/integrantes
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: atendimentos_tarefas.Endpoint:
  • /cvdw/atendimentos/tarefas
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:
Stream name: reservas_workflow_tempo.Endpoint:
  • /cvdw/reservas/workflow/tempo
Sync Strategy:
  • Incremental replication key: referencia_data
  • Primary key(s): referencia
Key Fields:

​
Implementation Notes

​
Empty Response Handling

The CV CRM connector safely handles 204 No Content and empty body responses from the API, particularly on paginated endpoints. This prevents data pipeline failures when specific data streams or pages return no data during the synchronization window.

​
Commission Details Sync Behavior

The comissoes_detalhes stream always runs as a full refresh (FULL_TABLE). Commissions are frequently updated in place (status changes, new payment records), and the API’s a_partir_de date filter only covers the initial registration date, so a full sync ensures that all subsequent state changes to existing commissions are accurately captured.

​
Financeiro Pagination

The /financeiro/comissoes endpoint returns pagination metadata (total, limit, offset, totalConteudo) as string values. The connector coerces these values to integers and advances the offset by the number of records the API actually returned, so pagination stays correct even if the server caps the requested page size.

​
Skills for agents

Download CV CRM skills file

CV CRM connector documentation as plain markdown, for use in AI agent contexts.