Get Campaigns

GET 
/emails/schedule

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Get Campaigns

Request

Version stringrequired

API Version

Available options2021-07-28

locationId stringrequired

Location ID to fetch campaigns from

limit number

Maximum number of campaigns to return. Defaults to 10, maximum is 100

offset number

Number of campaigns to skip for pagination

status string

Filter by schedule status

Available optionsactivepausecompletecancelledretrydraftresend-scheduledprocessing

emailStatus string

Filter by email delivery status

Available optionsallnot-startedpausedcancelledprocessingresumednext-dripcompletesuccesserrorwaitingqueued

name string

Filter campaigns by name

parentId string

Filter campaigns by parent folder ID

limitedFields boolean

When true, returns only essential campaign fields like id, templateDataDownloadUrl, updatedAt, type, templateType, templateId, downloadUrl and isPlainText. When false, returns complete campaign data including meta information, bulkRequestStatusInfo, ABTestInfo, resendScheduleInfo and all other campaign properties

Default value:false

archived boolean

Filter archived campaigns

campaignsOnly boolean

Return only campaigns, excluding folders

Default value:false

showStats boolean

When true, returns campaign statistics including delivered count, opened count, clicked count and revenue if available for the campaign. When false, returns campaign data without statistics.

Default value:true

application/json

Success

application/json

Schema

Schema

schedulesobject[]required

The list of campaigns

totalstring[]required

The total number of campaigns

traceIdstringrequired

Trace Id

Example (auto)

{
  "schedules": [
    {
      "name": "Untitled new campaign",
      "repeatAfter": "string",
      "id": "string",
      "parentId": "string",
      "childCount": 0,
      "campaignType": "string",
      "bulkActionVersion": "string",
      "_id": "string",
      "status": "string",
      "sendDays": [
        "string"
      ],
      "deleted": true,
      "migrated": true,
      "archived": true,
      "hasTracking": true,
      "isPlainText": true,
      "hasUtmTracking": true,
      "enableResendToUnopened": true,
      "locationId": "string",
      "templateId": "string",
      "templateType": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "__v": 0,
      "documentId": "string",
      "downloadUrl": "string",
      "templateDataDownloadUrl": "string",
      "child": [
        "string"
      ]
    }
  ],
  "total": [
    "string"
  ],
  "traceId": "string"
}