List campaigns
GET/api/v1/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'{
"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,
"projected_recipients": {
"total": 1,
"reachable": 0,
"skipped": 0
},
"sent_count": 1,
"failed_count": 1,
"pause_reason": {
"code": "user",
"message": "string",
"metric": "hard_bounce_rate",
"value": 0,
"threshold": 0,
"sample": {
"events": 0,
"of": 0
},
"window": {
"since": "string"
},
"decided_by": "floor",
"resume": "self_serve",
"paused_at": "2026-01-01T00:00:00.000Z"
},
"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. Deleted (archived) campaigns are hidden; pass ?archived=true to list only archived ones, which can be restored for 30 days. Requires the campaigns:read capability.
Parameters6 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). |
archived | boolean · query | When true, list only archived campaigns instead of active ones. |
topic_id | string · query | Only campaigns scoped to this topic. An id from another workspace or channel matches nothing. |
segment_id | string · query | Only campaigns aimed at this segment (`seg_…`). |
Response · 200 fields22 fields
| Field | Type | Description |
|---|---|---|
objectrequired | string | — |
idrequired | string | — |
namerequired | string | — |
template_idrequired | string | — |
segment_idrequired | string | — |
topic_idrequired | string | null | — |
fromrequired | string | — |
subjectrequired | string | null | — |
preview_textrequired | string | null | — |
open_trackingrequired | boolean | null | — |
click_trackingrequired | boolean | null | — |
statusrequired | enumdraft | scheduled | sending | paused | sent | canceled | failed | — |
scheduled_atrequired | string | null | — |
variable_fallbacksrequired | object | — |
excluded_contact_idsrequired | string[] | — |
total_recipientsrequired | number | Recipients the engine admitted when the campaign started sending. 0 while it is `draft` or `scheduled`: read `projected_recipients`, or `sendable` from validate. |
projected_recipients | object | null | The audience counted when the campaign was sent or scheduled: `total` segment members, `reachable` who will get it, `skipped` (unsubscribed, suppressed, excluded). Null for a draft that was never sent: read validate. Read-only. |
sent_countrequired | number | — |
failed_countrequired | number | — |
pause_reasonrequired | object | null | — |
created_atrequired | string | — |
updated_atrequired | string | — |