Topolo Docs Topolo Platform
Open workspace

List broadcasts

List the broadcasts in the caller's Nurture workspace, newest change first, optionally filtered by status (draft, pending_approval, approved, scheduled, sending, sent, cancelled, failed, archived).

Outcome

List the broadcasts in the caller's Nurture workspace, newest change first, optionally filtered by status (draft, pending_approval, approved, scheduled, sending, sent, cancelled, failed, archived).

Before you start

  • Verify identity and pin the intended organization and environment before discovering the action.
  • Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
  • Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.broadcasts.list --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json

Request

GET /api/broadcasts

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

FieldRequiredTypeConstraints
statusOptionalstring{"enum":["draft","pending_approval","approved","scheduled","sending","sent","cancelled","failed","archived"]}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "pending_approval",
        "approved",
        "scheduled",
        "sending",
        "sent",
        "cancelled",
        "failed",
        "archived"
      ]
    }
  },
  "additionalProperties": false
}

Effects

  • Reads broadcasts without changing state.

Interpret the response

The returned identifier path is $.broadcasts[].id for broadcast. Empty lists do not discover a target.

Confirm each broadcast belongs to the selected workspace.

Exact success schema:

{
  "type": "object",
  "required": [
    "broadcasts"
  ],
  "properties": {
    "broadcasts": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "status",
          "topicId",
          "segmentIds",
          "schedule"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "templateId": {
            "type": [
              "string",
              "null"
            ]
          },
          "templateVersion": {
            "type": [
              "integer",
              "null"
            ]
          },
          "topicId": {
            "type": "string"
          },
          "segmentIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "purpose": {
            "type": "string",
            "enum": [
              "marketing"
            ]
          },
          "schedule": {
            "type": "object",
            "required": [
              "mode"
            ],
            "properties": {
              "mode": {
                "type": "string",
                "enum": [
                  "now",
                  "at",
                  "recipient_local"
                ]
              }
            }
          },
          "throttlePerHour": {
            "type": [
              "integer",
              "null"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "pending_approval",
              "approved",
              "scheduled",
              "sending",
              "sent",
              "cancelled",
              "failed",
              "archived"
            ]
          },
          "launchAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "totalRecipients": {
            "type": [
              "integer",
              "null"
            ]
          },
          "createdBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "submittedBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "submittedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "approvedBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "approvedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "rejectedBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "rejectedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "rejectionReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "scheduledBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "scheduledAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "launchedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "completedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "cancelledBy": {
            "type": [
              "string",
              "null"
            ]
          },
          "cancelledAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "cancelReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "failureReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "legacy": {
            "type": [
              "object",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "status": "draft"
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.list --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.broadcasts.list",
    "input": {
      "status": "draft"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "broadcasts": [
    {
      "id": "bc_37e98ed76c9e40798462f980530410ae",
      "name": "Renamed",
      "templateId": null,
      "templateVersion": null,
      "topicId": "topic_7882fdbc77614457b384744e81929d44",
      "segmentIds": [
        "seg_330eddbe201c4fa4a82d02c8dc9f4cbb"
      ],
      "purpose": "marketing",
      "schedule": {
        "mode": "recipient_local",
        "date": "2026-10-05",
        "time": "09:00",
        "fallbackTimezone": "Europe/Paris"
      },
      "throttlePerHour": null,
      "status": "draft",
      "launchAt": null,
      "totalRecipients": null,
      "createdBy": "u1",
      "submittedBy": null,
      "submittedAt": null,
      "approvedBy": null,
      "approvedAt": null,
      "rejectedBy": null,
      "rejectedAt": null,
      "rejectionReason": null,
      "scheduledBy": null,
      "scheduledAt": null,
      "launchedAt": null,
      "completedAt": null,
      "cancelledBy": null,
      "cancelledAt": null,
      "cancelReason": null,
      "failureReason": null,
      "legacy": null,
      "createdAt": "2026-10-04T00:32:37.364Z",
      "updatedAt": "2026-10-04T00:32:37.428Z"
    },
    {
      "id": "bc_82c5b54ee5c643a484136599a3ceda2a",
      "name": "X",
      "templateId": null,
      "templateVersion": null,
      "topicId": "topic_7882fdbc77614457b384744e81929d44",
      "segmentIds": [
        "seg_330eddbe201c4fa4a82d02c8dc9f4cbb"
      ],
      "purpose": "marketing",
      "schedule": {
        "mode": "now"
      },
      "throttlePerHour": null,
      "status": "draft",
      "launchAt": null,
      "totalRecipients": null,
      "createdBy": "u1",
      "submittedBy": null,
      "submittedAt": null,
      "approvedBy": null,
      "approvedAt": null,
      "rejectedBy": null,
      "rejectedAt": null,
      "rejectionReason": null,
      "scheduledBy": null,
      "scheduledAt": null,
      "launchedAt": null,
      "completedAt": null,
      "cancelledBy": null,
      "cancelledAt": null,
      "cancelReason": null,
      "failureReason": null,
      "legacy": null,
      "createdAt": "2026-10-04T00:32:37.419Z",
      "updatedAt": "2026-10-04T00:32:37.419Z"
    }
  ]
}

HTTP 200. Confirm each broadcast belongs to the selected workspace.

Another supported request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "status": "sent"
}

CLI:

topolo actions validate app_topolo_nurture.broadcasts.list --data @payload.json --json
topolo actions plan app_topolo_nurture.broadcasts.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.broadcasts.list --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.broadcasts.list",
    "input": {
      "status": "sent"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "broadcasts": []
}

HTTP 200. Confirm each broadcast belongs to the selected workspace.

Verify the result

  • Confirm each broadcast belongs to the selected workspace.

Errors and recovery

  • organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
  • permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
  • workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
  • invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

This action does not change service state.

  • Get broadcast: Read one broadcast with its template pin, audience, schedule, throttle, approval trail (who submitted, approved, rejected, scheduled or cancelled it, and when) and its 20 most recent test sends.
  • Create broadcast: Create a draft broadcast: a template (optionally a pinned templateVersion), a subscription topic, one to 20 segments, a schedule and an optional throttlePerHour. Purpose is always marketing. Nothing is sent; the draft must be submitted, approved by a different person, and scheduled. schedule is {mode:"now"} (default), {mode:"at", sendAt ISO-8601} or {mode:"recipient_local", date YYYY-MM-DD, time HH:MM, fallbackTimezone IANA}: recipient_local sends at that wall-clock time in each contact's own zone, using fallbackTimezone when the contact has none.

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.