Skip to main content

​
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 ). 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.

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

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

​
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:

Field

Description

API Key

Enter your KarmaCRM API key.

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.

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

Menu

Description

Report

Select the KarmaCRM report you want to run. The following reports are available:

Report Name

Description

Companies

Returns a list of companies you can see.

Company Cases

Returns a list of cases by company.

Company Contacts

Returns a list of contacts by company.

Company Deals

Returns a list of deals by company.

Company Tasks

Returns a list of tasks by company.

Contact Cases

Returns a list of cases by contact.

Contact Deals

Returns a list of deals by contact.

Contact Tasks

Returns a list of tasks by contact.

Contacts

Returns a list of contacts you can see.

Deal Tasks

Returns a list of tasks by deal.

Deals

Returns a list of deals you can see.

Tasks

Returns a list of tasks you can see.

Company ID

Enter the ID of the company you want to retrieve data for.

Contact ID

Enter the ID of the contact you want to retrieve data for.

Case ID

Enter the ID of the case you want to retrieve data for.

Deal ID

Enter the ID of the deal you want to retrieve data for.

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