Skip to content
Changelog

Report a bug

Hunter integration: operations for AI agents

Hunter connects to Type.com as an integration. This page lists the 183 operations documented for Claude and Codex in Type.com: 76 read, 55 write, 52 destructive.

About Hunter

Hunter vendor API references, subject to account permissions.

Categories: Email & Messaging

How to connect Hunter to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

183 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

183 operations listed.

Discover

  • Read

    Discover companies

    Find companies matching a structured filter set. This operation is free.

    POST /discover

  • Read

    Discover people matching filters

    Discover people matching filters

    GET /discover/people

  • Read

    Discover people using request-body filters

    Discover people using request-body filters

    POST /discover/people

Finder

  • Read

    Find email addresses by domain using request-body parameters

    Use POST for nested location filters. The body can be JSON or URL-encoded form data.

    POST /domain-search

  • Read

    Find a professional email address

    Supply a LinkedIn handle, or supply a domain/company plus either a full name or first and last name. A found email address is also saved automatically to your leads. This is enabled by default and can be disabled for your account. The saved lead keeps the verification status this response reports. It leaves out a phone number that is on a data broker deletion list, such as California's DROP.

    GET /email-finder

  • Read

    Count email addresses for a domain

    Return aggregate counts without revealing individual email addresses. This operation is free.

    GET /email-count

  • Read

    Count domains matching discovery filters

    Count domains matching discovery filters

    GET /domain-count

  • Read

    Find the domain for a company

    Find the domain for a company

    GET /domain-finder

  • Read

    Find the domain for a company via POST

    Find the domain for a company via POST

    POST /domain-finder

  • Read

    Suggest domains for a company name

    Suggest domains for a company name

    GET /domains-suggestion

  • Read

    Get a previously found email address

    Found-only variant of email finder. Supply a LinkedIn handle, or supply a domain/company plus either a full name or first and last name.

    GET /email-finder/found

  • Read

    Get a previously found email address via POST

    Found-only variant of email finder using request-body parameters.

    POST /email-finder/found

  • Write

    Reveal emails from a multi-domain search

    Reveal emails from a multi-domain search

    POST /multi-domain-search/reveal

Verifier

  • Read

    Verify an email address

    Check the deliverability of an email address. A `valid` or `accept_all` email address is also saved automatically to your leads, and a lead you already have gets the new verification result. This is enabled by default and can be disabled for your account. The saved lead leaves out a phone number that is on a data broker deletion list, such as California's DROP.

    GET /email-verifier

  • Read

    Get deliverability insight for an email address

    Get deliverability insight for an email address

    GET /email-insight

Enrichment

  • Read

    Enrich a person

    Enrich a person

    GET /people/find

  • Read

    Enrich a company

    Enrich a company

    GET /companies/find

  • Read

    Enrich a person and company

    Enrich a person and company

    GET /combined/find

Account

  • Read

    Get account details and usage

    When `data.requests.credits` is present, the team has a single credits pool: plan with `credits.remaining`. A search costs 1 credit and a verification 0.5 credit. `searches` and `verifications` are then approximate views of the same pool (rounded down, with request-pack usage counted per type), not separate quotas. Without `credits`, `searches` and `verifications` are separate quotas.

    GET /account

  • Read

    Get account profile summary

    Get account profile summary

    GET /account-stats

  • Write

    Update account details

    Update account details

    PUT /account

Usage

  • Read

    Get credit usage summary

    When `data.requests.credits` is present, the team has a single credits pool: plan with `credits.remaining`. A search costs 1 credit and a verification 0.5 credit. `searches` and `verifications` are then approximate views of the same pool (rounded down, with request-pack usage counted per type), not separate quotas. Without `credits`, `searches` and `verifications` are separate quotas.

    GET /usage

  • Read

    Get credit usage history

    Get credit usage history

    GET /usage/history

Team

  • Read

    List team members

    List team members

    GET /team/members

Connected Apps

  • Read

    List connected apps

    List connected apps

    GET /connected-apps

  • Read

    Get a connected app

    Get a connected app

    GET /connected-apps/{id}

  • Write

    Push data to a connected app

    Push data to a connected app

    POST /connected-apps/{id}/push

Email Accounts

  • Read

    List email accounts

    List email accounts

    GET /email-accounts

  • Read

    Get email account sending capacities

    Get email account sending capacities

    GET /email-accounts/capacities

  • Read

    Get an email account

    The account's `signature` is returned HTML-sanitized (HUN-22571).

    GET /email-accounts/{id}

  • Read

    Get an email account health report

    Get an email account health report

    GET /email-accounts/{id}/health-report

  • Read

    Get an email account usage report

    Get an email account usage report

    GET /email-accounts/{id}/usage

  • Read

    Get an email account warmup report

    Get an email account warmup report

    GET /email-accounts/{id}/warmup-report

  • Read

    List sequences using an email account

    List sequences using an email account

    GET /email-accounts/{id}/sequences

  • Write

    Update an email account

    Update an email account

    PATCH /email-accounts/{id}

  • Destructive

    Replace an email account

    Replace an email account

    PUT /email-accounts/{id}

Campaigns

  • Read

    List campaigns

    Each campaign carries `editable`. It is true when the API key's user owns the campaign or is a team admin or owner, and only then can that user add recipients to it.

    GET /campaigns

  • Read

    List campaign recipients

    When a recipient has asked Hunter to delete their address, with a claim or a California DROP request, their `email` is null (HUN-23599).

    GET /campaigns/{id}/recipients

  • Read

    Get a campaign follow-up step

    Get a campaign follow-up step

    GET /campaigns/{id}/follow-ups/{follow_up_id}

  • Write

    Add campaign recipients

    Add campaign recipients

    POST /campaigns/{id}/recipients

  • Write

    Start a campaign

    Start a campaign

    POST /campaigns/{id}/start

  • Write

    Add a campaign follow-up step

    Add a campaign follow-up step

    POST /campaigns/{id}/follow-ups

  • Destructive

    Remove campaign recipients

    Remove campaign recipients

    DELETE /campaigns/{id}/recipients

Sequences

  • Read

    List sequences

    Each sequence carries `editable`. It is true when the API key's user owns the sequence or is a team admin or owner, and only then can that user add recipients to it.

    GET /sequences

  • Read

    Get a sequence

    The `ab_testing` object reports the A/B test state: `enabled`, the split in `variant_a_percentage` and `variant_b_percentage`, and `winner_variant` with `winner_selected_at`. When `enabled` is false, the other fields are null. `settings.unsubscribe_sentence` and `settings.unsubscribe_sentence_plain_text` are the sequence's own unsubscribe sentences (HTML and plain text). Each is null when the sequence uses the owner's default sentence.

    GET /sequences/{id}

  • Read

    List sequence follow-up steps

    List sequence follow-up steps

    GET /sequences/{id}/follow-ups

  • Read

    Get a sequence follow-up step

    Get a sequence follow-up step

    GET /sequences/{id}/follow-ups/{follow_up_id}

  • Read

    Get sequence performance stats

    Get sequence performance stats

    GET /sequences/{id}/stats

  • Read

    List sequence recipients

    When a recipient has asked Hunter to delete their address, with a claim or a California DROP request, their `email` is null (HUN-23599).

    GET /sequences/{id}/recipients

  • Write

    Create a sequence

    Sender IDs must be available for outreach to the sequence owner. On the Free plan, extra or SMTP accounts retained only for a paid Inbox Protection period cannot be selected as senders. Submitting one returns 422 with error ID unknown_email_account_ids. Enabling `ai_assistant_enabled` requires a plan that includes the AI writing assistant. A request that turns it on without that entitlement is rejected with `ai_assistant_requires_upgrade` (422). `unsubscribe_sentence` sets the HTML unsubscribe sentence. It must contain `{{link}}` and `{{/link}}` exactly once, with the link text between them, in 200 characters or fewer. `unsubscribe_sentence_plain_text` sets the plain-text version, which has no link. Both must be plain text. Null, an empty string, or only spaces resets a sentence to the owner's default. An invalid sentence returns `validation_failed` (422). Both sentences stay editable after the sequence starts.

    POST /sequences

  • Write

    Update a sequence

    Sender IDs must be available for outreach to the sequence owner. On the Free plan, extra or SMTP accounts retained only for a paid Inbox Protection period cannot be selected as senders. Submitting one returns 422 with error ID unknown_email_account_ids. Enabling `ai_assistant_enabled` requires a plan that includes the AI writing assistant. A request that turns it on without that entitlement is rejected with `ai_assistant_requires_upgrade` (422). `unsubscribe_sentence` sets the HTML unsubscribe sentence. It must contain `{{link}}` and `{{/link}}` exactly once, with the link text between them, in 200 characters or fewer. `unsubscribe_sentence_plain_text` sets the plain-text version, which has no link. Both must be plain text. Null, an empty string, or only spaces resets a sentence to the owner's default. An invalid sentence returns `validation_failed` (422). Both sentences stay editable after the sequence starts.

    PATCH /sequences/{id}

  • Write

    Add a sequence follow-up step

    Add a sequence follow-up step

    POST /sequences/{id}/follow-ups

  • Write

    Update a sequence follow-up step

    A `body` in plain text or HTML keeps its line breaks and paragraphs. It is stored as the editor's HTML (`<div>` and `<br>`), also when `message_format` is `text`, so a read after the write can differ from the submitted body.

    PATCH /sequences/{id}/follow-ups/{follow_up_id}

  • Write

    Add sequence recipients

    Add sequence recipients

    POST /sequences/{id}/recipients

  • Write

    Start a sequence

    Start a sequence

    POST /sequences/{id}/start

  • Write

    Resume a paused sequence

    Resume a paused sequence

    DELETE /sequences/{sequence_id}/pause

  • Write

    Send a test email for every step of a sequence

    Queues one test message per follow-up of the sequence, in step order, to the supplied address. When A/B testing is enabled on a step, both variants are sent. Subjects are prefixed with [TEST]. Returns 422 when the sequence has no step, a step is missing its subject or body, the sequence has no email account, the account cannot send, or the recipient cannot be contacted. At most 30 test emails can be queued per 10 minutes.

    POST /sequences/{sequence_id}/test

  • Destructive

    Replace a sequence

    Sender IDs must be available for outreach to the sequence owner. On the Free plan, extra or SMTP accounts retained only for a paid Inbox Protection period cannot be selected as senders. Submitting one returns 422 with error ID unknown_email_account_ids. Enabling `ai_assistant_enabled` requires a plan that includes the AI writing assistant. A request that turns it on without that entitlement is rejected with `ai_assistant_requires_upgrade` (422). `unsubscribe_sentence` sets the HTML unsubscribe sentence. It must contain `{{link}}` and `{{/link}}` exactly once, with the link text between them, in 200 characters or fewer. `unsubscribe_sentence_plain_text` sets the plain-text version, which has no link. Both must be plain text. Null, an empty string, or only spaces resets a sentence to the owner's default. An invalid sentence returns `validation_failed` (422). Both sentences stay editable after the sequence starts.

    PUT /sequences/{id}

  • Destructive

    Delete a sequence

    Delete a sequence

    DELETE /sequences/{id}

  • Destructive

    Replace a sequence follow-up step

    A `body` in plain text or HTML keeps its line breaks and paragraphs. It is stored as the editor's HTML (`<div>` and `<br>`), also when `message_format` is `text`, so a read after the write can differ from the submitted body.

    PUT /sequences/{id}/follow-ups/{follow_up_id}

  • Destructive

    Delete a sequence follow-up step

    Delete a sequence follow-up step

    DELETE /sequences/{id}/follow-ups/{follow_up_id}

  • Destructive

    Remove sequence recipients

    Remove sequence recipients

    DELETE /sequences/{id}/recipients

  • Destructive

    Pause a sequence

    Pause a sequence

    POST /sequences/{sequence_id}/pause

  • Destructive

    Archive a sequence

    Archive a sequence

    POST /sequences/{sequence_id}/archive

Multi-Domain Search

  • Read

    Multi-domain search

    Search professional email addresses across many companies at once using a structured filter set. Returns masked rows — no email address or phone number; use the reveal endpoint to unmask. This masked survey operation is free. At least one filter is required. Filters may be sent in the request body (JSON or form-encoded) or as query-string parameters; the body is therefore optional.

    POST /multi-domain-search

Leads

  • Read

    List leads

    Each lead carries `department` since HUN-23171. It was already a filter on this endpoint, but was never emitted, so a caller could filter on a field it could not read back. When the person behind a lead has asked Hunter to delete their address, with a claim or a California DROP request, the lead is returned without it: `email`, `confidence_score`, `verification.date` and `verification.status` are null (HUN-23599). A manually claimed phone number, or one covered by DROP, is returned as `phone_number: null`. The phone is also withheld when screening is unavailable; the lead and its other contact details remain. Filter by sequence with `sequence_ids[]`. The former name `campaign_ids[]` is still accepted as an alias; when both are sent, `sequence_ids[]` is used (HUN-20893).

    GET /leads

  • Read

    Get a lead

    Returns `department` since HUN-23171. It was filterable on the collection endpoint and settable by enrichment before that, but never emitted, so a caller could filter on a field it could not read back. When the person behind a lead has asked Hunter to delete their address, with a claim or a California DROP request, the lead is returned without it: `email`, `confidence_score`, `verification.date` and `verification.status` are null (HUN-23599). A manually claimed phone number, or one covered by DROP, is returned as `phone_number: null`. The phone is also withheld when screening is unavailable; the lead and its other contact details remain.

    GET /leads/{id}

  • Read

    Check whether a lead exists

    Check whether a lead exists

    GET /leads/exist

  • Read

    Check whether leads exist in bulk

    Check whether leads exist in bulk

    GET /leads/bulk/exist

  • Read

    List lead custom attributes

    List lead custom attributes

    GET /leads_custom_attributes

  • Read

    Get a lead custom attribute

    Get a lead custom attribute

    GET /leads_custom_attributes/{id}

  • Write

    Create a lead

    A manually claimed phone number, or one covered by DROP, is returned as `phone_number: null`. The phone is also withheld when screening is unavailable; the lead and its other contact details remain. Creates a lead, or adds an existing lead to the requested lists. When an `email` matches a lead already on your team, the request is additive: it adds only the missing list memberships and returns 201 rather than an email duplicate error. When the matched lead belongs to a teammate, the request still adds it to your lists, and the teammate's lead itself is only updated if you have permission to edit it. A request without an `email` is never matched by email — it does not reuse an existing email-less lead — though a lead with an identical name, company, and list is still rejected as a duplicate. Accepts `department` since HUN-23171, normalized to its canonical key so a localized display label ("Sales") is stored as `sales`. Lead attributes are not modelled field-by-field in this contract yet — the response uses the generic resource envelope — so this note is where the accepted set is recorded. When another request is creating leads for the team, returns 409 with `lead_creation_in_progress` and `Retry-After: 1`. Retry the request after one second.

    POST /leads

  • Write

    Upsert a lead

    A manually claimed phone number, or one covered by DROP, is returned as `phone_number: null`. The phone is also withheld when screening is unavailable; the lead and its other contact details remain. Accepts `department`, normalized to its canonical key so a localized display label ("Sales") is stored as `sales`. This operation keeps its own allowlist, separate from the one `createLead` uses, so the two can differ — it does not currently accept `company_type`, `lead_country_code`, `lead_city` or `lead_state`. When creating a new lead while another request is creating leads for the team, returns 409 with `lead_creation_in_progress` and `Retry-After: 1`. Retry the request after one second. Existing leads can still be updated.

    PUT /leads

  • Write

    Update a lead

    Accepts `department` since HUN-23171. The value is normalized to its canonical key, so a localized display label ("Sales") is stored as `sales`. Lead attributes are not modelled field-by-field in this contract yet — the response uses the generic resource envelope — so this note is where the accepted set is recorded.

    PATCH /leads/{id}

  • Write

    Upsert leads in bulk

    Create or update up to 100 leads in one call. Each lead is matched on `email` and written in its own transaction, so one invalid lead does not cancel the others. The team's lead limit is checked for each new lead using the current committed lead count. If an item would exceed that limit, earlier successful items remain saved and that item returns a `leads_limit_reached` error. If another request is creating leads for the team, the new lead's item returns `status: failed` with error `lead_creation_in_progress` and code 409. Retry only those failed items after one second; other items still run normally. The response is always 200: read `status` and `errors` of each result to know what happened to each lead. The call is free and consumes no request. When the person behind a lead has asked Hunter to delete their address, with a claim or a California DROP request, the lead is returned without it: `email`, `confidence_score`, `verification.date` and `verification.status` are null (HUN-23599). A manually claimed phone number, or one covered by DROP, is returned as `phone_number: null`. The phone is also withheld when screening is unavailable; the lead and its other contact details remain.

    PUT /leads/bulk

  • Write

    Tag a lead

    Tag a lead

    POST /leads/{id}/tags

  • Write

    Enrich a lead

    A manually claimed phone number, or one covered by DROP, is returned as `phone_number: null`. The phone is also withheld when screening is unavailable; the lead and its other contact details remain.

    POST /leads/{id}/enrich

  • Write

    Create a lead custom attribute

    Create a lead custom attribute

    POST /leads_custom_attributes

  • Write

    Update a lead custom attribute

    Update a lead custom attribute

    PATCH /leads_custom_attributes/{id}

  • Write

    Create a leads import from CSV data

    Creates a draft leads import and returns its id, the guessed column matching, and a configuration_url. This call does not import anything: a person must open that URL in a browser and complete the mapping step before any lead is created. It is intended for clients that can hand off to a browser session, not for unattended automation. csv_data must be sent in the request body; it is rejected in the query string, where it would reach access logs verbatim.

    POST /leads-imports

  • Destructive

    Replace a lead

    Accepts `department` since HUN-23171. The value is normalized to its canonical key, so a localized display label ("Sales") is stored as `sales`. Lead attributes are not modelled field-by-field in this contract yet — the response uses the generic resource envelope — so this note is where the accepted set is recorded.

    PUT /leads/{id}

  • Destructive

    Delete a lead

    Delete a lead

    DELETE /leads/{id}

  • Destructive

    Move leads to another list in bulk

    Move leads to another list in bulk

    POST /leads/bulk/move

  • Destructive

    Delete leads in bulk

    Delete leads in bulk

    POST /leads/bulk/delete

  • Destructive

    Remove a tag from a lead

    Remove a tag from a lead

    DELETE /leads/{id}/tags/{tag_id}

  • Destructive

    Replace a lead custom attribute

    Replace a lead custom attribute

    PUT /leads_custom_attributes/{id}

  • Destructive

    Delete a lead custom attribute

    Delete a lead custom attribute

    DELETE /leads_custom_attributes/{id}

Companies

  • Read

    List saved companies

    List saved companies

    GET /companies

  • Read

    Get a saved company

    Get a saved company

    GET /companies/{id}

  • Write

    Save a company

    Save a company

    POST /companies

  • Write

    Copy companies to another list in bulk

    Copy companies to another list in bulk

    POST /companies/bulk/copy

  • Write

    Tag companies in bulk

    Tag companies in bulk

    POST /companies/bulk/tag

  • Write

    Tag a saved company

    Tag a saved company

    POST /companies/{id}/tags

  • Destructive

    Delete a saved company

    Delete a saved company

    DELETE /companies/{id}

  • Destructive

    Move companies to another list in bulk

    Move companies to another list in bulk

    POST /companies/bulk/move

  • Destructive

    Delete companies in bulk

    Delete companies in bulk

    POST /companies/bulk/delete

  • Destructive

    Remove a tag from a saved company

    Remove a tag from a saved company

    DELETE /companies/{id}/tags/{tag_id}

Lists

  • Read

    List lead lists

    Each list includes `leads_list_folder_id`: the ID of the folder that holds the list, or null when the list is unfiled (HUN-24761).

    GET /leads_lists

  • Read

    Get a lead list

    When the person behind a lead has asked Hunter to delete their address, with a claim or a California DROP request, the lead is returned without it: `email`, `confidence_score`, `verification.date` and `verification.status` are null (HUN-23599). The list includes `leads_list_folder_id`, or null when the list is unfiled (HUN-24761).

    GET /leads_lists/{id}

  • Read

    List lead list folders

    List lead list folders

    GET /leads_lists/folders

  • Read

    Get a lead list folder

    Get a lead list folder

    GET /leads_lists/folders/{id}

  • Read

    List lead lists (hyphen alias)

    Each list includes `leads_list_folder_id`: the ID of the folder that holds the list, or null when the list is unfiled (HUN-24761).

    GET /leads-lists

  • Read

    Get a lead list (hyphen alias)

    When the person behind a lead has asked Hunter to delete their address, with a claim or a California DROP request, the lead is returned without it: `email`, `confidence_score`, `verification.date` and `verification.status` are null (HUN-23599). The list includes `leads_list_folder_id`, or null when the list is unfiled (HUN-24761).

    GET /leads-lists/{id}

  • Read

    List lead list folders (hyphen alias)

    List lead list folders (hyphen alias)

    GET /leads-lists/folders

  • Read

    Get a lead list folder (hyphen alias)

    Get a lead list folder (hyphen alias)

    GET /leads-lists/folders/{id}

  • Read

    List company lists

    List company lists

    GET /company-lists

  • Read

    Get a company list

    Get a company list

    GET /company-lists/{id}

  • Read

    List company list folders

    List company list folders

    GET /company-lists/folders

  • Read

    Get a company list folder

    Get a company list folder

    GET /company-lists/folders/{id}

  • Read

    Find lookalike companies from a company list or a domain

    Finds companies that look like the ones in one of your company lists, or like one company given by its domain. The seed companies are excluded, and we return the most similar companies ranked by a similarity score. This endpoint is not paginated: it returns a single ranked page of the top limit results, so the offset parameter is not supported and returns 400 if supplied. This call is free.

    GET /lookalikes

  • Write

    Create a lead list

    An optional `leads_list_folder_id` creates the list inside that folder. A folder of another team returns a 422. The response includes `leads_list_folder_id` (HUN-24761). Creates a static list, or a dynamic list when `type` is `dynamic`. A dynamic list saves `filters` in the vocabulary of GET /v2/leads and holds every lead that matches them. Its `leads_count` in the response is already the number of matching leads (HUN-24762).

    POST /leads_lists

  • Write

    Create a lead list folder

    When `color` is omitted the folder gets a random color from the palette's vivid swatches.

    POST /leads_lists/folders

  • Write

    Update a lead list folder

    Update a lead list folder

    PATCH /leads_lists/folders/{id}

  • Write

    Favorite a lead list

    Favorite a lead list

    POST /leads_lists/{id}/favorite

  • Write

    Create a lead list (hyphen alias)

    An optional `leads_list_folder_id` creates the list inside that folder. A folder of another team returns a 422. The response includes `leads_list_folder_id` (HUN-24761). Creates a static list, or a dynamic list when `type` is `dynamic`. A dynamic list saves `filters` in the vocabulary of GET /v2/leads and holds every lead that matches them. Its `leads_count` in the response is already the number of matching leads (HUN-24762).

    POST /leads-lists

  • Write

    Create a lead list folder (hyphen alias)

    When `color` is omitted the folder gets a random color from the palette's vivid swatches.

    POST /leads-lists/folders

  • Write

    Update a lead list folder (hyphen alias)

    Update a lead list folder (hyphen alias)

    PATCH /leads-lists/folders/{id}

  • Write

    Favorite a lead list (hyphen alias)

    Favorite a lead list (hyphen alias)

    POST /leads-lists/{id}/favorite

  • Write

    Create a company list

    Create a company list

    POST /company-lists

  • Write

    Update a company list

    Update a company list

    PATCH /company-lists/{id}

  • Write

    Create a company list folder

    When `color` is omitted the folder gets a random color from the palette's vivid swatches.

    POST /company-lists/folders

  • Write

    Update a company list folder

    Update a company list folder

    PATCH /company-lists/folders/{id}

  • Write

    Favorite a company list

    Favorite a company list

    POST /company-lists/{id}/favorite

  • Write

    Add a company to a company list

    Add a company to a company list

    POST /company-lists/{id}/companies

  • Destructive

    Update a lead list

    `name` and `leads_list_folder_id` are both optional. A folder ID moves the list into that folder, and a blank `leads_list_folder_id` removes it from its folder. A folder of another team returns a 422 (HUN-24761). For a dynamic list, `filters` replaces the saved filters (HUN-24762).

    PATCH /leads_lists/{id}

  • Destructive

    Replace a lead list

    `name` and `leads_list_folder_id` are both optional. A folder ID moves the list into that folder, and a blank `leads_list_folder_id` removes it from its folder. A folder of another team returns a 422 (HUN-24761). For a dynamic list, `filters` replaces the saved filters (HUN-24762).

    PUT /leads_lists/{id}

  • Destructive

    Delete a lead list

    Delete a lead list

    DELETE /leads_lists/{id}

  • Destructive

    Replace a lead list folder

    Replace a lead list folder

    PUT /leads_lists/folders/{id}

  • Destructive

    Delete a lead list folder

    Delete a lead list folder

    DELETE /leads_lists/folders/{id}

  • Destructive

    Unfavorite a lead list

    Unfavorite a lead list

    DELETE /leads_lists/{id}/favorite

  • Destructive

    Merge lead lists

    Merge lead lists

    POST /leads_lists/{id}/merge

  • Destructive

    Update a lead list (hyphen alias)

    `name` and `leads_list_folder_id` are both optional. A folder ID moves the list into that folder, and a blank `leads_list_folder_id` removes it from its folder. A folder of another team returns a 422 (HUN-24761). For a dynamic list, `filters` replaces the saved filters (HUN-24762).

    PATCH /leads-lists/{id}

  • Destructive

    Replace a lead list (hyphen alias)

    `name` and `leads_list_folder_id` are both optional. A folder ID moves the list into that folder, and a blank `leads_list_folder_id` removes it from its folder. A folder of another team returns a 422 (HUN-24761). For a dynamic list, `filters` replaces the saved filters (HUN-24762).

    PUT /leads-lists/{id}

  • Destructive

    Delete a lead list (hyphen alias)

    Delete a lead list (hyphen alias)

    DELETE /leads-lists/{id}

  • Destructive

    Replace a lead list folder (hyphen alias)

    Replace a lead list folder (hyphen alias)

    PUT /leads-lists/folders/{id}

  • Destructive

    Delete a lead list folder (hyphen alias)

    Delete a lead list folder (hyphen alias)

    DELETE /leads-lists/folders/{id}

  • Destructive

    Unfavorite a lead list (hyphen alias)

    Unfavorite a lead list (hyphen alias)

    DELETE /leads-lists/{id}/favorite

  • Destructive

    Merge lead lists (hyphen alias)

    Merge lead lists (hyphen alias)

    POST /leads-lists/{id}/merge

  • Destructive

    Replace a company list

    Replace a company list

    PUT /company-lists/{id}

  • Destructive

    Delete a company list

    Delete a company list

    DELETE /company-lists/{id}

  • Destructive

    Replace a company list folder

    Replace a company list folder

    PUT /company-lists/folders/{id}

  • Destructive

    Delete a company list folder

    Delete a company list folder

    DELETE /company-lists/folders/{id}

  • Destructive

    Unfavorite a company list

    Unfavorite a company list

    DELETE /company-lists/{id}/favorite

  • Destructive

    Remove a company from a company list

    Remove a company from a company list

    DELETE /company-lists/{id}/companies/{company_id}

Tags

  • Read

    List lead tags

    List lead tags

    GET /tags

  • Read

    Get a lead tag

    Get a lead tag

    GET /tags/{id}

  • Read

    List company tags

    List company tags

    GET /company-tags

  • Read

    Get a company tag

    Get a company tag

    GET /company-tags/{id}

  • Write

    Create a lead tag

    Create a lead tag

    POST /tags

  • Write

    Update a lead tag

    Update a lead tag

    PATCH /tags/{id}

  • Write

    Create a company tag

    Create a company tag

    POST /company-tags

  • Write

    Update a company tag

    Update a company tag

    PATCH /company-tags/{id}

  • Destructive

    Replace a lead tag

    Replace a lead tag

    PUT /tags/{id}

  • Destructive

    Delete a lead tag

    Delete a lead tag

    DELETE /tags/{id}

  • Destructive

    Replace a company tag

    Replace a company tag

    PUT /company-tags/{id}

  • Destructive

    Delete a company tag

    Delete a company tag

    DELETE /company-tags/{id}

Feedback

  • Write

    Submit product feedback

    Submit product feedback

    POST /feedback

Views

  • Read

    List saved discover views

    List saved discover views

    GET /discover/views

  • Read

    Get a saved discover view

    Get a saved discover view

    GET /discover/views/{id}

  • Write

    Create a saved discover view

    Create a saved discover view

    POST /discover/views

  • Destructive

    Delete a saved discover view

    Delete a saved discover view

    DELETE /discover/views/{id}

Templates

  • Read

    List message templates

    List message templates

    GET /message-templates

  • Read

    Get a message template

    Get a message template

    GET /message-templates/{id}

  • Write

    Create a message template

    A `body` in plain text or HTML keeps its line breaks and paragraphs. It is stored as the editor's HTML (`<div>` and `<br>`), also when `message_format` is `text`, so a read after the write can differ from the submitted body.

    POST /message-templates

  • Write

    Update a message template

    A `body` in plain text or HTML keeps its line breaks and paragraphs. It is stored as the editor's HTML (`<div>` and `<br>`), also when `message_format` is `text`, so a read after the write can differ from the submitted body.

    PATCH /message-templates/{id}

  • Destructive

    Replace a message template

    A `body` in plain text or HTML keeps its line breaks and paragraphs. It is stored as the editor's HTML (`<div>` and `<br>`), also when `message_format` is `text`, so a read after the write can differ from the submitted body.

    PUT /message-templates/{id}

  • Destructive

    Delete a message template

    Delete a message template

    DELETE /message-templates/{id}

Messages

  • Read

    List messages

    Each message embeds the lead at its contact address. When that person has asked Hunter to delete their address, with a claim or a California DROP request, the address is left out: an outgoing message's `to` is null, and so are the lead's `email`, `confidence_score`, `verification.date` and `verification.status` (HUN-23599). The `message.*` webhooks leave it out the same way.

    GET /messages

  • Write

    Send a one-off message

    The sender must be available for outreach to the authenticated user. On the Free plan, extra or SMTP accounts retained only for Inbox Protection cannot send one-off messages. Selecting one returns 422 with error ID email_account_not_found.

    POST /messages

Webhooks

  • Read

    List webhooks

    List webhooks

    GET /webhooks

  • Read

    Get a webhook

    Get a webhook

    GET /webhooks/{id}

  • Write

    Create a webhook

    Create a webhook

    POST /webhooks

  • Write

    Update a webhook

    Update a webhook

    PATCH /webhooks/{id}

  • Destructive

    Delete webhooks by identifier (legacy)

    Delete webhooks by identifier (legacy)

    DELETE /webhooks

  • Destructive

    Replace a webhook

    Replace a webhook

    PUT /webhooks/{id}

  • Destructive

    Delete a webhook

    Delete a webhook

    DELETE /webhooks/{id}

API Keys

  • Read

    List API keys

    List API keys

    GET /api-keys

  • Write

    Create an API key

    Create an API key

    POST /api-keys

  • Write

    Update an API key

    Update an API key

    PATCH /api-keys/{id}

  • Destructive

    Replace an API key

    Replace an API key

    PUT /api-keys/{id}

  • Destructive

    Delete an API key

    Delete an API key

    DELETE /api-keys/{id}

Logos

  • Read

    Get a company logo

    Returns the company logo image by domain as PNG, WEBP or AVIF; this is not a JSON response.

    GET /{domain}

See How connections work for access and permissions, or browse all integrations.