Campaign List

v1.0.0

This endpoint allows you to export a list of campaigns, each of which will include its name, Campaign API Identifier, whether it is an API Campaign, and Tags associated with the campaign. The campaigns are returned in groups of 100 sorted by time of creation (oldest to newest by default).

Campaign List Endpoint API Response

json

Content-Type: application/jsonAuthorization: Bearer YOUR-REST-API-KEY{    "message": (required, string) the status of the export, returns 'success' when completed without errors,    "campaigns" : [        {            "id" : (string) Campaign API Identifier,            "last_edited": (ISO 8601 string) the last edited time for the message             "name" : (string) campaign name,            "is_api_campaign" : (boolean) whether the campaign is an API Campaign,            "tags" : (array) tag names associated with the campaign        },        ...    ]}

Input

{
  "type": "object",
  "properties": {
    "include_archived": {
      "type": "string"
    },
    "last_edit.time[gt]": {
      "type": "string"
    },
    "page": {
      "type": "string"
    },
    "sort_direction": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}