# List newsletter issues

List a schedule’s generated issues with their newsletter IDs, state and review links. Use the issue ID for status checks and deletion.

POST https://api.brigg.app/v1/operations/newsletters.ListNewsletterIssues

## Access & visibility

Allow `newsletters.ListNewsletterIssues` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `schedule_id` | string | Yes | Use schedule_id from the schedule listing. A schedule can produce multiple issues. [newsletters.ListNewsletterSchedules](https://developer.brigg.app/reference/newsletters/ListNewsletterSchedules). At least 1 character. |

## Preparation, review and sending are separate

A schedule produces issues. An issue has its own `issue_id`; its generated content has a separate `newsletter_id`. Read [Get newsletter issue](https://developer.brigg.app/reference/newsletters/GetNewsletterIssue) until that content and its `review_url` are available. A schedule start or run response does not mean preparation has finished.

Public callers use manual approval. A person reviews and sends the issue in Brigg; preparing content or saving a draft does not send it to the audience. [Send newsletter test email](https://developer.brigg.app/reference/newsletters/SendNewsletterTestEmail) sends a test to the acting member, not the subscriber list.

A schedule's `start_at` is Unix milliseconds and its `timezone` is an IANA zone used for recurrence. `run_now` creates an extra first issue without consuming the first scheduled slot. Pause a schedule with `paused: true` when you want to stop future preparation while retaining the schedule.

## Response

Returns **200 OK** with a JSON body.

This operation has no continuation cursor. An empty `items` array means no matching visible results were returned.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | array of [Newsletter issue](#newsletter-issue-response-items) | Yes | Issues belonging to the selected newsletter schedule. This operation has no cursor pagination. |

### Newsletter issue · response.items[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `issue_id` | string | Yes | Issue ID used to read or review this issue. |
| `schedule_id` | string | Yes | Schedule that generated this issue. |
| `newsletter_id` | string | Yes | Newsletter content ID associated with this issue. |
| `number` | integer | Yes | Issue sequence number within the schedule. |
| `status` | string | Yes | generating means content is being prepared; ready awaits review; sent has been sent; failed needs attention. Allowed: `"generating"`, `"ready"`, `"sent"`, `"failed"`. |
| `scheduled_for` | integer | Yes | Scheduled issue time in Unix milliseconds; this is not confirmation that email was sent. |
| `review_url` | string | Yes | Open this issue in Brigg to review its content and explicitly send it. Format: uri. |
| `next_action` | string or null | Yes | review_and_send requests a person's review; review_failure requests investigation; null means neither action is currently requested. Allowed: `"review_and_send"`, `"review_failure"`, `null`. |

## Errors & retries

This operation reads data. It needs no idempotency key and can be retried after a transient failure.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. |

## Next steps

- [List newsletter schedules](https://developer.brigg.app/reference/newsletters/ListNewsletterSchedules)
- [Get newsletter issue](https://developer.brigg.app/reference/newsletters/GetNewsletterIssue)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/newsletters.ListNewsletterIssues' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "schedule_id": "e_example"
}'
```

#### TypeScript


```typescript
const response = await fetch("https://api.brigg.app/v1/operations/newsletters.ListNewsletterIssues", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "schedule_id": "e_example"
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

payload = {
  "schedule_id": "e_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.ListNewsletterIssues",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "items": [
    {
      "issue_id": "issue_november",
      "schedule_id": "schedule_customer_updates",
      "newsletter_id": "newsletter_updates",
      "number": 3,
      "status": "ready",
      "scheduled_for": 1794301200000,
      "review_url": "https://example.com/newsletters/issue_november",
      "next_action": "review_and_send"
    }
  ]
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "schedule_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use schedule_id from the schedule listing. A schedule can produce multiple issues. [newsletters.ListNewsletterSchedules](https://developer.brigg.app/reference/newsletters/ListNewsletterSchedules)."
    }
  },
  "required": [
    "schedule_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "schedule_id": "e_example"
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "issue_id": {
            "type": "string",
            "description": "Issue ID used to read or review this issue.",
            "examples": [
              "issue_november"
            ]
          },
          "schedule_id": {
            "type": "string",
            "description": "Schedule that generated this issue.",
            "examples": [
              "schedule_customer_updates"
            ]
          },
          "newsletter_id": {
            "type": "string",
            "description": "Newsletter content ID associated with this issue.",
            "examples": [
              "newsletter_updates"
            ]
          },
          "number": {
            "type": "integer",
            "description": "Issue sequence number within the schedule.",
            "examples": [
              3
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "generating",
              "ready",
              "sent",
              "failed"
            ],
            "description": "generating means content is being prepared; ready awaits review; sent has been sent; failed needs attention.",
            "examples": [
              "ready"
            ]
          },
          "scheduled_for": {
            "type": "integer",
            "description": "Scheduled issue time in Unix milliseconds; this is not confirmation that email was sent.",
            "examples": [
              1794301200000
            ]
          },
          "review_url": {
            "type": "string",
            "format": "uri",
            "description": "Open this issue in Brigg to review its content and explicitly send it.",
            "examples": [
              "https://example.com/newsletters/issue_november"
            ]
          },
          "next_action": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "review_and_send",
              "review_failure",
              null
            ],
            "description": "review_and_send requests a person's review; review_failure requests investigation; null means neither action is currently requested.",
            "examples": [
              "review_and_send"
            ]
          }
        },
        "required": [
          "issue_id",
          "schedule_id",
          "newsletter_id",
          "number",
          "status",
          "scheduled_for",
          "review_url",
          "next_action"
        ],
        "additionalProperties": false,
        "title": "Newsletter issue"
      },
      "description": "Issues belonging to the selected newsletter schedule. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "issue_id": "issue_november",
          "schedule_id": "schedule_customer_updates",
          "newsletter_id": "newsletter_updates",
          "number": 3,
          "status": "ready",
          "scheduled_for": 1794301200000,
          "review_url": "https://example.com/newsletters/issue_november",
          "next_action": "review_and_send"
        }
      ]
    }
  ]
}
```