stet
API reference

Get a broadcast

Lifecycle fields plus targeted audiences, ordered blocks, and the one-time channel group (if any). Used by the composer.

GET/api/broadcasts/{id}
AuthorizationBearer <token>

A Stet API key (prefix bk_), created under Settings → API keys. The whole API requires the Growth plan or higher; keys are scoped read or write — composing and sending require write.

In: header

Path Parameters

idstring

Response Body

curl -X GET "https://app.stethq.com/api/broadcasts/string"
{
  "broadcast": {
    "id": "string",
    "title": "string",
    "status": "draft",
    "sendAt": "2019-08-24T14:15:22Z",
    "timezone": "string",
    "activeWorkflowInstanceId": "string",
    "sendingProfileId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "audiences": [
    {
      "broadcastId": "string",
      "audienceId": "string"
    }
  ],
  "blocks": [
    {
      "id": "string",
      "broadcastId": "string",
      "position": 0,
      "type": "section",
      "contentJson": {}
    }
  ],
  "oneTimeAudience": {
    "id": "string",
    "name": "One-time channels",
    "color": "a1",
    "channelIds": [
      "string"
    ],
    "kind": "one_time"
  }
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}