API

Get campaign

Returns a single campaign with its content, recipients and hash.

GET/campaigns/{id}

Authorization

apiKey posts:read-only
x-api-key<token>

In: header

Scope: posts:read-only

Path Parameters

id*string

Header Parameters

X-Api-Version?string

API version date. Requests without the header use 2026-07.

curl -X GET "https://example.com/campaigns/string" \  -H "X-Api-Version: 2026-07"
{  "updated": "string",  "created": "string",  "publishDate": "string",  "smsTeaser": true,  "deliveryChannel": "email",  "status": "draft",  "title": "string",  "id": "string",  "editorUrl": "string",  "hash": "string",  "recipients": {    "segmentIds": [      "string"    ]  },  "notification": {    "smsText": "string",    "emailDescription": "string",    "emailTitle": "string"  },  "blocks": [    {      "description": "string",      "alt": "string",      "imageUrl": "string",      "isFullWidth": true,      "style": "button",      "url": "string",      "alignment": "left",      "text": "string",      "type": "h1"    }  ],  "text": "string"}
{  "traceId": "string",  "message": "string",  "path": "string",  "timestamp": "string",  "statusCode": 0.1}
{  "traceId": "string",  "message": "string",  "path": "string",  "timestamp": "string",  "statusCode": 0.1}