List newsletter schedules — Brigg developers

Access & visibility

Allow newsletters.ListNewsletterSchedules 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

No parameters. Send an empty JSON object ({}).

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.

This operation has no continuation cursor. An empty items array means no matching visible results were returned.

itemsarray of Newsletter scheduleRequired

Newsletter schedules in the workspace, including paused schedules. This operation has no cursor pagination.

Item fields

schedule_idstringRequired

Schedule ID used to read, update or list the schedule's issues.

namestringRequired

Display name of the newsletter schedule.

frequencystringRequired

Recurring preparation cadence: weekly is every week, biweekly is every two weeks, monthly is every month in the schedule’s time zone.

timezonestringRequired

IANA time zone, for example Europe/Oslo.

next_run_atinteger or nullRequired

Next planned preparation slot in Unix milliseconds, or null when no slot is scheduled, including while paused. It is not an email-send timestamp.

pausedbooleanRequired

Whether new scheduled issue generation is paused. Existing issues remain available.

approvalstringRequired

Approval policy for generated issues. Public API schedules require manual review and sending in Brigg.

Allowed: "manual", "automatic".

review_urlstringRequired

Open the schedule in Brigg to review its setup and issues.

Format: uri.

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": {},
  "additionalProperties": false,
  "examples": [
    {}
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "schedule_id": {
            "type": "string",
            "description": "Schedule ID used to read, update or list the schedule's issues.",
            "examples": [
              "schedule_customer_updates"
            ]
          },
          "name": {
            "type": "string",
            "description": "Display name of the newsletter schedule.",
            "examples": [
              "Customer updates"
            ]
          },
          "frequency": {
            "type": "string",
            "description": "Recurring preparation cadence: weekly is every week, biweekly is every two weeks, monthly is every month in the schedule’s time zone.",
            "examples": [
              "monthly"
            ]
          },
          "timezone": {
            "type": "string",
            "description": "IANA time zone, for example Europe/Oslo."
          },
          "next_run_at": {
            "type": [
              "integer",
              "null"
            ],
            "description": "Next planned preparation slot in Unix milliseconds, or null when no slot is scheduled, including while paused. It is not an email-send timestamp.",
            "examples": [
              1796893200000
            ]
          },
          "paused": {
            "type": "boolean",
            "description": "Whether new scheduled issue generation is paused. Existing issues remain available.",
            "examples": [
              false
            ]
          },
          "approval": {
            "type": "string",
            "enum": [
              "manual",
              "automatic"
            ],
            "description": "Approval policy for generated issues. Public API schedules require manual review and sending in Brigg.",
            "examples": [
              "manual"
            ]
          },
          "review_url": {
            "type": "string",
            "format": "uri",
            "description": "Open the schedule in Brigg to review its setup and issues.",
            "examples": [
              "https://example.com/newsletters/schedule_customer_updates"
            ]
          }
        },
        "required": [
          "schedule_id",
          "name",
          "frequency",
          "timezone",
          "next_run_at",
          "paused",
          "approval",
          "review_url"
        ],
        "additionalProperties": false,
        "title": "Newsletter schedule"
      },
      "description": "Newsletter schedules in the workspace, including paused schedules. This operation has no cursor pagination."
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "items": [
        {
          "schedule_id": "schedule_customer_updates",
          "name": "Customer updates",
          "frequency": "monthly",
          "timezone": "Europe/Oslo",
          "next_run_at": 1796893200000,
          "paused": false,
          "approval": "manual",
          "review_url": "https://example.com/newsletters/schedule_customer_updates"
        }
      ]
    }
  ]
}

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.ListNewsletterSchedules' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{}'

TypeScript

const response = await fetch("https://api.brigg.app/v1/operations/newsletters.ListNewsletterSchedules", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
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 = {}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.ListNewsletterSchedules",
    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.ListNewsletterSchedules' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  --data-raw '{}'

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.ListNewsletterSchedules", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
  },
  body: JSON.stringify({}),
});
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 = {}
request = Request(
    "https://api.brigg.app/v1/operations/newsletters.ListNewsletterSchedules",
    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

{
  "items": [
    {
      "schedule_id": "schedule_customer_updates",
      "name": "Customer updates",
      "frequency": "monthly",
      "timezone": "Europe/Oslo",
      "next_run_at": 1796893200000,
      "paused": false,
      "approval": "manual",
      "review_url": "https://example.com/newsletters/schedule_customer_updates"
    }
  ]
}

Illustrative values, not a live response.