v93

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Campaigns

List campaigns

Lists campaigns for the authenticated company, optionally filtered by status or label.

get/campaigns

Query parameters

status'draft' | 'scheduled' | 'sent' | 'sending' | 'cancelled' | 'paused' | 'waiting_approval' | 'rejected'

Optional campaign status filter.

labelstring

Optional label name filter. Only campaigns assigned this label are returned.

limitinteger

Optional page size. Values above 100 are capped to 100.

offsetinteger

Optional zero-based row offset.

Response

Campaigns returned

successboolean

Example response

{
  "success": true,
  "campaigns": [
    {
      "id": "camp_abc123",
      "name": "April Launch",
      "type": "email",
      "subject": "A quick update",
      "status": "draft",
      "labels": [
        "edm",
        "api"
      ]
    }
  ],
  "pagination": {
    "limit": 50,
    "count": 50,
    "total": 125,
    "hasMore": true
  }
}