Broadcasts

Get Broadcast

Retrieve a broadcast by ID. Archived broadcasts return 404.

get/broadcasts/{broadcastId}

Request

Base URL
https://api.courier.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/trycourier/apis/courier/docs/broadcasts/:broadcastId/get.ts
A function with typed inputs. Its response is checked against the schema.

broadcastIdstring required

idstring required

The broadcast ID (bst_ prefix).

namestring required

Human-readable name.

The broadcast's delivery channel.

status'draft' | 'scheduled' | 'sending' | 'sent' required

Lifecycle status of the broadcast.

created_atstring required

ISO 8601 timestamp when the broadcast was created.

updated_atstring required

ISO 8601 timestamp of the last update.

created_bystring required

Actor that created the broadcast.

updated_bystring required

Actor that last updated the broadcast.

archived_atstring nullable

ISO 8601 timestamp when the broadcast was archived, if archived.

archived_bystring nullable

Actor that archived the broadcast, if archived.