NectarCRM is a Brazilian CRM platform designed for B2B sales teams. It provides tools for managing contacts, opportunities, qualifications, tasks, appointments, and sales pipelines, helping teams track their sales processes from prospecting to closing.Documentation Index
Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
Use this file to discover all available pages before exploring further.
Configuring NectarCRM as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the NectarCRM 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 provide your NectarCRM API access token. To find it, go to Settings > Integrations > Public Token in your NectarCRM account. The following configurations are available:- API Key: Your NectarCRM API access token (required).
- Start Date: The earliest date from which records will be synced for incremental streams.
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. 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, and the type of sync.- Layer: choose between the existing layers on your catalog.
- Folder: a folder can be created inside the selected layer to group all tables.
- Table name: a name is suggested, but feel free to customize it. You can add a prefix to all tables at once.
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: only new or updated data is fetched each run.
- Full table: the current state of the data is fetched each run.
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. 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.Streams and Fields
Below you’ll find all available data streams from NectarCRM and their corresponding fields:Contacts
Contacts
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| razaoSocial | string |
| ativo | boolean |
| constante | integer |
| cnpj | string |
| cpf | string |
| categoria | string |
| origem | string |
| segmento | string |
| responsavel_id | integer |
| responsavel_nome | string |
| responsavel_login | string |
| emails | array of strings |
| telefones | array of strings |
| endereco | array of objects |
| camposPersonalizados | string (JSON) |
| dataCriacao | datetime |
| dataAtualizacao | datetime |
Opportunities
Opportunities
| Field | Type |
|---|---|
| id | integer |
| codigo | string |
| nome | string |
| dataLimite | datetime |
| dataConclusao | datetime |
| etapa | integer |
| status | integer |
| pipeline | string |
| funil_venda_id | integer |
| funil_venda_nome | string |
| probabilidade | integer |
| temperatura | string |
| valorAvulso | number |
| valorMensal | number |
| valorTotal | number |
| valorTotalDescontos | number |
| cliente_id | integer |
| cliente_nome | string |
| responsavel_id | integer |
| responsavel_nome | string |
| responsavel_login | string |
| produtos | array of objects |
| camposPersonalizados | string (JSON) |
| dataCriacao | datetime |
| dataAtualizacao | datetime |
Qualifications
Qualifications
| Field | Type |
|---|---|
| id | integer |
| codigo | string |
| nome | string |
| cliente_id | integer |
| cliente_nome | string |
| status | integer |
| dataLimite | datetime |
| etapa | integer |
| pipeline | string |
| funil_venda_id | integer |
| funil_venda_nome | string |
| responsavel_id | integer |
| responsavel_nome | string |
| responsavel_login | string |
| tarefas | integer |
| compromissos | integer |
| camposPersonalizados | string (JSON) |
| dataCriacao | datetime |
| dataAtualizacao | datetime |
Appointments
Appointments
| Field | Type |
|---|---|
| id | integer |
| assunto | string |
| titulo | string |
| descricao | string |
| dataInicio | datetime |
| dataFim | datetime |
| diaInteiro | boolean |
| endereco | string |
| status | integer |
| cliente_id | integer |
| cliente_nome | string |
| responsavel_id | integer |
| responsavel_nome | string |
| responsavel_login | string |
| tipo_id | integer |
| tipo_nome | string |
| participantes | array of objects |
| dataCriacao | datetime |
| dataAtualizacao | datetime |
Tasks
Tasks
| Field | Type |
|---|---|
| id | integer |
| titulo | string |
| descricao | string |
| dataLimite | datetime |
| status | integer |
| tipo | integer |
| prioridade | integer |
| cliente_id | integer |
| cliente_nome | string |
| responsavel_id | integer |
| responsavel_nome | string |
| responsavel_login | string |
| checklist_id | integer |
| checklist_nome | string |
| dataCriacao | datetime |
| dataAtualizacao | datetime |
Feedbacks
Feedbacks
| Field | Type |
|---|---|
| id | integer |
| assunto | string |
| descricao | string |
| importante | boolean |
| automatica | boolean |
| qtdeComentarios | integer |
| autor_id | integer |
| autor_nome | string |
| autor_login | string |
| contato_id | integer |
| contato_nome | string |
| oportunidade_id | integer |
| oportunidade_nome | string |
| tarefa_id | integer |
| tarefa_titulo | string |
| anexos | array of objects |
| dataCriacao | datetime |
| dataAtualizacao | datetime |
Products
Products
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| descricao | string |
| codigo | string |
| valor | number |
| recorrencia | integer |
| ativo | boolean |
| categoria_id | integer |
| categoria_nome | string |
| subcategoria_id | integer |
| subcategoria_nome | string |
Product Categories
Product Categories
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| descricao | string |
| ativo | boolean |
Product Subcategories
Product Subcategories
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| descricao | string |
| ativo | boolean |
| categoria_id | integer |
| categoria_nome | string |
Price Tables
Price Tables
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| descricao | string |
| ativo | boolean |
Proposals
Proposals
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| descricao | string |
| codigo | string |
| status | integer |
| valorTotal | number |
| cliente_id | integer |
| cliente_nome | string |
| oportunidade_id | integer |
| responsavel_id | integer |
| responsavel_nome | string |
| responsavel_login | string |
| dataCriacao | datetime |
| dataAtualizacao | datetime |
Pipelines
Pipelines
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| ativo | boolean |
| etapas | array of objects |
Custom Fields
Custom Fields
| Field | Type |
|---|---|
| id | integer |
| nome | string |
| tipo | string |
| obrigatorio | boolean |
| ativo | boolean |
| secao | string |
| opcoes | array of strings |
Tags
Tags
Sources
Sources
| Field | Type |
|---|---|
| id | integer |
| nome | string |
Segments
Segments
| Field | Type |
|---|---|
| id | integer |
| nome | string |
Categories
Categories
| Field | Type |
|---|---|
| id | integer |
| nome | string |