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

# Nutshell Connector

## Intro

Nutshell is a user-friendly small business CRM that helps sales reps win more deals, with sales process automation, fast onboarding, and free support. To learn more about the Nutshell API, visit their page ([https://developers.nutshell.com/](https://developers.nutshell.com/ "https://developers.nutshell.com/") ).

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

## Prerequisites

To connect to your Nutshell account and create a DataSet, you must have the following:

* The username you use to log into your Nutshell account
* A Nutshell API key

To obtain a Nutshell API key, do the following:

1. Log into your Nutshell account.
2. Navigate to the **Setup** menu.
3. Click **API Keys** (in the "Third-party" category).
4. Click **Add API key**.
5. Enter a name for the API key.
6. Under "Permissions," select the button for **API Access**.
7. Click **New API key**.
8. Copy the newly generated API key.

## Connecting to Your Nutshell Account

This section enumerates the options in the **Credentials** and **Details** panes in the Nutshell 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 Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your Nutshell 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> Username </p></td><td colspan="1" rowspan="1"><p> Enter the username for your Nutshell account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> API Key </p></td><td colspan="1" rowspan="1"><p> Enter your Nutshell API key. For steps for obtaining an API key, see "Prerequisites" above. </p></td></tr></tbody></table>

Once you have entered valid Nutshell credentials, you can use the same account any time you go to create a new Nutshell DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### 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 Nutshell 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> Find Accounts </p></td><td colspan="1" rowspan="1"><p> Returns accounts matching the specified criteria. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Find Activities </p></td><td colspan="1" rowspan="1"><p> Returns activities matching the specified criteria and date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Find Contacts </p></td><td colspan="1" rowspan="1"><p> Returns contacts matching the specified criteria. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Find Tags </p></td><td colspan="1" rowspan="1"><p> Returns tags for a given entity (Accounts, Contacts, or Leads). </p></td></tr><tr><td colspan="1" rowspan="1"><p> Get Account </p></td><td colspan="1" rowspan="1"><p> Returns details for the selected account. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Get Activity </p></td><td colspan="1" rowspan="1"><p> Returns details for the selected activity. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Get Contact </p></td><td colspan="1" rowspan="1"><p> Returns details for the selected contact. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Search Accounts </p></td><td colspan="1" rowspan="1"><p> Returns account information based on a provided search string. A maximum of 100 search results can be returned. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Search Activity Participants </p></td><td colspan="1" rowspan="1"><p> Returns activity participant information based on a provided search string. A maximum of 100 search results can be returned. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Search Contacts </p></td><td colspan="1" rowspan="1"><p> Returns contact information based on a provided search string. A maximum of 100 search results can be returned. </p></td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"><p> Add Filters </p></td><td colspan="1" rowspan="1"><p> Select <b> Yes </b> if you want to include search filters in this report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Account Type </p></td><td colspan="1" rowspan="1"><p> Select the account type you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Industries </p></td><td colspan="1" rowspan="1"><p> Select the industries you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Territories </p></td><td colspan="1" rowspan="1"><p> Select the territories you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Origins </p></td><td colspan="1" rowspan="1"><p> Select the origins you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Open Leads </p></td><td colspan="1" rowspan="1"><p> Select <b> True </b> to return data for accounts associated with open leads. Select <b> False </b> to return data for all accounts. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Entity </p></td><td colspan="1" rowspan="1"><p> Select the entity you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Tags </p></td><td colspan="1" rowspan="1"><p> Check the boxes for all tags you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Flagged Important? </p></td><td colspan="1" rowspan="1"><p> Select <b> True </b> to return data for activities that has been flagged as "Important" in Nutshell. Otherwise select <b> False </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Activity Status </p></td><td colspan="1" rowspan="1"><p> Select the activity status you want to retrieve information for. Note that "Overdue" status implies "Scheduled." </p></td></tr><tr><td colspan="1" rowspan="1"><p> Contacts </p></td><td colspan="1" rowspan="1"><p> Check the boxes for all contacts you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Accounts </p></td><td colspan="1" rowspan="1"><p> Check the boxes for all accounts you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Users </p></td><td colspan="1" rowspan="1"><p> Check the boxes for all users you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Activity Types </p></td><td colspan="1" rowspan="1"><p> Check the boxes for all activity types you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in <b> End Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in <b> Start Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the second date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to Start From </p></td><td colspan="1" rowspan="1"><p> Enter the number of the farthest day back that should be represented in the report. Combine with <b> Days Back to End At </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to End At </p></td><td colspan="1" rowspan="1"><p> Enter the number of the most recent day back that should be represented in the report. Combine with <b> Days Back to Start From </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Account </p></td><td colspan="1" rowspan="1"><p> Select the account you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Lead </p></td><td colspan="1" rowspan="1"><p> Select the lead you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Activity </p></td><td colspan="1" rowspan="1"><p> Select the activity you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Contact </p></td><td colspan="1" rowspan="1"><p> Select the contact you want to retrieve information for. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Search String </p></td><td colspan="1" rowspan="1"><p> Enter a search term to retrieve information 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 Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").
