How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

EmailOctopus Campaign API

Read campaigns and their three report projections — summary counters, per-link clicks, and per-contact engagement rows. Read-only: campaigns cannot be created, scheduled or sent through the v2 API. 5 operation(s) in the EmailOctopus v2 OpenAPI 3.1.0.

EmailOctopus Campaign API is one of 6 APIs that EmailOctopus publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaign and Email Marketing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against a single base URL, https://api.emailoctopus.com.

5 operations 5 paths 7 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.emailoctopus.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

EmailOctopus Campaign API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (api_key). By default, every request must be authenticated.

  • api_key — You can obtain your API key at https://api.emailoctopus.com/developer/api-keys/create

Paths & Operations 5

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

Campaign 5

A campaign is generally used to send a one-off, timely email to some or all of your subscribers. For example you may use a campaign to send the latest edition of your weekly newsl…

GET
/campaigns
Get all campaigns
api_campaigns_get 2 params → 200400401
GET
/campaigns/{campaign_id}
Get campaign
api_campaigns_campaign_id_get 1 param → 200400401403404
GET
/campaigns/{campaign_id}/reports
Campaign contact reports
api_campaigns_campaign_idreports_get 4 params → 200400401403404
GET
/campaigns/{campaign_id}/reports/links
Campaign links report
api_campaigns_campaign_idreportslinks_get 1 param → 200400401403404
GET
/campaigns/{campaign_id}/reports/summary
Campaign summary report
api_campaigns_campaign_idreportssummary_get 1 param → 200400401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Campaign-get (9 properties), CampaignSummaryReport (7 properties), CampaignReportContact.collection-get.report (3 properties), PagingNextResource (2 properties). Each schema is shown below with its type and property counts.

CampaignReportLink.collection-get
object
Get information on the performance of links in the campaign.
1 property
CampaignReportContact.collection-get.report
object
Get campaign contact reports.
3 properties
PagingResource
object
1 property
Campaign.collection
object
Get a collection of Campaign items.
2 properties
CampaignSummaryReport
object
Get a summary of the campaign.
7 properties
PagingNextResource
object
2 properties
Campaign-get
object
Get details of a campaign.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

emailoctopus-campaign-api-openapi.yml Raw ↑

Other APIs EmailOctopus publishes across the network.

EmailOctopus Automation API
EmailOctopus Contact API
EmailOctopus Field API
EmailOctopus List API
EmailOctopus Tag API
Where this information came from

This is an independent, third-party profile of EmailOctopus Campaign API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.