Get newsletter issue — Brigg developers

Access & visibility

Allow newsletters.GetNewsletterIssue on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

issue_idstringRequired

Use issue_id from the selected schedule's issues. It differs from the underlying newsletter_id. newsletters.ListNewsletterIssues.

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 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 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.

issue_idstringRequired

Issue identifier.

schedule_idstringRequired

Schedule identifier.

newsletter_idstringRequired

Newsletter identifier.

numberintegerRequired

Issue number within this newsletter series.

statusstringRequired

Current state reported for this item. Treat values as extensible unless an enum is declared.

Allowed: "generating", "ready", "sent", "failed".

scheduled_forintegerRequired

Time the issue was scheduled for preparation, in Unix milliseconds.

review_urlstringRequired

Brigg URL for reviewing this newsletter; it does not send the issue.

Format: uri.

next_actionstring or nullRequired

Next step needed for this issue. Manual issues must be reviewed and sent in Brigg.

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 and safe retries and limits.

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

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "issue_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use issue_id from the selected schedule's issues. It differs from the underlying newsletter_id. [newsletters.ListNewsletterIssues](/reference/newsletters/ListNewsletterIssues)."
    }
  },
  "required": [
    "issue_id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "issue_id": "e_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "issue_id": {
      "type": "string",
      "description": "Issue identifier."
    },
    "schedule_id": {
      "type": "string",
      "description": "Schedule identifier."
    },
    "newsletter_id": {
      "type": "string",
      "description": "Newsletter identifier."
    },
    "number": {
      "type": "integer",
      "description": "Issue number within this newsletter series."
    },
    "status": {
      "type": "string",
      "enum": [
        "generating",
        "ready",
        "sent",
        "failed"
      ],
      "description": "Current state reported for this item. Treat values as extensible unless an enum is declared."
    },
    "scheduled_for": {
      "type": "integer",
      "description": "Time the issue was scheduled for preparation, in Unix milliseconds."
    },
    "review_url": {
      "type": "string",
      "format": "uri",
      "description": "Brigg URL for reviewing this newsletter; it does not send the issue."
    },
    "next_action": {
      "type": [
        "string",
        "null"
      ],
      "enum": [
        "review_and_send",
        "review_failure",
        null
      ],
      "description": "Next step needed for this issue. Manual issues must be reviewed and sent in Brigg."
    }
  },
  "required": [
    "issue_id",
    "schedule_id",
    "newsletter_id",
    "number",
    "status",
    "scheduled_for",
    "review_url",
    "next_action"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "issue_id": "e_example",
      "schedule_id": "e_example",
      "newsletter_id": "e_example",
      "number": 1,
      "status": "generating",
      "scheduled_for": 1,
      "review_url": "https://brigg.app/settings",
      "next_action": "review_and_send"
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

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

Request

cURL

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

TypeScript

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

Python

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

payload = {
  "issue_id": "e_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.GetNewsletterIssue",
    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

cURL

curl 'https://api.brigg.app/v1/operations/newsletters.GetNewsletterIssue' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{
  "issue_id": "e_example"
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

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

Python

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

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

200 OK Response example

{
  "issue_id": "e_example",
  "schedule_id": "e_example",
  "newsletter_id": "e_example",
  "number": 1,
  "status": "generating",
  "scheduled_for": 1,
  "review_url": "https://brigg.app/settings",
  "next_action": "review_and_send"
}

Illustrative values, not a live response.