Hunter

Learn how to use Hunter with Composio

Overview

SLUG: HUNTER

Description

Hunter is an email marketing company specializing in lead generation and data enrichment.

Authentication Details

generic_api_key
stringRequired

Connecting to Hunter

Create an auth config

Use the dashboard to create an auth config for the Hunter toolkit. This allows you to connect multiple Hunter accounts to Composio for agents to use.

1

Select App

Navigate to Hunter.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Hunter Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4hunter_auth_config_id = "ac_YOUR_HUNTER_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Hunter for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, hunter_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Hunter toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Account Information

Description

Tool to retrieve information about your Hunter account. Use when you need to check your plan details and usage limits after confirming credentials.

Action Parameters

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Combined Enrichment

Description

Tool to find both person and company information from an email address or LinkedIn handle in a single request. Use when you need complete professional profile enrichment including employment and company details.

Action Parameters

email
linkedin

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: Company Enrichment

Description

Tool to get enrichment information for a company by its domain. Use when you need full company details (industry, description, location, metrics) from Hunter.

Action Parameters

clearbit_format
domain
stringRequired

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: Create custom lead attribute

Description

Tool to create a new custom lead attribute in your account. Use after deciding on the attribute label.

Action Parameters

label
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Lead

Description

Tool to create a new lead. Use after gathering all prospect details to save them to your Hunter account.

Action Parameters

company
company_industry
company_size
confidence_score
country_code
custom_attributes
email
stringRequired
first_name
last_name
leads_list_id
leads_list_ids
linkedin_url
notes
phone_number
position
source
twitter
website

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Create Leads List

Description

Tool to create a new leads list. Use when you need to organize leads into a custom list before adding leads.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Custom Attribute

Description

Tool to delete an existing custom attribute. Use after confirming the attribute ID to be removed.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Lead

Description

Tool to delete a lead. Use after confirming the lead's ID to remove it from your Hunter.io account.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Delete Leads List

Description

Tool to delete a leads list by its ID. Use after confirming the leads list ID to remove it from your Hunter.io account.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Discover Companies

Description

Tool to search and retrieve companies matching specified criteria using filters or natural language queries. Use when you need to discover companies from Hunter's B2B dataset based on industry, location, size, or other characteristics.

Action Parameters

company_type_exclude
company_type_include
funding_amount_from
funding_amount_to
funding_date_from
funding_date_to
funding_series
headcount
headquarters_location_exclude
headquarters_location_include
industry_exclude
industry_include
keywords_exclude
keywords_include
keywords_match
limit
offset
organization_domain
organization_name
query
similar_to_domain
similar_to_name
technology_exclude
technology_include
technology_match
year_founded_from
year_founded_include
year_founded_to

Action Response

data
arrayRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: Email Count

Description

Tool to get the total number of email addresses Hunter has for a domain or company with breakdowns by type, department, and seniority. Use when you need email volume statistics without consuming API credits (this call is free).

Action Parameters

company
domain
type

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: Email Finder

Description

Tool to find the most likely email address for a person at a domain or company. Use when you have a person's name and a domain or company and need to infer their email.

Action Parameters

company
domain
first_name
full_name
last_name
max_duration
Defaults to 10

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: Email Verifier

Description

Tool to verify the deliverability of an email address. Use when you need to ensure an address is valid and reachable.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: Get Custom Attribute

Description

Tool to retrieve details of a specific custom attribute. Use when you need the label and slug for an attribute ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Lead

Description

Tool to retrieve details of a specific lead by ID. Use after confirming the lead's ID to fetch its full record.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Leads List

Description

Tool to retrieve details of a specific leads list by ID. Use when you need to inspect the contents of an existing leads list.

Action Parameters

id
integerRequired
limit
integerDefaults to 20
offset
integer

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: List Campaigns

Description

Tool to get all email campaigns in your Hunter account. Campaigns are returned in reverse-chronological order by creation date. Use when you need to retrieve and filter campaigns by status (started/archived) with pagination support.

Action Parameters

archived
limit
integerDefaults to 20
offset
integer
started

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: List Custom Attributes

Description

Tool to list all custom lead attributes in your account. Use when you need to retrieve your account's custom lead attributes after authenticating.

Action Parameters

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: List Leads

Description

Tool to list all leads saved in your account with optional filters. Use when you need to retrieve leads with specific criteria after confirming your API key.

Action Parameters

company
country_code
created_at
custom_attributes
email
first_name
last_activity_at
last_contacted_at
last_name
leads_list_id
limit
Defaults to 20
linkedin_url
max_confidence_score
min_confidence_score
offset
phone_number
position
query
twitter
website

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: List Leads Lists

Description

Tool to list all leads lists in your account. Use when you need to retrieve and paginate through your leads lists.

Action Parameters

limit
integerDefaults to 20
offset
integer

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: People Enrichment

Description

Tool to find all information associated with an email address or LinkedIn profile including name, location, job title and social handles. Use when you need to enrich contact data with additional personal and professional details.

Action Parameters

clearbit_format
email
linkedin_handle

Action Response

data
objectRequired
error
meta
objectRequired
successful
booleanRequired

Tool Name: Update Custom Attribute

Description

Tool to update an existing custom attribute's label. Use when renaming a custom attribute after creation.

Action Parameters

id
integerRequired
label
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Lead

Description

Tool to update details of an existing lead by ID. Use when you need to modify saved lead attributes after creation.

Action Parameters

company
company_industry
company_size
confidence_score
country_code
custom_attributes
email
first_name
id
integerRequired
last_name
leads_list_id
leads_list_ids
linkedin_url
notes
phone_number
position
source
twitter
website

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Update Leads List

Description

Tool to update the name of a specific leads list. Use when renaming an existing leads list.

Action Parameters

id
integerRequired
name
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Upsert Lead

Description

Tool to create or update a lead by email in one call. Use when you want to ensure a lead exists with the provided information without checking its existence first.

Action Parameters

company
company_industry
company_size
confidence_score
country_code
custom_attributes
email
stringRequired
first_name
last_name
leads_list_id
leads_list_ids
linkedin_url
notes
phone_number
position
source
twitter
website

Action Response

data
objectRequired
error
successful
booleanRequired