Get Campaign
Fetch one campaign.
MethodGET
/api/v2/campaigns/:campaignIdReturns one campaign. Permission: campaigns.
Path Parameters
| Name | Type | Description |
|---|---|---|
campaignId | string | Required. Campaign id. |
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Campaign id. |
name | string | Campaign name. |
subject | string | Subject line. |
preview | string or null | Preview text. |
status | string | DRAFT, ARCHIVED, SCHEDULED, SENDING, SENT, or FAILED. |
contentType | string | MAILY, PLATE, or MARKDOWN. |
mailFormat | string | Render format. |
content | unknown | TipTap document. |
recipientCount | integer | Matching recipients. |
recipientFilters | array | Audience filters. |
emailsSentCount | integer | Emails handed to SES. |
emailsOpenedCount | integer | Unique opens. |
emailsClickedCount | integer | Unique clicks. |
scheduledAt | string or null | Scheduled send time. |
sendAt | string or null | Actual send time. |
timezone | string or null | Schedule timezone. |
senderId | string | Sender id. |
sender | object or null | { id, name, email }. |
replyTo | string or null | Reply-To address. |
Errors
| Status | name | When |
|---|---|---|
| 401 | missing_api_key | Missing or invalid bearer token |
| 403 | missing_permission | Token lacks the campaigns permission |
| 404 | not_found | Unknown campaign id |