List email broadcasts for the account, newest first. Returns metadata and counters without html or internalTemplate bodies. Paginate with limit (default 50, max 100) and nextToken.

GET

/broadcasts

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

• Production

Authorizations

• apiKey
• clientCredentials
• endUser
• endUserHashed

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

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

audience

required

Broadcast audience: exactly one of filter (Mongo-style query evaluated against synced user objects) or emails (raw list, max 10,000 addresses; for larger audiences use filter after syncing users via the Users API).

object

filter

object

key

additional properties

emails

Array<string>

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

Example^generated

{
  "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

Example^generated

{
  "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

Example^generated

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