API reference
List broadcasts
Newest first. Every field the API key's org can see (workspace-scoped).
GET
/api/broadcastsAuthorizationBearer <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
Query Parameters
status?string
A single status or a comma-separated list (e.g. sent,partial,failed). Each value must be one of BroadcastStatus's nine values; an unknown value 400s.
Response Body
curl -X GET "https://app.stethq.com/api/broadcasts?status=string"{
"broadcasts": [
{
"id": "string",
"title": "string",
"status": "draft",
"sendAt": "2019-08-24T14:15:22Z",
"timezone": "string",
"audienceCount": 0,
"channelCount": 0,
"sentAt": "2019-08-24T14:15:22Z",
"preview": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}{
"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"
}