API

Get campaigns

Lists the workspace's campaigns with their delivery channel, status and send date. Use $offset and $limit to paginate ($limit is capped at 30 and $offset at 100), $filter to narrow on status, deliveryChannel or publishDate, and $orderBy to sort by created, updated or publishDate.

GET/campaigns

Authorization

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

In: header

Scope: posts:read-only

Query Parameters

$offset?string
$limit?string
$filter?string
$orderBy?string

Header Parameters

X-Api-Version?string

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

curl -X GET "https://example.com/campaigns" \  -H "X-Api-Version: 2026-07"
{  "meta": {    "maxResults": 0.1  },  "items": [    {      "updated": "string",      "created": "string",      "publishDate": "string",      "smsTeaser": true,      "deliveryChannel": "email",      "status": "draft",      "title": "string",      "id": "string"    }  ]}
{  "traceId": "string",  "message": "string",  "path": "string",  "timestamp": "string",  "statusCode": 0.1}
{  "traceId": "string",  "message": "string",  "path": "string",  "timestamp": "string",  "statusCode": 0.1}