JavaScript
import Courier from '@trycourier/courier';
const client = new Courier({
apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});
const broadcastListResponse = await client.broadcasts.list();
console.log(broadcastListResponse.paging);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
broadcast_list_response = client.broadcasts.list()
print(broadcast_list_response.paging)package main
import (
"context"
"fmt"
"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
broadcastListResponse, err := client.Broadcasts.List(context.TODO(), courier.BroadcastListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", broadcastListResponse.Paging)
}
package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.broadcasts.BroadcastListParams;
import com.courier.models.broadcasts.BroadcastListResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
BroadcastListResponse broadcastListResponse = client.broadcasts().list();
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
broadcast_list_response = courier.broadcasts.list
puts(broadcast_list_response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$broadcastListResponse = $client->broadcasts->list(
cursor: 'cursor', limit: 1
);
var_dump($broadcastListResponse);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using TryCourier.Models.Broadcasts;
CourierClient client = new();
BroadcastListParams parameters = new();
var broadcastListResponse = await client.Broadcasts.List(parameters);
Console.WriteLine(broadcastListResponse);courier broadcasts list \
--api-key 'My API Key'curl --request GET \
--url https://api.courier.com/broadcasts \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "bst_01kx4h2jdafq8bk9amzvy6hbv0",
"name": "Spring Sale Announcement",
"channel": "email",
"status": "draft",
"schedule": null,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"created_by": "user_01kx4h2jdafq8bk9amzvy6hbv0",
"updated_by": "user_01kx4h2jdafq8bk9amzvy6hbv0"
}
],
"paging": {
"cursor": null,
"more": false
}
}Broadcasts
List Broadcasts
List broadcasts in your workspace. Cursor-paginated; returns broadcasts newest-first.
GET
/
broadcasts
JavaScript
import Courier from '@trycourier/courier';
const client = new Courier({
apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});
const broadcastListResponse = await client.broadcasts.list();
console.log(broadcastListResponse.paging);import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
broadcast_list_response = client.broadcasts.list()
print(broadcast_list_response.paging)package main
import (
"context"
"fmt"
"github.com/trycourier/courier-go"
"github.com/trycourier/courier-go/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
broadcastListResponse, err := client.Broadcasts.List(context.TODO(), courier.BroadcastListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", broadcastListResponse.Paging)
}
package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.broadcasts.BroadcastListParams;
import com.courier.models.broadcasts.BroadcastListResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
BroadcastListResponse broadcastListResponse = client.broadcasts().list();
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
broadcast_list_response = courier.broadcasts.list
puts(broadcast_list_response)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$broadcastListResponse = $client->broadcasts->list(
cursor: 'cursor', limit: 1
);
var_dump($broadcastListResponse);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using TryCourier;
using TryCourier.Models.Broadcasts;
CourierClient client = new();
BroadcastListParams parameters = new();
var broadcastListResponse = await client.Broadcasts.List(parameters);
Console.WriteLine(broadcastListResponse);courier broadcasts list \
--api-key 'My API Key'curl --request GET \
--url https://api.courier.com/broadcasts \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "bst_01kx4h2jdafq8bk9amzvy6hbv0",
"name": "Spring Sale Announcement",
"channel": "email",
"status": "draft",
"schedule": null,
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z",
"created_by": "user_01kx4h2jdafq8bk9amzvy6hbv0",
"updated_by": "user_01kx4h2jdafq8bk9amzvy6hbv0"
}
],
"paging": {
"cursor": null,
"more": false
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Opaque pagination cursor from a previous response. Omit for the first page.
Maximum number of results per page.
Required range:
1 <= x <= 1000⌘I