Dynamo Developer DocsDynamo Developer Docs
External APIMarketing Messages

List marketing messages

List Meta (paid) **marketing messages** — metadata only; insight numbers live on the per-message `/insights` endpoint. Newest created first (stable — ties break on id). The optional `startDate`/`endDate` window (both together) matches the date `dateField` selects — send dates by default, or the **next scheduled send** (`dateField=scheduled`) to cover a future range. Page past the `limit` cap with `offset`.

get/marketing-messages

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

startDate?string

Window start (ISO date/datetime). When set, only messages that match [startDate, endDate] on the date selected by dateField (default: send/execution dates, not creation) are returned. Must be supplied together with endDate.

endDate?string

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

dateField?string

Which date the startDate/endDate window matches. sent (default): messages that sent at least once in the window (execution dates). scheduled: messages whose next scheduled send falls in the window — the only way to cover a future range; it matches the single next occurrence, so a recurring message whose next fire precedes the window start won't match. any: either. Requires the window — dateField without startDate/endDate is rejected.

offset?integer

Skip this many results (after the newest-first sort) — raise by limit to page past the cap.

limit?integer

Max messages per page.

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/marketing-messages"
[  {    "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": {}    }  ]}