# List campaign

URL: https://docs.hanzo.ai/docs/openapi/campaign/get-campaign

> Returns the org's campaigns, newest first, optionally narrowed to one status.

`GET /v1/campaign`

> [Campaign →](https://docs.hanzo.ai/docs/openapi/campaign) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/campaign`     |
| **Method**    | `GET`                                  |
| **Operation** | `get_campaign`                         |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

Returns the org's campaigns, newest first, optionally narrowed to
one status.

A campaign is the top-level go-to-market object: a value that SPANS channels
(paid, organic, email) and fans out to the executor for each. The listing is
org-scoped server-side, so one org can never see another's campaigns.

## Request

2 fields.

| Field    | In    | Type    | Required | Description                                                               |
| -------- | ----- | ------- | -------- | ------------------------------------------------------------------------- |
| `status` | query | string  | —        | Status keeps only campaigns in that state: draft, live, paused or failed. |
| `limit`  | query | integer | —        | Limit bounds the page.                                                    |

## Response

| Status    | Body                  | Meaning |
| --------- | --------------------- | ------- |
| `200`     | campaign.campaignPage | ok      |
| `default` | problem-details       | refused |

`200` body — 17 fields.

| Field                          | In   | Type                       | Always | Description                                                                                                                                                                                     |
| ------------------------------ | ---- | -------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data`                         | body | campaign.campaignRecord\[] | —      | Data are the campaigns on this page.                                                                                                                                                            |
| `data[].audience`              | body | string                     | —      | Audience is an opaque reference to the segment this campaign targets.                                                                                                                           |
| `data[].budget`                | body | integer (int64)            | —      | Budget is the campaign's total budget in CENTS, handed to each executor as the budget for its channel.                                                                                          |
| `data[].channels`              | body | campaign.ChannelSpec\[]    | —      | Channels are the fan-out targets, at most one per kind and at most 12, each carrying its own post-launch state.                                                                                 |
| `data[].channels[].account`    | body | string                     | —      | Account is the provider account this channel runs under: an ad-account, a page or a mailing-list id.                                                                                            |
| `data[].channels[].detail`     | body | string                     | —      | Detail is the last outcome in one secret-free line — the failure reason, or what the executor reported.                                                                                         |
| `data[].channels[].externalId` | body | string                     | —      | ExternalID is the provider-side id of the running execution, recorded by the orchestrator at launch and handed back verbatim to read spend or to pause.                                         |
| `data[].channels[].kind`       | body | string                     | —      | Kind is the channel and the identity a campaign holds at most one of: paid, organic or email.                                                                                                   |
| `data[].channels[].platform`   | body | string                     | —      | Platform is the provider within the kind — meta, google, x, instagram, or the email provider.                                                                                                   |
| `data[].channels[].status`     | body | string                     | —      | Status is this channel's own launch outcome, not the campaign's: pending (added, never launched), live, paused, failed (Detail says why) or unavailable (no executor wired on this deployment). |
| `data[].content`               | body | string\[]                  | —      | Content is the ordered creative set, at most 32, empty entries dropped.                                                                                                                         |
| `data[].createdAt`             | body | integer (int64)            | —      | CreatedAt is when the campaign was created, in unix seconds.                                                                                                                                    |
| `data[].id`                    | body | string                     | —      | ID is the campaign's server-minted handle — "cmp\_" and 128 random bits — and the id every other campaign call is addressed by.                                                                 |
| `data[].name`                  | body | string                     | —      | Name is the campaign's display name.                                                                                                                                                            |
| `data[].scheduleAt`            | body | integer (int64)            | —      | ScheduleAt is when the campaign should run, in unix seconds.                                                                                                                                    |
| `data[].status`                | body | string                     | —      | Status is the lifecycle state, server-owned and never accepted from a caller.                                                                                                                   |
| `data[].updatedAt`             | body | integer (int64)            | —      | UpdatedAt is the last write in unix seconds — an edit, a launch or a pause.                                                                                                                     |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo campaign list
```

**SDK**

**.ts**

```ts
import { Configuration, CampaignApi } from 'hanzoai';

const api = new CampaignApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCampaign();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CampaignApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CampaignApi(client).get_campaign()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.CampaignAPI.GetCampaign(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, campaign_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = campaign_api::get_campaign(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CampaignApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new CampaignApi(client).getCampaign();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/campaign \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **campaign** through the `campaign` tool, which names its 9 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
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_campaigns"
         }
       }
     }'
```

---

[Campaign API](https://docs.hanzo.ai/docs/openapi/campaign) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
