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

EmailOctopus Campaign API

The Campaign API from EmailOctopus — 5 operation(s) for campaign.

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. 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 5 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

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

5 operations 5 paths 5 schemas 5 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://api.emailoctopus.com
Authentication
HTTP Bearer
Terms of Service
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 — Bearer API key in the Authorization header. Create a 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
GET
/campaigns
Get all campaigns
getAllCampaigns 2 params → 200
GET
/campaigns/{campaign_id}
Get campaign
getCampaign 1 param → 200
GET
/campaigns/{campaign_id}/reports/summary
Campaign summary report
getCampaignSummaryReport 1 param → 200
GET
/campaigns/{campaign_id}/reports/links
Campaign links report
getCampaignLinksReport 3 params → 200
GET
/campaigns/{campaign_id}/reports
Campaign contact reports
getCampaignContactReports 4 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Campaign (9 properties), Contact (7 properties), CampaignSummaryReport (7 properties), Paging (2 properties). Each schema is shown below with its type and property counts.

CampaignSummaryReport
object
A summary of a campaign's performance.
7 properties
Campaign
object
Details of a campaign.
9 properties
CampaignCollection
object
2 properties
Contact
object
Details of a contact of a list.
7 properties
Paging
object
Cursor pagination metadata.
2 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