Get Banner by Slug
curl --request GET \
--url https://api.example.com/banner/{public_slug}import requests
url = "https://api.example.com/banner/{public_slug}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/banner/{public_slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/banner/{public_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/banner/{public_slug}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/banner/{public_slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/banner/{public_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyBanner
Get Banner by Slug
Get a project’s live announcement banner by its stable public slug
GET
/
banner
/
{public_slug}
Get Banner by Slug
curl --request GET \
--url https://api.example.com/banner/{public_slug}import requests
url = "https://api.example.com/banner/{public_slug}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/banner/{public_slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/banner/{public_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/banner/{public_slug}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/banner/{public_slug}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/banner/{public_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyReturns the live banner for an embed key. This is what the embed widget fetches: the slug is the project’s stable banner key (
<project-slug>-banner), and it stays the same when a new banner replaces the old one, so a snippet pasted once keeps showing whatever is current. No authentication required.
A 404 means nothing is live for that key (never published, replaced, or past its take-down time) — render nothing.
Path Parameters
string
required
The banner’s public slug, shown in the dashboard’s “Add to your website” sheet after the first publish.
Request
curl -X GET "https://api.shipstar.ai/api/v1/banner/acme-banner"
const response = await fetch('https://api.shipstar.ai/api/v1/banner/acme-banner');
const banner = response.status === 404 ? null : await response.json();
import requests
response = requests.get('https://api.shipstar.ai/api/v1/banner/acme-banner')
banner = None if response.status_code == 404 else response.json()
Response
The same shape as Get Live Banner.200
{
"slug": "acme-banner",
"headline": "Scheduled X threads now post themselves",
"body": "Approve once; Shipstar posts the thread at the scheduled time.",
"cta_label": "See what's new",
"badge": "New",
"link_url": "https://acme.com/changelog",
"period_start": "2026-08-31",
"period_end": "2026-09-07",
"published_at": "2026-09-07T09:02:11+00:00",
"expires_at": null,
"commit_count": 14
}
Errors
| Status | Description |
|---|---|
| 404 | No live banner for this slug |
| 429 | Rate limit exceeded — wait Retry-After seconds |
Was this page helpful?