Skip to main content
GET
Ruby

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

channelId
string<uuid>
required

The channel to list broadcasts for.

status
enum<string>

Filter by broadcast status. Current processing state of a broadcast. accepted — queued, waiting for the channel to become available. processing — actively sending messages. completed — all messages have been processed. canceled — stopped before completing.

Available options:
accepted,
processing,
completed,
canceled
subject
string

Filter by subject (partial match). Max 500 characters.

limit
integer<int32>

Results per page. Min 1, max 500.

Required range: 1 <= x <= 500
offset
integer<int32>

Pagination offset.

Required range: x >= 0

Response

OK

totalCount
integer<int32>
required
results
object[]
required