> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# KarmaCRM Connector

## Intro

KarmaCRM is web-based small business CRM software that helps consolidate sales contacts. To learn more about the KarmaCRM API, visit their page ([https://docs.karmacrm.com/#introduction](https://docs.karmacrm.com/#introduction "http://dev.karmacrm.com/docs/curl") ).

You connect to your KarmaCRM account in the Data Center. This topic discusses the fields and menus that are specific to the KarmaCRM connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").

## Prerequisites

To connect to your KarmaCRM account and create a DataSet, you must have a KarmaCRM API key. For information about finding your API key, see [https://docs.karmacrm.com/#introduction](https://docs.karmacrm.com/#introduction "https://support.karmacrm.com/the-technical-side-of-karmacrm/api/api-contacts").

## Connecting to Your KarmaCRM Account

This section enumerates the options in the **Credentials** and **Details** panes in the KarmaCRM Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your KarmaCRM account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> API Key </p></td><td colspan="1" rowspan="1"><p> Enter your KarmaCRM API key. </p></td></tr></tbody></table>

Once you have entered valid KarmaCRM credentials, you can use the same account any time you go to create a new KarmaCRM DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Manage Connector/Adapter Accounts](https://domo-support.domo.com/s/article/360042926054?language=en_US "Manage Connector/Adapter Accounts").

### Details Pane

This pane contains a primary **Reports** menu, along with various other menus which may or may not appear depending on the report type you select.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the KarmaCRM report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p><b> Report Name </b></p></td><td colspan="1" rowspan="1"><p><b> Description </b></p></td></tr><tr><td colspan="1" rowspan="1"><p> Companies </p></td><td colspan="1" rowspan="1"><p> Returns a list of companies you can see. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Company Cases </p></td><td colspan="1" rowspan="1"><p> Returns a list of cases by company. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Company Contacts </p></td><td colspan="1" rowspan="1"><p> Returns a list of contacts by company. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Company Deals </p></td><td colspan="1" rowspan="1"><p> Returns a list of deals by company. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Company Tasks </p></td><td colspan="1" rowspan="1"><p> Returns a list of tasks by company. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Contact Cases </p></td><td colspan="1" rowspan="1"><p> Returns a list of cases by contact. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Contact Deals </p></td><td colspan="1" rowspan="1"><p> Returns a list of deals by contact. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Contact Tasks </p></td><td colspan="1" rowspan="1"><p> Returns a list of tasks by contact. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Contacts </p></td><td colspan="1" rowspan="1"><p> Returns a list of contacts you can see. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deal Tasks </p></td><td colspan="1" rowspan="1"><p> Returns a list of tasks by deal. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deals </p></td><td colspan="1" rowspan="1"><p> Returns a list of deals you can see. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Tasks </p></td><td colspan="1" rowspan="1"><p> Returns a list of tasks you can see. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Company ID </p></td><td colspan="1" rowspan="1"><p> Enter the ID of the company you want to retrieve data for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Contact ID </p></td><td colspan="1" rowspan="1"><p> Enter the ID of the contact you want to retrieve data for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Case ID </p></td><td colspan="1" rowspan="1"><p> Enter the ID of the case you want to retrieve data for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deal ID </p></td><td colspan="1" rowspan="1"><p> Enter the ID of the deal you want to retrieve data for. </p></td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [Adding a DataSet Using a Connector](https://domo-support.domo.com/s/article/360042926274?language=en_US "Adding a DataSet Using a Connector").