Campaigns

List campaigns

Changed on

Lists campaigns for the authenticated company, optionally filtered by status or label. Each item includes delivery pacing (sendTimeOptimization, sendTimeWindowHours, spreadOverHours, sendInRecipientTimezone, scheduledTimezone) and the recipient cap (maxRecipients) so a company-wide STO audit does not need one getCampaign call each. STO is campaign-only; sequences use sendingWindow.

get/campaigns

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/campaigns
  • Auth
    HTTP bearer

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",
      "emailId": "email_abc123",
      "emailPreset": "branded",
      "status": "draft",
      "labels": [
        "edm",
        "api"
      ],
      "spreadOverHours": 6,
      "sendTimeWindowHours": 12,
      "scheduledTimezone": "America/New_York"
    }
  ],
  "pagination": {
    "limit": 50,
    "count": 50,
    "total": 125,
    "hasMore": true
  }
}

Changes

  • db3873ca3d4dRevision changes
    • warning

      added the new push enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e93563b0d37eRevision changes
    • info

      added the optional property // to the response with the status