Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Query Parameters

starting_after
string

Cursor for pagination — the ID of the last item in the previous page

limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
status
enum<string>

Only return broadcasts in this state.

Available options:
draft,
scheduled,
sending,
sent,
canceled,
failed
sent_after
string<date-time>

Only return broadcasts sent at or after this timestamp.

sent_before
string<date-time>

Only return broadcasts sent at or before this timestamp.

metadata
object

Filter by caller-owned metadata key/value pairs, e.g. metadata[campaign]=spring. Repeatable (up to 10 keys); all pairs must match.

Response

Broadcasts

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string