Skip to content

List email broadcasts for the account, newest first. Returns metadata without html or internalTemplate bodies. A live-filter audience includes the filter. A raw email audience includes emailCount and omits the addresses. Paginate with limit (default 50, max 100) and nextToken.

GET
/broadcasts
curl --request GET \
  --url https://api.pingram.io/broadcasts \
  --header 'Authorization: Bearer <token>'

Authorizations

Parameters

Query Parameters

limit
number

Max broadcasts to return (default 50)

nextToken
string

Pagination token

Responses

200

Successful response

Media typeapplication/json
object
broadcasts
required
Array<object>
object
audience
required

Audience on a broadcast list row. Exactly one of filter (the live Mongo-style query) or emailCount (size of a raw email list). Addresses are omitted here; get, create, and update return audience.emails.

object
filter
object
key
additional properties
emailCount

Number of addresses when the audience is a raw email list.

number
broadcastId
required

UUIDv7 (time-ordered).

string
name
required
string
status
required

Lifecycle status of an email broadcast.

string
Allowed values: draft scheduled sending sent paused canceled
pausedReason
string
Allowed values: PAUSED_BY_USER REPUTATION_GUARD PLAN_EXCEEDED PENDING_VERIFICATION AUDIENCE_LIMITS_EXCEEDED UNVERIFIED_DOMAIN SPAM_CONTENT
type

Notification type id. Required before send or schedule.

string
channel
required

Email-only in v1; forward-compatible field.

string
Allowed values: email
fromName
required
string
fromAddress
required
string
replyToAddress
string
subject
required
string
scheduleAt

ISO datetime for scheduled broadcasts.

string
archivedAt

Set when the user archives the broadcast; hidden from the default list.

string
createdAt
required
string
updatedAt
required
string
nextToken
string
Example
{
  "broadcasts": [
    {
      "status": "draft",
      "pausedReason": "PAUSED_BY_USER",
      "channel": "email"
    }
  ]
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}