Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hunter Campaigns API

Manage email sequences and recipients.

Hunter Campaigns API is one of 12 APIs that Hunter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 1 JSON Schema.

This API exposes 5 operations across 3 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.hunter.io/v2.

5 operations 3 paths 4 schemas 1 DELETE2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.hunter.io/v2
Authentication
API Key, API Key, HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 3

Hunter Campaigns API declares 3 security schemes for authenticating requests. An API key is passed in the query as api_key (apiKeyQuery). An API key is passed in the header as X-API-KEY (apiKeyHeader). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • apiKeyQuery — API key passed as a query parameter.
  • apiKeyHeader — API key passed via the X-API-KEY header.
  • bearerAuth — API key passed as a Bearer token in the Authorization header.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Campaigns 5

Manage email sequences and recipients.

GET
/campaigns
Hunter List Campaigns
listCampaigns 4 params → 200401
GET
/campaigns/{id}/recipients
Hunter List Campaign Recipients
listCampaignRecipients 3 params → 200401404
POST
/campaigns/{id}/recipients
Hunter Add Campaign Recipients
addCampaignRecipients 1 param body → 201400401404
DELETE
/campaigns/{id}/recipients
Hunter Cancel Campaign Recipients
cancelCampaignRecipients 1 param body → 204401404
POST
/campaigns/{id}/start
Hunter Start Campaign
startCampaign 1 param → 200401404422

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Campaign (9 properties), CampaignRecipient (3 properties), PaginationMeta (3 properties), Error (1 property). Each schema is shown below with its type and property counts.

Campaign
object
9 properties
PaginationMeta
object
3 properties
CampaignRecipient
object
3 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hunter-campaigns-api-openapi.yml Raw ↑

Other APIs Hunter publishes across the network.

Hunter Account API
Hunter Combined Enrichment API
Hunter Company Enrichment API
Hunter Discover API
Hunter Domain Search API
Hunter Email Count API
Hunter Email Enrichment API
Hunter Email Finder API
Hunter Email Verifier API
Hunter Leads API
Hunter Leads Lists API