Get All Campaigns

Get all campaigns

Retrieve all the campaigns available for your account

GET https://api.cm.com/bulkemail/v1.0/accounts/{accountID}/campaigns

GET Parameters

Name In Description Required Type Example
AccountID Path The account guid True Guid A8C062E4-ECFD-48D0-89B1-A37D2622B7A9
Skip Query The amount of campaigns to skip False (default 0) Int 0
Take Query The amount of campaigns to take False (default 1000) Int 1000
Filter Query The name to filter on False String My awesome campaign
CampaignTypeID Query The campaign type to filter on. See also campaign object definition for possible values False Int 1
CampaignTags Query The tagnames to filter on False String Newsletter
IncludePreviewHtmlBody Query Whether to include a preview in the response False (default False) Bool True
X-CM-PRODUCTTOKEN Header Your product token True Guid C24A5029-37DD-4161-9728-F80D8639588E

Responses

Http status Description
200 Successful operation
400 Bad request
[
    {
        "ID": "77e6a0e6-0c92-4138-89bd-886edf2ecc0d",
        "AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
        "Name": "Demo campaign",
        "CampaignType": 1,
        "CampaignState": 1,
        "ToAddressListID": null,
        "ScheduledOn": null,
        "ScheduledOnUtc": null,
        "TestPercentage": null,
        "TestDurationMinutes": null,
        "TestMetricType": null,
        "SendToRemainingOn": null,
        "SendToRemainingOnUtc": null,
        "WinningVariationID": null,
        "TotalRecipients": 0,
        "PreviewHtmlBody": null,
        "CampaignTags": [
            {
                "ID": "6eca6202-7a5a-4850-8800-cfee1d97d238",
                "AccountID": "a8c062e4-ecfd-48d0-89b1-a37d2622b7a9",
                "Tag": "Newsletter",
                "CreatedOn": "2019-11-20T11:12:42.99",
                "CreatedOnUtc": "2019-11-20T10:12:42.99Z",
                "ModifiedOn": "2019-11-20T11:12:42.99",
                "ModifiedOnUtc": "2019-11-20T10:12:42.99Z",
                "DeletedOn": null,
                "DeletedOnUtc": null
            }
        ],
        "GoogleAnalyticsTracking": null,
        "CreatedOn": "2019-03-27T15:13:45.127",
        "CreatedOnUtc": "2019-03-27T14:13:45.127Z",
        "ModifiedOn": "2019-03-27T15:13:45.127",
        "ModifiedOnUtc": "2019-03-27T14:13:45.127Z",
        "DeletedOn": null,
        "DeletedOnUtc": null
    }
]

Did this page help you?