Dynamo Developer DocsDynamo Developer Docs
External APICommunityBroadcasts

List broadcasts

List organic re-engagement **broadcasts** — metadata only; insight numbers live on the per-broadcast `/insights` endpoint. Newest first.

get/broadcasts

Beta

The External API is in beta. Endpoints, parameters, and response shapes may change — including breaking changes — in future releases. Pin to documented behavior before relying on it in production.

Authorization

x-api-key x-date x-signature x-api-version
x-api-key<token>

Your API key (the ApiKeys document id).

In: header

x-date<token>

Current timestamp as an IMF-fixdate string (GMT, US locale) "EEE, dd MMM yyyy HH:mm:ss z", e.g. "Sun, 06 Dec 2020 12:59:11 GMT". 30-second TTL.

In: header

x-signature<token>

HMAC-SHA256 of the x-date string keyed by your secret, lowercase hex.

In: header

x-api-version<token>

API version you're coding against — currently 1. Required; a missing or unsupported value returns 400 with Missing or unsupported x-api-version header. Supported versions: 1.

In: header

Query Parameters

workspaceId?string

Scope to one workspace (any type — from GET /workspaces). Omit to span every workspace in the org.

type?string

Filter to a single broadcast type.

includeArchived?string

When true, also include archived (non-visible) broadcasts.

startDate?string

Send-window start (ISO date/datetime). When set, only broadcasts that sent at least once in [startDate, endDate] are returned — matched on send (execution) dates, not creation. Must be supplied together with endDate.

endDate?string

Send-window end (ISO date/datetime, inclusive). Must be supplied together with startDate.

limit?integer

Max broadcasts to return.

Response Body

application/json

application/json

application/json

application/json

Try it

read-only

Kept in this tab only and signed in your browser — your secret never leaves your device.

Query

Enter your key and secret to send.

curl -X GET "https://example.com/broadcasts"
[  {    "id": "string",    "name": "string",    "type": "SINGLE",    "target": "string",    "active": true,    "isMM": true,    "workspaceId": "string",    "mediumId": "string",    "mediumName": "string",    "scheduled": true,    "scheduledFor": "string",    "frequency": "string",    "lastSentAt": "string",    "nextSendAt": "string",    "lastExecutionId": "string",    "metaMessageCampaignName": "string",    "createdAt": "string"  }]
{  "message": "string"}
{  "message": "string"}
{  "error": [    {      "message": "string",      "path": [        "string"      ],      "type": "string",      "context": {}    }  ]}