List campaigns

GET/api/v1/email/campaigns

GET /email/campaigns

curl -X GET 'https://www.unitpost.com/api/v1/email/campaigns' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "campaign",
      "id": "id_123",
      "name": "Example",
      "template_id": "template_123",
      "segment_id": "segment_123",
      "topic_id": "topic_123",
      "from": "you@yourdomain.com",
      "subject": "Welcome to Acme",
      "preview_text": "string",
      "open_tracking": false,
      "click_tracking": false,
      "status": "draft",
      "scheduled_at": "2026-01-01T00:00:00.000Z",
      "variable_fallbacks": {},
      "excluded_contact_ids": [
        "string"
      ],
      "total_recipients": 1,
      "sent_count": 1,
      "failed_count": 1,
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of your campaigns, cursor-paginated. Each row is a reference to one campaign and its current status (draft, scheduled, sending, sent, …). Use a campaign's id with Retrieve a campaign for the full record, or with List sent emails (?campaign_id=) to see the individual emails it produced. Requires the campaigns:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields20 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`name`required	string	—
`template_id`required	string	—
`segment_id`required	string	—
`topic_id`required	object	—
`from`required	string	—
`subject`required	object	—
`preview_text`required	object	—
`open_tracking`required	object	—
`click_tracking`required	object	—
`status`required	enumdraft \| scheduled \| sending \| paused \| sent \| canceled \| failed	—
`scheduled_at`required	object	—
`variable_fallbacks`required	object	—
`excluded_contact_ids`required	string[]	—
`total_recipients`required	number	—
`sent_count`required	number	—
`failed_count`required	number	—
`created_at`required	string	—
`updated_at`required	string	—

200401422

List campaigns

List campaigns

Search docs and guides