GET/hyax-api/v1/broadcasts

List broadcasts (campaigns)

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

Name	Required	Description
limit	No	Page size (default 25, max 100)
offset	No	Offset (default 0)
status	No	`DRAFT` \| `SCHEDULED` \| `WARMUP` \| `SENT` \| `ARCHIVED`
search	No	Filter by subject or preheader
archived	No	`true` to list only archived broadcasts

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/broadcasts?limit=10&offset=0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "subject": "February newsletter",
      "preheader": "What's new this month",
      "status": "SENT",
      "sentAt": "2025-02-01T10:00:00.000Z",
      "recipients": 1200,
      "uniqueOpens": 340,
      "uniqueClicks": 52,
      "abTestEnabled": false
    }
  ],
  "pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}