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

# Hunter

## What's supported

### Supported actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported, a full read of the Hunter instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://api.hunter.io`.

### Supported Objects

The Hunter connector supports reading from the following objects:

* [leads](https://hunter.io/api-documentation#list-leads)
* [leads\_custom\_attributes](https://hunter.io/api-documentation#custom-attributes)
* [leads\_lists](https://hunter.io/api-documentation#list-leads-lists)
* [campaigns](https://hunter.io/api-documentation#list-campaigns)
* [account](https://hunter.io/api-documentation#account)

The Hunter connector supports writing to the following objects:

* [leads](https://hunter.io/api-documentation#create-lead)
* [leads\_custom\_attributes](https://hunter.io/api-documentation#create-custom-attribute)
* [leads\_lists](https://hunter.io/api-documentation#create-leads-list)

### Example integration

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

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

## Before you get started

To use the Hunter connector, you'll need an API key from your Hunter account. Here's how to get it:

1. Log in to your [Hunter account](https://hunter.io/).
2. Go to the [API](https://hunter.io/api-keys) section by clicking on it from the left sidebar.
3. Generate a new API key.

## Using the connector

This connector uses API Key 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 Hunter:

* 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 an API key.
* Start making [Proxy Calls](/proxy-actions), and Ampersand will automatically attach the API key supplied by the customer. Please note that this connector's base URL is `https://api.hunter.io`.

For detailed information about available endpoints, refer to the [Hunter API Reference](https://hunter.io/api-documentation/v2).
