Skip to main content
GET
Get Broadcasts

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

Query Parameters

type
enum<string>

The type of the broadcasts

Available options:
ALL,
MARKETING,
TRANSACTIONAL
status
enum<string>

The status of the broadcasts

Available options:
ALL,
DRAFT,
SCHEDULED,
SENDING,
SENT,
CANCELLED,
FAILED,
ACTIVE,
PAUSED
Maximum string length: 256
page
number

Page number

take
number

Number of items to take

next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
id
string
required
name
string
required
type
enum<string>
required

The mode of the broadcast: MARKETING (bulk to many people) or TRANSACTIONAL (single-recipient trigger across channels)

Available options:
MARKETING,
TRANSACTIONAL
status
enum<string>
required

The status of the broadcast

Available options:
DRAFT,
SCHEDULED,
SENDING,
SENT,
CANCELLED,
FAILED,
ACTIVE,
PAUSED
show_in_inbox
boolean
required
scheduled_at
string<date-time> | null
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
contacts_count
number
required
recipients_count
number
required
skipped_count
number
required
sent_count
number
required
failed_count
number
required
bounced_count
number
required
delivered_count
number
required
opened_count
number
required
played_count
number
required
click_count
number
required
complained_count
number
required
unsubscribed_count
number
required
error_message
string | null
required
segments
object[]
required
fields
object[]
required
send_to_all
boolean
required
templates
object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required