# List broadcasts

URL: https://docs.hanzo.ai/docs/openapi/marketing/get-marketing-broadcasts

> Returns the org's broadcasts, newest first.

`GET /v1/marketing/broadcasts`

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

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

Returns the org's broadcasts, newest first.

## Request

3 fields.

| Field    | In    | Type    | Required | Description                                            |
| -------- | ----- | ------- | -------- | ------------------------------------------------------ |
| `list`   | query | string  | —        | List keeps one list's broadcasts, by id or slug.       |
| `status` | query | string  | —        | Status keeps broadcasts in one status.                 |
| `limit`  | query | integer | —        | Limit is the page size, 50 by default and at most 200. |

## Response

| Status    | Body                    | Meaning |
| --------- | ----------------------- | ------- |
| `200`     | marketing.BroadcastPage | ok      |
| `default` | problem-details         | refused |

`200` body — 35 fields.

| Field                           | In   | Type                   | Always | Description                                                                                                          |
| ------------------------------- | ---- | ---------------------- | ------ | -------------------------------------------------------------------------------------------------------------------- |
| `data`                          | body | marketing.Broadcast\[] | —      | Data is the page.                                                                                                    |
| `data[].audience`               | body | integer (int64)        | —      | Audience is how many subscribers it selected when it started.                                                        |
| `data[].createdAt`              | body | integer (int64)        | —      | CreatedAt and UpdatedAt are unix seconds.                                                                            |
| `data[].error`                  | body | string                 | —      | Error is why a failed broadcast stopped.                                                                             |
| `data[].filter`                 | body | marketing.Filter       | —      |                                                                                                                      |
| `data[].filter.basis`           | body | string                 | —      | Basis keeps subscribers by the consent basis recorded for them: explicit, legitimate\_interest or unverified.        |
| `data[].filter.clickedAfter`    | body | integer (int64)        | —      | ClickedAfter keeps subscribers who clicked a link at or after this time.                                             |
| `data[].filter.confirmedAfter`  | body | integer (int64)        | —      | ConfirmedAfter and ConfirmedBefore bound when the subscription was confirmed, unix seconds, inclusive.               |
| `data[].filter.confirmedBefore` | body | integer (int64)        | —      | ConfirmedBefore is the upper bound of ConfirmedAfter's range.                                                        |
| `data[].filter.createdAfter`    | body | integer (int64)        | —      | CreatedAfter and CreatedBefore bound when the subscriber joined the list, unix seconds, inclusive.                   |
| `data[].filter.createdBefore`   | body | integer (int64)        | —      | CreatedBefore is the upper bound of CreatedAfter's range.                                                            |
| `data[].filter.field`           | body | string                 | —      | Field names a custom field, and Value keeps subscribers whose value for it is exactly this.                          |
| `data[].filter.notOpenedSince`  | body | integer (int64)        | —      | NotOpenedSince keeps subscribers who have opened nothing since this time, including those who never opened anything. |
| `data[].filter.openedAfter`     | body | integer (int64)        | —      | OpenedAfter keeps subscribers who opened a broadcast at or after this time.                                          |
| `data[].filter.q`               | body | string                 | —      | Q keeps subscribers whose address or name begins with it, case-insensitively.                                        |
| `data[].filter.ref`             | body | string                 | —      | Ref keeps subscribers from one source instance: a form id, a page, an import batch id.                               |
| `data[].filter.source`          | body | string                 | —      | Source keeps subscribers that came from this kind of source: form, page, api, import or commerce.                    |
| `data[].filter.status`          | body | string                 | —      | Status is one status or several, comma-separated: pending, subscribed, unsubscribed, bounced, complained, cleaned.   |
| `data[].filter.tag`             | body | string                 | —      | Tag keeps subscribers carrying this tag.                                                                             |
| `data[].filter.value`           | body | string                 | —      | Value is the custom field's value Field keeps.                                                                       |
| `data[].finishedAt`             | body | integer (int64)        | —      | FinishedAt is when it ended.                                                                                         |
| `data[].fromAddress`            | body | string                 | —      | FromAddress is the sender's address.                                                                                 |
| `data[].fromName`               | body | string                 | —      | FromName, FromAddress and ReplyTo override the list's sender.                                                        |
| `data[].html`                   | body | string                 | —      | HTML is the message as HTML.                                                                                         |
| `data[].id`                     | body | string                 | —      | ID is the broadcast's id ("brd\_" and 96 random bits in hex).                                                        |
| `data[].list`                   | body | string                 | —      | List is the list it goes to.                                                                                         |
| `data[].provider`               | body | string                 | —      | Provider is ses or sendgrid; empty takes the list's.                                                                 |
| `data[].replyTo`                | body | string                 | —      | ReplyTo is where replies go.                                                                                         |
| `data[].scheduledAt`            | body | integer (int64)        | —      | ScheduledAt is when it is to start, unix seconds.                                                                    |
| `data[].segment`                | body | string                 | —      | Segment narrows it to a saved segment of the list; empty is the list.                                                |
| `data[].startedAt`              | body | integer (int64)        | —      | StartedAt and FinishedAt are when sending began and ended.                                                           |
| `data[].status`                 | body | string                 | —      | Status is draft, scheduled, sending, sent, cancelled or failed.                                                      |
| `data[].subject`                | body | string                 | —      | Subject is the subject line.                                                                                         |
| `data[].text`                   | body | string                 | —      | Text is the message as plain text.                                                                                   |
| `data[].updatedAt`              | body | integer (int64)        | —      | UpdatedAt is the last change.                                                                                        |

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

## Examples

**CLI**

```bash
hanzo marketing broadcasts list
```

**SDK**

**.ts**

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

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

**.py**

```python
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_broadcasts()
```

**.go**

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

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

**.rs**

```rust
use hanzo_client::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_broadcasts(&cfg, Default::default()).await?;
```

**.java**

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

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

var result = new MarketingApi(client).getMarketingBroadcasts();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

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

**MCP**

MCP reaches **marketing** through the `marketing` tool, which names its 82 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_marketing_audiences"
         }
       }
     }'
```

---

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