Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Campaigns

Load Campaigns

Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns

get/campaigns

Query parameters

searchstring string

string

Text fragment used for searching in Campaign name (using the 'contains' rule)

offsetinteger

integer

How many items should be returned ahead.

limitinteger

integer

Maximum number of returned items.

Response

OK

Namestring string required

Campaign name

Status'Deleted' | 'Active' | 'Processing' | 'Sending' | 'Completed' | 'Paused' | 'Cancelled' | 'Draft'

Example response

[
  {
    "Content": [
      {
        "Poolname": "My Custom Pool",
        "From": "John Doe <email@domain.com>",
        "ReplyTo": "John Doe <email@domain.com>",
        "Subject": "Hello!",
        "TemplateName": "Template01",
        "AttachFiles": [
          "preuploaded.jpg"
        ]
      }
    ]
  }
]
All 107 operations