> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Nutshell

## What's supported

### Supported actions

This connector supports:

* [Write Actions](/write-actions).
* [Read Actions](/read-actions), including full historic backfill and incremental read.
* [Proxy Actions](/proxy-actions), using the base URL `https://app.nutshell.com/api/v1`.

### Supported Objects

The Nutshell connector supports reading from and writing to the following objects:

* [accounts/list](https://developers.nutshell.com/reference/get_accounts-list-2)
* [accounts](https://developers.nutshell.com/reference/get_accounts) (incremental read)
* [accounttypes](https://developers.nutshell.com/reference/get_accounttypes-3)
* [activities](https://developers.nutshell.com/reference/get_activities-1) (incremental read)
* [activitytypes](https://developers.nutshell.com/reference/get_activitytypes-1)
* [audiences](https://developers.nutshell.com/reference/get_audiences-1)
* [competitormaps](https://developers.nutshell.com/reference/get_competitormaps)
* [competitors](https://developers.nutshell.com/reference/get_competitors)
* [contacts/list](https://developers.nutshell.com/reference/get_contacts-list-2)
* [contacts](https://developers.nutshell.com/reference/get_contacts) (incremental read)
* [deleted](https://developers.nutshell.com/reference/get_events-deleted)
* [events](https://developers.nutshell.com/reference/get_events) (incremental read)
* [forms](https://developers.nutshell.com/reference/get_forms)
* [industries](https://developers.nutshell.com/reference/get_industries-1)
* [leads/list](https://developers.nutshell.com/reference/get_leads-list-4)
* [leads](https://developers.nutshell.com/reference/get_leads) (incremental read)
* [notes](https://developers.nutshell.com/reference/get_notes)
* [productmaps](https://developers.nutshell.com/reference/get_productmaps)
* [products](https://developers.nutshell.com/reference/get_products)
* [report](https://developers.nutshell.com/reference/get_leads-report-1)
* [sources](https://developers.nutshell.com/reference/get_sources)
* [stages](https://developers.nutshell.com/reference/get_stages)
* [stagesets](https://developers.nutshell.com/reference/get_stagesets-1)
* [tags](https://developers.nutshell.com/reference/get_tags)
* [territories](https://developers.nutshell.com/reference/get_territories)
* [users](https://developers.nutshell.com/reference/get_users)

### Example integration

To define an integration for Nutshell, create a manifest file that looks like this:

```YAML theme={null}
# amp.yaml
specVersion: 1.0.0
integrations:
  - name: nutshell-integration
    displayName: My Nutshell Integration
    provider: nutshell
    proxy:
      enabled: true
```

## Using the connector

This connector uses Basic Auth, which means that you do not need to set up a Provider App before getting started. (Provider apps are only required for providers that use OAuth2 Authorization Code grant type.)

To start integrating with Nutshell:

* Create a manifest file like the example above.
* Deploy it using the [amp CLI](/cli/overview).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component. The UI component will prompt the customer for their username and password.
* Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the correct header required by Basic Auth. Please note that this connector's base URL is `https://app.nutshell.com/api/v1`.