OpenapiMarketing
Returns the org's campaigns, most recently updated first, optionally narrowed…
Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status.
GET /v1/marketing/campaigns
| Address | https://api.hanzo.ai/v1/marketing/campaigns |
| Method | GET |
| Operation | get_marketing_campaigns |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the org's campaigns, most recently updated first, optionally narrowed to one lifecycle status.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
status | query | string | — | Status keeps only campaigns in that lifecycle state (draft, scheduled, active, paused, completed). |
limit | query | integer | — | Limit caps the rows returned; 0 means 200 and nothing above 1000 is honoured. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | CampaignList | ok |
200 body — 11 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | Campaign[] | — | Data is the page; an empty array when the org has no matching campaign. |
data[].budget | body | integer | — | Budget is what the campaign is allowed to cost, in USD cents. |
data[].channel | body | string | — | Channel is the delivery surface: email, sms, social, meta, google or tiktok. |
data[].createdAt | body | integer | — | CreatedAt is unix seconds when the campaign was registered. |
data[].id | body | string | — | ID is the server-assigned campaign id ("camp_" + 128 random bits). |
data[].name | body | string | — | Name is the campaign's label. |
data[].objective | body | string | — | Objective is the free-text goal ("signups"), capped at 1024 bytes. |
data[].scheduledAt | body | integer | — | ScheduledAt is the unix send time; 0 means unscheduled. |
data[].spend | body | integer | — | Spend is what the campaign has cost so far, in USD cents, clamped to >= 0. |
data[].status | body | string | — | Status is the lifecycle: draft, scheduled, active, paused or completed. |
data[].updatedAt | body | integer | — | UpdatedAt is unix seconds of the last write. |
Failure carries the platform error shape — see Errors.
Examples
hanzo marketing campaigns listimport { Configuration, MarketingApi } from 'hanzoai';
const api = new MarketingApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMarketingCampaigns();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MarketingApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MarketingApi(client).get_marketing_campaigns()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.MarketingAPI.GetMarketingCampaigns(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, marketing_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = marketing_api::get_marketing_campaigns(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MarketingApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new MarketingApi(client).getMarketingCampaigns();curl https://api.hanzo.ai/v1/marketing/campaigns \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches marketing through the marketing tool, which names its 35 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_marketing_audiences"
}
}
}'How is this guide?