> ## 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.

# NectarCRM as a data source

> Bring data from NectarCRM to Nekt.

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.

<img width="200" src="https://mintlify.s3.us-west-1.amazonaws.com/nekt/assets/logo/logo-nectarcrm.png" />

## Configuring NectarCRM as a Source

In the [Sources](https://app.nekt.ai/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.

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.

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.

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](https://docs.nekt.com/runs/scheduling-and-triggers), 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](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

<Warning>For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.</Warning>

# Streams and Fields

Below you'll find all available data streams from NectarCRM and their corresponding fields:

<AccordionGroup>
  <Accordion title="Contacts">
    | Field                  | Type             | Description                                |
    | :--------------------- | :--------------- | :----------------------------------------- |
    | `id`                   | Integer          | Unique identifier for the contact          |
    | `nome`                 | String           | Name of the contact                        |
    | `razaoSocial`          | String           | Legal name (Razão Social)                  |
    | `ativo`                | Boolean          | Indicates if the contact is active         |
    | `constante`            | Integer          | Constant identifier                        |
    | `cnpj`                 | String           | CNPJ (Brazilian company registry number)   |
    | `cpf`                  | String           | CPF (Brazilian individual registry number) |
    | `categoria`            | String           | Category of the contact                    |
    | `origem`               | String           | Origin of the contact                      |
    | `segmento`             | String           | Segment of the contact                     |
    | `responsavel_id`       | Integer          | Identifier of the responsible user         |
    | `responsavel_nome`     | String           | Name of the responsible user               |
    | `responsavel_login`    | String           | Login of the responsible user              |
    | `emails`               | Array of strings | List of email addresses                    |
    | `telefones`            | Array of strings | List of phone numbers                      |
    | `endereco`             | Array of objects | Address information                        |
    | `camposPersonalizados` | String (JSON)    | Custom fields in JSON format               |
    | `dataCriacao`          | Datetime         | Creation date                              |
    | `dataAtualizacao`      | Datetime         | Last update date                           |
  </Accordion>

  <Accordion title="Opportunities">
    | Field                  | Type             | Description                           |
    | :--------------------- | :--------------- | :------------------------------------ |
    | `id`                   | Integer          | Unique identifier for the opportunity |
    | `codigo`               | String           | Code of the opportunity               |
    | `nome`                 | String           | Name of the opportunity               |
    | `dataLimite`           | Datetime         | Deadline date                         |
    | `dataProrrogacao`      | Datetime         | Extension date                        |
    | `stageEntryDate`       | Datetime         | Stage entry date                      |
    | `dataConclusao`        | Datetime         | Conclusion date                       |
    | `autor`                | String           | Author of the opportunity             |
    | `autorAtualizacao`     | String           | Author of the last update             |
    | `autorConclusao`       | String           | Author of the conclusion              |
    | `responsavel`          | String           | Responsible user                      |
    | `corresponsaveis`      | String           | Co-responsibles                       |
    | `cliente`              | String           | Client information                    |
    | `etapa`                | Integer          | Current stage of the opportunity      |
    | `status`               | Integer          | Status code                           |
    | `pipeline`             | String           | Pipeline name                         |
    | `funil_venda_id`       | Integer          | Sales funnel identifier               |
    | `funil_venda_nome`     | String           | Sales funnel name                     |
    | `probabilidade`        | Integer          | Probability of winning                |
    | `temperatura`          | String           | Temperature or urgency                |
    | `valorAvulso`          | Number           | One-time value                        |
    | `valorMensal`          | Number           | Monthly value                         |
    | `valorTotal`           | Number           | Total value                           |
    | `valorTotalDescontos`  | Number           | Total discount value                  |
    | `cliente_id`           | Integer          | Identifier of the client              |
    | `cliente_nome`         | String           | Name of the client                    |
    | `responsavel_id`       | Integer          | Identifier of the responsible user    |
    | `responsavel_nome`     | String           | Name of the responsible user          |
    | `responsavel_login`    | String           | Login of the responsible user         |
    | `produtos`             | Array of objects | Products linked to the opportunity    |
    | `camposPersonalizados` | String (JSON)    | Custom fields in JSON format          |
    | `dataCriacao`          | Datetime         | Creation date                         |
    | `dataAtualizacao`      | Datetime         | Last update date                      |
  </Accordion>

  <Accordion title="Qualifications">
    | Field                  | Type          | Description                             |
    | :--------------------- | :------------ | :-------------------------------------- |
    | `id`                   | Integer       | Unique identifier for the qualification |
    | `codigo`               | String        | Code                                    |
    | `nome`                 | String        | Name                                    |
    | `cliente_id`           | Integer       | Identifier of the client                |
    | `cliente_nome`         | String        | Name of the client                      |
    | `status`               | Integer       | Status code                             |
    | `dataLimite`           | Datetime      | Deadline date                           |
    | `etapa`                | Integer       | Stage                                   |
    | `pipeline`             | String        | Pipeline name                           |
    | `funil_venda_id`       | Integer       | Sales funnel identifier                 |
    | `funil_venda_nome`     | String        | Sales funnel name                       |
    | `responsavel_id`       | Integer       | Identifier of the responsible user      |
    | `responsavel_nome`     | String        | Name of the responsible user            |
    | `responsavel_login`    | String        | Login of the responsible user           |
    | `tarefas`              | Integer       | Number of tasks                         |
    | `compromissos`         | Integer       | Number of appointments                  |
    | `camposPersonalizados` | String (JSON) | Custom fields in JSON format            |
    | `dataCriacao`          | Datetime      | Creation date                           |
    | `dataAtualizacao`      | Datetime      | Last update date                        |
  </Accordion>

  <Accordion title="Appointments">
    | Field               | Type             | Description                           |
    | :------------------ | :--------------- | :------------------------------------ |
    | `id`                | Integer          | Unique identifier for the appointment |
    | `assunto`           | String           | Subject                               |
    | `titulo`            | String           | Title                                 |
    | `descricao`         | String           | Description                           |
    | `dataInicio`        | Datetime         | Start date and time                   |
    | `dataFim`           | Datetime         | End date and time                     |
    | `diaInteiro`        | Boolean          | Indicates if it's an all-day event    |
    | `endereco`          | String           | Address                               |
    | `status`            | Integer          | Status code                           |
    | `cliente_id`        | Integer          | Identifier of the client              |
    | `cliente_nome`      | String           | Name of the client                    |
    | `responsavel_id`    | Integer          | Identifier of the responsible user    |
    | `responsavel_nome`  | String           | Name of the responsible user          |
    | `responsavel_login` | String           | Login of the responsible user         |
    | `tipo_id`           | Integer          | Identifier of the appointment type    |
    | `tipo_nome`         | String           | Name of the appointment type          |
    | `participantes`     | Array of objects | List of participants                  |
    | `dataCriacao`       | Datetime         | Creation date                         |
    | `dataAtualizacao`   | Datetime         | Last update date                      |
  </Accordion>

  <Accordion title="Tasks">
    | Field               | Type     | Description                        |
    | :------------------ | :------- | :--------------------------------- |
    | `id`                | Integer  | Unique identifier for the task     |
    | `titulo`            | String   | Title                              |
    | `descricao`         | String   | Description                        |
    | `dataLimite`        | Datetime | Deadline date                      |
    | `status`            | Integer  | Status code                        |
    | `tipo`              | Integer  | Type of task                       |
    | `prioridade`        | Integer  | Priority level                     |
    | `cliente_id`        | Integer  | Identifier of the client           |
    | `cliente_nome`      | String   | Name of the client                 |
    | `responsavel_id`    | Integer  | Identifier of the responsible user |
    | `responsavel_nome`  | String   | Name of the responsible user       |
    | `responsavel_login` | String   | Login of the responsible user      |
    | `checklist_id`      | Integer  | Identifier of the checklist        |
    | `checklist_nome`    | String   | Name of the checklist              |
    | `dataCriacao`       | Datetime | Creation date                      |
    | `dataAtualizacao`   | Datetime | Last update date                   |
  </Accordion>

  <Accordion title="Feedbacks">
    | Field               | Type             | Description                                      |
    | :------------------ | :--------------- | :----------------------------------------------- |
    | `id`                | Integer          | Unique identifier for the feedback               |
    | `assunto`           | String           | Subject                                          |
    | `descricao`         | String           | Description                                      |
    | `importante`        | Boolean          | Indicates if the feedback is marked as important |
    | `automatica`        | Boolean          | Indicates if it was automatically generated      |
    | `qtdeComentarios`   | Integer          | Number of comments                               |
    | `autor_id`          | Integer          | Identifier of the author                         |
    | `autor_nome`        | String           | Name of the author                               |
    | `autor_login`       | String           | Login of the author                              |
    | `contato_id`        | Integer          | Identifier of the related contact                |
    | `contato_nome`      | String           | Name of the related contact                      |
    | `oportunidade_id`   | Integer          | Identifier of the related opportunity            |
    | `oportunidade_nome` | String           | Name of the related opportunity                  |
    | `tarefa_id`         | Integer          | Identifier of the related task                   |
    | `tarefa_titulo`     | String           | Title of the related task                        |
    | `anexos`            | Array of objects | List of attachments                              |
    | `dataCriacao`       | Datetime         | Creation date                                    |
    | `dataAtualizacao`   | Datetime         | Last update date                                 |
  </Accordion>

  <Accordion title="Products">
    | Field               | Type    | Description                        |
    | :------------------ | :------ | :--------------------------------- |
    | `id`                | Integer | Unique identifier for the product  |
    | `nome`              | String  | Name of the product                |
    | `descricao`         | String  | Description                        |
    | `codigo`            | String  | Product code                       |
    | `valor`             | Number  | Value/Price                        |
    | `recorrencia`       | Integer | Recurrence type/interval           |
    | `ativo`             | Boolean | Indicates if the product is active |
    | `categoria_id`      | Integer | Identifier of the category         |
    | `categoria_nome`    | String  | Name of the category               |
    | `subcategoria_id`   | Integer | Identifier of the subcategory      |
    | `subcategoria_nome` | String  | Name of the subcategory            |
  </Accordion>

  <Accordion title="Product Categories">
    | Field       | Type    | Description                                |
    | :---------- | :------ | :----------------------------------------- |
    | `id`        | Integer | Unique identifier for the product category |
    | `nome`      | String  | Name                                       |
    | `descricao` | String  | Description                                |
    | `ativo`     | Boolean | Indicates if it is active                  |
  </Accordion>

  <Accordion title="Product Subcategories">
    | Field            | Type    | Description                                   |
    | :--------------- | :------ | :-------------------------------------------- |
    | `id`             | Integer | Unique identifier for the product subcategory |
    | `nome`           | String  | Name                                          |
    | `descricao`      | String  | Description                                   |
    | `ativo`          | Boolean | Indicates if it is active                     |
    | `categoria_id`   | Integer | Identifier of the parent category             |
    | `categoria_nome` | String  | Name of the parent category                   |
  </Accordion>

  <Accordion title="Price Tables">
    | Field       | Type    | Description                           |
    | :---------- | :------ | :------------------------------------ |
    | `id`        | Integer | Unique identifier for the price table |
    | `nome`      | String  | Name                                  |
    | `descricao` | String  | Description                           |
    | `ativo`     | Boolean | Indicates if it is active             |
  </Accordion>

  <Accordion title="Proposals">
    | Field               | Type     | Description                           |
    | :------------------ | :------- | :------------------------------------ |
    | `id`                | Integer  | Unique identifier for the proposal    |
    | `nome`              | String   | Name                                  |
    | `descricao`         | String   | Description                           |
    | `codigo`            | String   | Code                                  |
    | `status`            | Integer  | Status code                           |
    | `valorTotal`        | Number   | Total value                           |
    | `cliente_id`        | Integer  | Identifier of the client              |
    | `cliente_nome`      | String   | Name of the client                    |
    | `oportunidade_id`   | Integer  | Identifier of the related opportunity |
    | `responsavel_id`    | Integer  | Identifier of the responsible user    |
    | `responsavel_nome`  | String   | Name of the responsible user          |
    | `responsavel_login` | String   | Login of the responsible user         |
    | `dataCriacao`       | Datetime | Creation date                         |
    | `dataAtualizacao`   | Datetime | Last update date                      |
  </Accordion>

  <Accordion title="Pipelines">
    | Field    | Type             | Description                        |
    | :------- | :--------------- | :--------------------------------- |
    | `id`     | Integer          | Unique identifier for the pipeline |
    | `nome`   | String           | Name                               |
    | `ativo`  | Boolean          | Indicates if it is active          |
    | `etapas` | Array of objects | Stages within the pipeline         |
  </Accordion>

  <Accordion title="Custom Fields">
    | Field         | Type             | Description                            |
    | :------------ | :--------------- | :------------------------------------- |
    | `id`          | Integer          | Unique identifier for the custom field |
    | `nome`        | String           | Name                                   |
    | `tipo`        | String           | Type of field                          |
    | `obrigatorio` | Boolean          | Indicates if it is mandatory           |
    | `ativo`       | Boolean          | Indicates if it is active              |
    | `secao`       | String           | Section where it appears               |
    | `opcoes`      | Array of strings | Available options for selection        |
  </Accordion>

  <Accordion title="Tags">
    | Field  | Type    | Description                   |
    | :----- | :------ | :---------------------------- |
    | `id`   | Integer | Unique identifier for the tag |
    | `nome` | String  | Name                          |
  </Accordion>

  <Accordion title="Sources">
    | Field  | Type    | Description                      |
    | :----- | :------ | :------------------------------- |
    | `id`   | Integer | Unique identifier for the source |
    | `nome` | String  | Name                             |
  </Accordion>

  <Accordion title="Segments">
    | Field  | Type    | Description                       |
    | :----- | :------ | :-------------------------------- |
    | `id`   | Integer | Unique identifier for the segment |
    | `nome` | String  | Name                              |
  </Accordion>

  <Accordion title="Categories">
    | Field  | Type    | Description                        |
    | :----- | :------ | :--------------------------------- |
    | `id`   | Integer | Unique identifier for the category |
    | `nome` | String  | Name                               |
  </Accordion>

  <Accordion title="Teams">
    | Field                    | Type          | Description                          |
    | :----------------------- | :------------ | :----------------------------------- |
    | `id`                     | Integer       | Unique identifier for the team       |
    | `nome`                   | String        | Team name                            |
    | `ativo`                  | Boolean       | Indicates if the team is active      |
    | `padrao`                 | Boolean       | Indicates if the team is the default |
    | `historicoCompartilhado` | Boolean       | Shared history flag                  |
    | `lider`                  | String (JSON) | Team leader information              |
    | `participantes`          | String (JSON) | Team participants                    |
    | `responsaveis`           | String (JSON) | Team responsible users               |
  </Accordion>

  <Accordion title="Users">
    | Field                | Type          | Description                                     |
    | :------------------- | :------------ | :---------------------------------------------- |
    | `id`                 | Integer       | Unique identifier for the user                  |
    | `uuid`               | String        | UUID of the user                                |
    | `login`              | String        | Login username                                  |
    | `usuarioMasterId`    | Integer       | Master user ID                                  |
    | `usuarioMasterUuid`  | String        | Master user UUID                                |
    | `nome`               | String        | Full name                                       |
    | `email`              | String        | Email address                                   |
    | `telefone`           | String        | Phone number                                    |
    | `cargo`              | String        | Job title                                       |
    | `ramal`              | String        | Extension number                                |
    | `sipUsername`        | String        | SIP username for VoIP                           |
    | `locale`             | String        | User locale/language                            |
    | `tema`               | String        | UI theme                                        |
    | `ativo`              | Boolean       | Indicates if the user is active                 |
    | `ausente`            | Boolean       | Indicates if the user is absent                 |
    | `isOnline`           | Boolean       | Indicates if the user is online                 |
    | `limitContactExport` | Boolean       | Contact export limit flag                       |
    | `sobreporRestricoes` | Boolean       | Override restrictions flag                      |
    | `perfilUsuario`      | String (JSON) | User profile in JSON format                     |
    | `atribuicoes`        | String (JSON) | User assignments in JSON format                 |
    | `grupos`             | String (JSON) | User groups in JSON format                      |
    | `gruposResponsaveis` | String (JSON) | Groups where user is responsible in JSON format |
    | `gruposLider`        | String (JSON) | Groups where user is leader in JSON format      |
    | `dataCriacao`        | Datetime      | Creation date                                   |
    | `dataAtivacao`       | Datetime      | Activation date                                 |
    | `dataUltimoAcesso`   | Datetime      | Last access date                                |
    | `dataAtualizacao`    | Datetime      | Last update date                                |
  </Accordion>
</AccordionGroup>

## Skills for agents

<Snippet file="agent-skills-intro.mdx" />

<Card title="Download NectarCRM skills file" icon="wand-magic-sparkles" href="/sources/nectarcrm.md">
  NectarCRM connector documentation as plain markdown, for use in AI agent contexts.
</Card>