Skip to main content
GET
List broadcasts

Authorizations

X-Kit-Api-Key
string
header
required

Authenticate API requests via an API Key

Query Parameters

after
any | null

To fetch next page of results, use ?after=<end_cursor>

before
any | null

To fetch previous page of results, use ?before=<start_cursor>

include_total_count
boolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

per_page
any | null

Number of results per page. Default 500, maximum 1000.

sent_after
any | null

Get broadcasts sent after this date (format yyyy-mm-dd).

sent_before
any | null

Get broadcasts sent before this date (format yyyy-mm-dd).

slim
boolean

When true, omits expensive optional fields from the response. Produces a faster, smaller response — useful when extra fields are not needed.

status
enum<string>

Filter broadcasts by lifecycle status. One of: draft, scheduled, sending, completed, aborted.

Available options:
draft,
scheduled,
sending,
completed,
aborted

Response

Returns a paginated list of all broadcasts for your account (including draft, scheduled, and already sent)

broadcasts
object[]
required
pagination
object
required