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

# Hunter

> Add a bot to Hunter using the official integration.

{/* vale on */}

[Open in Hub](https://studio.botpress.cloud/home?exploreHub=1\&hubItemId=intver_01KMZAKV7RM16T6375G0JXDYHH)
*v1.0.2*

The official Hunter integration allows your bot to interact with your Hunter leads.

## Setup

> [!NOTE]
>
> You will need:
>
> * A [published bot](https://botpress.com/docs/get-started/quick-start.md)
> * A [Hunter account](https://hunter.io/users/sign_up)

**1. Install the integration in Botpress**

First, install the integration to your bot:

1. In Botpress Studio, select **Explore Hub** in the upper-right corner.
2. Search for the **Hunter** integration, then select **Install Integration**.

In the **Configuration** menu, you should see one field: **API key**. Leave it empty for now—you'll come back to it after getting your Hunter API key.

**2. Get your Hunter API key**

Next, get your Canny API key:

1. [Log in to your Hunter dashboard](https://hunter.io/users/sign_in).
2. From the left sidebar, go to **API**.
3. Copy your API key.

**3. Configure the integration in Botpress**

Now, you can finish setting up the integration in Botpress:

1. In the integration's **API Key** field, paste your Hunter API key.
2. Select **Save Configuration**.

> [!TIP]
>
> Your Hunter integration is ready. You can use the integration's [Cards](#cards) to interact with your Hunter leads.

## Cards

{/* vale off */}

Here's a reference for all [Cards](https://botpress.com/docs/studio/concepts/cards/introduction.md) available with the integration:

### Create Lead

Create a new lead in Hunter.io

**input** `object`

**lead** `object` *required*

Schema for creating or updating a lead in Hunter.io

**email** `string (email)` *required*

Email address of the lead

**first\_name** `string`

First name of the lead

**last\_name** `string`

Last name of the lead

**position** `string`

Job position of the lead

**company** `string`

Company name of the lead

**company\_industry** `string`

Industry of the lead company

**company\_size** `string`

Size of the lead company

**confidence\_score** `number`

Confidence score of the lead email

**website** `string`

Website URL of the lead

**country\_code** `string`

Country code of the lead

**source** `string`

Source of the lead

**linkedin\_url** `string`

LinkedIn profile URL of the lead

**phone\_number** `string`

Phone number of the lead

**twitter** `string`

Twitter handle of the lead

**notes** `string`

Additional notes about the lead

**leads\_list\_id** `number`

ID of the leads list

**leads\_list\_ids** `array`

Array of leads list IDs

**custom\_attributes** `object`

Custom attributes for the lead

**output** `object`

**lead** `object` *required*

Schema representing a lead in Hunter.io

**id** `number` *required*

Unique identifier of the lead

**email** `string (email)` *required*

Email address of the lead

**first\_name** `string | null` *required*

**last\_name** `string | null` *required*

**position** `string | null` *required*

**company** `string | null` *required*

**company\_industry** `string | null` *required*

**company\_size** `string | null` *required*

**confidence\_score** `number | null` *required*

**website** `string | null` *required*

**country\_code** `string | null` *required*

**source** `string | null` *required*

**linkedin\_url** `string | null` *required*

**phone\_number** `string | null` *required*

**twitter** `string | null` *required*

**sync\_status** `string | null` *required*

**notes** `string | null` *required*

**sending\_status** `string | null` *required*

**last\_activity\_at** `string | null` *required*

**last\_contacted\_at** `string | null` *required*

**verification** `object` *required*

Email verification details

**date** `string | null` *required*

**status** `string | null` *required*

**leads\_list** `object` *required*

Leads list information

**id** `number` *required*

ID of the leads list

**name** `string` *required*

Name of the leads list

**leads\_count** `number` *required*

Number of leads in the list

**created\_at** `string` *required*

Creation timestamp of the lead

### Create or update Lead

Create or update a lead in Hunter.io

**input** `object`

**lead** `object` *required*

Schema for creating or updating a lead in Hunter.io

**email** `string (email)` *required*

Email address of the lead

**first\_name** `string`

First name of the lead

**last\_name** `string`

Last name of the lead

**position** `string`

Job position of the lead

**company** `string`

Company name of the lead

**company\_industry** `string`

Industry of the lead company

**company\_size** `string`

Size of the lead company

**confidence\_score** `number`

Confidence score of the lead email

**website** `string`

Website URL of the lead

**country\_code** `string`

Country code of the lead

**source** `string`

Source of the lead

**linkedin\_url** `string`

LinkedIn profile URL of the lead

**phone\_number** `string`

Phone number of the lead

**twitter** `string`

Twitter handle of the lead

**notes** `string`

Additional notes about the lead

**leads\_list\_id** `number`

ID of the leads list

**leads\_list\_ids** `array`

Array of leads list IDs

**custom\_attributes** `object`

Custom attributes for the lead

**output** `object`

**lead** `object` *required*

Schema representing a lead in Hunter.io

**id** `number` *required*

Unique identifier of the lead

**email** `string (email)` *required*

Email address of the lead

**first\_name** `string | null` *required*

**last\_name** `string | null` *required*

**position** `string | null` *required*

**company** `string | null` *required*

**company\_industry** `string | null` *required*

**company\_size** `string | null` *required*

**confidence\_score** `number | null` *required*

**website** `string | null` *required*

**country\_code** `string | null` *required*

**source** `string | null` *required*

**linkedin\_url** `string | null` *required*

**phone\_number** `string | null` *required*

**twitter** `string | null` *required*

**sync\_status** `string | null` *required*

**notes** `string | null` *required*

**sending\_status** `string | null` *required*

**last\_activity\_at** `string | null` *required*

**last\_contacted\_at** `string | null` *required*

**verification** `object` *required*

Email verification details

**date** `string | null` *required*

**status** `string | null` *required*

**leads\_list** `object` *required*

Leads list information

**id** `number` *required*

ID of the leads list

**name** `string` *required*

Name of the leads list

**leads\_count** `number` *required*

Number of leads in the list

**created\_at** `string` *required*

Creation timestamp of the lead

### Delete Lead

Delete a lead from Hunter.io

**input** `object`

**id** `number` *required*

The ID of the lead to delete

**output** `object`

This Card has no output.

### Get Leads

Fetch leads from Hunter.io

**input** `object`

**search** `object` *required*

Filters to search leads in Hunter.io

**leads\_list\_id** `number`

Filter by leads list ID

**email** `string`

Filter by email address

**first\_name** `string`

Filter by first name

**last\_name** `string`

Filter by last name

**position** `string`

Filter by job position

**company** `string`

Filter by company name

**industry** `string`

Filter by company industry

**website** `string`

Filter by website URL

**country\_code** `string`

Filter by country code

**company\_size** `string`

Filter by company size

**source** `string`

Filter by lead source

**twitter** `string`

Filter by Twitter handle

**linkedin\_url** `string`

Filter by LinkedIn URL

**phone\_number** `string`

Filter by phone number

**sync\_status** `enum\<string\>`

Filter by synchronization status

Available options: `pending`, `error`, `success`

**sending\_status** `array`

Filter by email sending status

**verification\_status** `array`

Filter by email verification status

**last\_activity\_at** `enum\<string\>`

Filter by last activity timestamp

Available options: `*`, `~`

**last\_contacted\_at** `enum\<string\>`

Filter by last contacted timestamp

Available options: `*`, `~`

**custom\_attributes** `object`

Filter by custom attributes

**query** `string`

Filter on first name, last name or email

**limit** `number`

Maximum number of results to return

**offset** `number`

Number of results to skip

**output** `object`

**leads** `array` *required*

List of leads retrieved from Hunter.io

**array item properties**

**id** `number` *required*

Unique identifier of the lead

**email** `string (email)` *required*

Email address of the lead

**first\_name** `string | null` *required*

**last\_name** `string | null` *required*

**position** `string | null` *required*

**company** `string | null` *required*

**company\_industry** `string | null` *required*

**company\_size** `string | null` *required*

**confidence\_score** `number | null` *required*

**website** `string | null` *required*

**country\_code** `string | null` *required*

**source** `string | null` *required*

**linkedin\_url** `string | null` *required*

**phone\_number** `string | null` *required*

**twitter** `string | null` *required*

**sync\_status** `string | null` *required*

**notes** `string | null` *required*

**sending\_status** `string | null` *required*

**last\_activity\_at** `string | null` *required*

**last\_contacted\_at** `string | null` *required*

**verification** `object` *required*

Email verification details

**date** `string | null` *required*

**status** `string | null` *required*

**leads\_list** `object` *required*

Leads list information

**id** `number` *required*

ID of the leads list

**name** `string` *required*

Name of the leads list

**leads\_count** `number` *required*

Number of leads in the list

**created\_at** `string` *required*

Creation timestamp of the lead

### Retrieve Lead

Retrieve a specific lead by ID from Hunter.io

**input** `object`

**id** `number` *required*

The ID of the lead to retrieve

**output** `object`

**lead** `object` *required*

Schema representing a lead in Hunter.io

**id** `number` *required*

Unique identifier of the lead

**email** `string (email)` *required*

Email address of the lead

**first\_name** `string | null` *required*

**last\_name** `string | null` *required*

**position** `string | null` *required*

**company** `string | null` *required*

**company\_industry** `string | null` *required*

**company\_size** `string | null` *required*

**confidence\_score** `number | null` *required*

**website** `string | null` *required*

**country\_code** `string | null` *required*

**source** `string | null` *required*

**linkedin\_url** `string | null` *required*

**phone\_number** `string | null` *required*

**twitter** `string | null` *required*

**sync\_status** `string | null` *required*

**notes** `string | null` *required*

**sending\_status** `string | null` *required*

**last\_activity\_at** `string | null` *required*

**last\_contacted\_at** `string | null` *required*

**verification** `object` *required*

Email verification details

**date** `string | null` *required*

**status** `string | null` *required*

**leads\_list** `object` *required*

Leads list information

**id** `number` *required*

ID of the leads list

**name** `string` *required*

Name of the leads list

**leads\_count** `number` *required*

Number of leads in the list

**created\_at** `string` *required*

Creation timestamp of the lead

### Update Lead

Update an existing lead in Hunter.io

**input** `object`

**id** `number` *required*

The ID of the lead to update

**lead** `object` *required*

Schema for creating or updating a lead in Hunter.io

**email** `string (email)`

Email address of the lead

**first\_name** `string`

First name of the lead

**last\_name** `string`

Last name of the lead

**position** `string`

Job position of the lead

**company** `string`

Company name of the lead

**company\_industry** `string`

Industry of the lead company

**company\_size** `string`

Size of the lead company

**confidence\_score** `number`

Confidence score of the lead email

**website** `string`

Website URL of the lead

**country\_code** `string`

Country code of the lead

**source** `string`

Source of the lead

**linkedin\_url** `string`

LinkedIn profile URL of the lead

**phone\_number** `string`

Phone number of the lead

**twitter** `string`

Twitter handle of the lead

**notes** `string`

Additional notes about the lead

**leads\_list\_id** `number`

ID of the leads list

**leads\_list\_ids** `array`

Array of leads list IDs

**custom\_attributes** `object`

Custom attributes for the lead

**output** `object`

This Card has no output.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.