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

Customer.io Campaigns API

Retrieve information about campaigns, campaign actions, and campaign metrics in your workspace.

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

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against 2 base URLs: https://api.customer.io/v1, https://api-eu.customer.io/v1.

4 operations 4 paths 2 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://track.customer.io
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Customer.io Campaigns API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token authentication using your App API key. Pass the key in the Authorization header as Bearer {appapikey}.

Paths & Operations 4

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

Campaigns 4

Retrieve information about campaigns, campaign actions, and campaign metrics in your workspace.

GET
/campaigns
List campaigns
listCampaigns → 200401
GET
/campaigns/{campaign_id}
Get a campaign
getCampaign 1 param → 200401404
GET
/campaigns/{campaign_id}/actions
List campaign actions
listCampaignActions 1 param → 200401404
GET
/campaigns/{campaign_id}/metrics
Get campaign metrics
getCampaignMetrics 4 params → 200401404

Schemas 2

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

CampaignAction
object
An action (workflow step) within a campaign.
7 properties
Campaign
object
A messaging campaign in Customer.io.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

customer-io-campaigns-api-openapi.yml Raw ↑

Other APIs Customer.io publishes across the network.

Customer.io Track API
Customer.io Activities API
Customer.io Alias API
Customer.io Batch API
Customer.io Broadcasts API
Customer.io Collections API
Customer.io Customers API
Customer.io Devices API
Customer.io Entity API
Customer.io Events API
Customer.io Exports API
Customer.io Group API