curl --request GET \
--url https://api.kit.com/v4/broadcasts \
--header 'X-Kit-Api-Key: <api-key>'require 'uri'
require 'net/http'
url = URI("https://api.kit.com/v4/broadcasts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Kit-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyconst options = {method: 'GET', headers: {'X-Kit-Api-Key': '<api-key>'}};
fetch('https://api.kit.com/v4/broadcasts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.kit.com/v4/broadcasts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Kit-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kit.com/v4/broadcasts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Kit-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://api.kit.com/v4/broadcasts"
headers = {"X-Kit-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"broadcasts": [
{
"id": 3,
"publication_id": 3,
"created_at": "2023-02-17T11:43:55Z",
"subject": "Campaign subject 3",
"preview_text": null,
"ab_test": null,
"description": null,
"public": false,
"published_at": null,
"send_at": null,
"status": "draft",
"thumbnail_alt": null,
"thumbnail_url": null,
"content": null,
"public_url": null,
"email_address": "greetings@kit.dev",
"email_template": {
"id": 6,
"name": "Text Only"
},
"subscriber_filter": [
{
"all": [
{
"type": "all_subscribers"
}
]
}
]
},
{
"id": 2,
"publication_id": 2,
"created_at": "2023-02-17T11:43:55Z",
"subject": "Campaign subject 2",
"preview_text": null,
"ab_test": null,
"description": null,
"public": false,
"published_at": null,
"send_at": null,
"status": "draft",
"thumbnail_alt": null,
"thumbnail_url": null,
"content": null,
"public_url": null,
"email_address": "greetings@kit.dev",
"email_template": {
"id": 6,
"name": "Text Only"
},
"subscriber_filter": [
{
"all": [
{
"type": "all_subscribers"
}
]
}
]
},
{
"id": 1,
"publication_id": 1,
"created_at": "2023-02-17T11:43:55Z",
"subject": "Campaign subject 1",
"preview_text": null,
"ab_test": null,
"description": null,
"public": false,
"published_at": null,
"send_at": null,
"status": "draft",
"thumbnail_alt": null,
"thumbnail_url": null,
"content": null,
"public_url": null,
"email_address": "greetings@kit.dev",
"email_template": {
"id": 6,
"name": "Text Only"
},
"subscriber_filter": [
{
"all": [
{
"type": "all_subscribers"
}
]
}
]
}
],
"pagination": {
"has_previous_page": false,
"has_next_page": false,
"start_cursor": "WzNd",
"end_cursor": "WzFd",
"per_page": 500
}
}{
"errors": [
"The access token is invalid"
]
}List broadcasts
Returns a cursor-paginated list of broadcasts in the account with their content, targeting (subscriber_filter), email template, and web-publishing settings. Filter by lifecycle status (draft, scheduled, sending, completed, aborted) and by the sent_after/sent_before timestamps. Default 500 results per page, maximum 1000.
Tip: set slim=true to omit the expensive fields (content, public_url, email_address, email_template, subscriber_filter) for a faster, smaller response — useful when you only need identifiers and subjects.
Delivery and engagement stats are not included in this response; use Get stats for a list of broadcasts for those. Broadcasts that are also published as posts share a publication_id with the matching post from List posts.
curl --request GET \
--url https://api.kit.com/v4/broadcasts \
--header 'X-Kit-Api-Key: <api-key>'require 'uri'
require 'net/http'
url = URI("https://api.kit.com/v4/broadcasts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Kit-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_bodyconst options = {method: 'GET', headers: {'X-Kit-Api-Key': '<api-key>'}};
fetch('https://api.kit.com/v4/broadcasts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.kit.com/v4/broadcasts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Kit-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kit.com/v4/broadcasts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Kit-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://api.kit.com/v4/broadcasts"
headers = {"X-Kit-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"broadcasts": [
{
"id": 3,
"publication_id": 3,
"created_at": "2023-02-17T11:43:55Z",
"subject": "Campaign subject 3",
"preview_text": null,
"ab_test": null,
"description": null,
"public": false,
"published_at": null,
"send_at": null,
"status": "draft",
"thumbnail_alt": null,
"thumbnail_url": null,
"content": null,
"public_url": null,
"email_address": "greetings@kit.dev",
"email_template": {
"id": 6,
"name": "Text Only"
},
"subscriber_filter": [
{
"all": [
{
"type": "all_subscribers"
}
]
}
]
},
{
"id": 2,
"publication_id": 2,
"created_at": "2023-02-17T11:43:55Z",
"subject": "Campaign subject 2",
"preview_text": null,
"ab_test": null,
"description": null,
"public": false,
"published_at": null,
"send_at": null,
"status": "draft",
"thumbnail_alt": null,
"thumbnail_url": null,
"content": null,
"public_url": null,
"email_address": "greetings@kit.dev",
"email_template": {
"id": 6,
"name": "Text Only"
},
"subscriber_filter": [
{
"all": [
{
"type": "all_subscribers"
}
]
}
]
},
{
"id": 1,
"publication_id": 1,
"created_at": "2023-02-17T11:43:55Z",
"subject": "Campaign subject 1",
"preview_text": null,
"ab_test": null,
"description": null,
"public": false,
"published_at": null,
"send_at": null,
"status": "draft",
"thumbnail_alt": null,
"thumbnail_url": null,
"content": null,
"public_url": null,
"email_address": "greetings@kit.dev",
"email_template": {
"id": 6,
"name": "Text Only"
},
"subscriber_filter": [
{
"all": [
{
"type": "all_subscribers"
}
]
}
]
}
],
"pagination": {
"has_previous_page": false,
"has_next_page": false,
"start_cursor": "WzNd",
"end_cursor": "WzFd",
"per_page": 500
}
}{
"errors": [
"The access token is invalid"
]
}Authorizations
Query Parameters
Was this page helpful?