List deleted campaigns

curl --request GET \
  --url https://api.extole.io/v2/campaigns/deleted \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/deleted', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/deleted",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/deleted"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/deleted")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "campaign_id": "<string>",
    "campaign_locks": [],
    "components": [
      {
        "assets": [
          {
            "description": "<string>",
            "filename": "<string>",
            "id": "<string>",
            "name": "<string>",
            "tags": [
              "<string>"
            ]
          }
        ],
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "created_date": "2025-10-24T02:00:00-07:00",
        "description": "<string>",
        "display_name": "<string>",
        "facets": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "id": "<string>",
        "install": {},
        "installed_into_socket": "<string>",
        "name": "<string>",
        "origin": {
          "client_id": "<string>",
          "component_id": "<string>",
          "component_version": 123
        },
        "tags": [
          "<string>"
        ],
        "type": "<string>",
        "types": [
          "<string>"
        ],
        "updated_date": "2025-10-24T02:00:00-07:00",
        "upload_version": "<string>",
        "variables": [
          {
            "description": "<string>",
            "display_name": "<string>",
            "name": "<string>",
            "priority": "10",
            "tags": [
              "<string>"
            ],
            "type": "ADMIN_ICON",
            "values": {
              "default": {},
              "en": {}
            }
          }
        ],
        "version": 123
      }
    ],
    "description": "<string>",
    "end_date": "2025-10-24T02:00:00-07:00",
    "flow_steps": [
      {
        "apps": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "description": "<string>",
            "id": "<string>",
            "name": "<string>",
            "type": {
              "name": "<string>"
            }
          }
        ],
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "description": "<string>",
        "flow_path": "<string>",
        "flow_step_id": "<string>",
        "icon_color": "<string>",
        "icon_type": "<string>",
        "metrics": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "description": "<string>",
            "expression": "<string>",
            "id": "<string>",
            "name": "<string>",
            "tags": [
              "<string>"
            ],
            "unit": "<string>"
          }
        ],
        "name": "<string>",
        "sequence": 123,
        "step_name": "<string>",
        "tags": [
          "<string>"
        ],
        "words": {
          "person_counting_name": "<string>",
          "plural_noun_name": "<string>",
          "rate_name": "<string>",
          "singular_noun_name": "<string>",
          "verb_name": "<string>"
        }
      }
    ],
    "incentive": {
      "id": "<string>",
      "quality_rules": [
        {
          "action_types": [],
          "enabled": true,
          "id": "<string>",
          "properties": {}
        }
      ],
      "reward_rules": [
        {
          "count_rewards_based_on_partner_user_id": true,
          "data_attribute_name": "<string>",
          "data_attribute_value": "<string>",
          "expression": {
            "value": "<string>"
          },
          "id": "<string>",
          "is_email_required": true,
          "is_referral_loop_allowed": true,
          "is_unique_friend_required": true,
          "min_cart_value": 123,
          "referrals_per_reward": 123,
          "reward_count_limit": 123,
          "reward_count_since_days": 123,
          "reward_count_since_month": 123,
          "reward_every_x_friend_actions": 123,
          "reward_slots": [
            "<string>"
          ],
          "reward_supplier_id": "<string>",
          "reward_value_limit": 123,
          "reward_value_since_days": 123,
          "reward_value_since_month": 123
        }
      ],
      "transition_rules": [
        {
          "approve_high_quality": true,
          "approve_low_quality": true,
          "transition_period_milliseconds": 123,
          "transition_rule_id": "<string>"
        }
      ]
    },
    "incentive_id": "<string>",
    "is_published": true,
    "labels": [
      {
        "name": "<string>"
      }
    ],
    "last_published_date": "2025-10-24T02:00:00-07:00",
    "name": "<string>",
    "parent_version": 123,
    "pause_date": "2025-10-24T02:00:00-07:00",
    "program_label": "<string>",
    "program_type": "<string>",
    "start_date": "2025-10-24T02:00:00-07:00",
    "steps": [
      {
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "created_date": "2025-10-24T02:00:00-07:00",
        "data": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "default_value": {},
            "dimension": true,
            "enabled": true,
            "id": "<string>",
            "name": "<string>",
            "persist_types": [],
            "value": {}
          }
        ],
        "enabled": true,
        "id": "<string>",
        "step_builder": {},
        "triggers": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "enabled": true,
            "negated": true,
            "parent_trigger_group_name": "<string>",
            "trigger_description": "<string>",
            "trigger_id": "<string>",
            "trigger_name": "<string>",
            "trigger_type": "ACCESS",
            "trusted_scopes": []
          }
        ],
        "type": "CONTROLLER",
        "updated_date": "2025-10-24T02:00:00-07:00",
        "actions": [
          {
            "action_id": "<string>",
            "action_type": "APPROVE",
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "enabled": true,
            "cause_type": "<string>",
            "event_type": "<string>",
            "force": "<string>",
            "legacy_action_id": "<string>",
            "note": "<string>",
            "partner_event_id": "<string>",
            "polling_id": "<string>",
            "polling_name": "<string>",
            "reward_tags": [
              "<string>"
            ]
          }
        ],
        "aliases": [
          "<string>"
        ],
        "controller_id": "<string>",
        "enabled_on_states": [],
        "journey_names": [
          "<string>"
        ],
        "name": "<string>",
        "selectors": []
      }
    ],
    "stop_date": "2025-10-24T02:00:00-07:00",
    "tags": [
      "<string>"
    ],
    "theme_name": "<string>",
    "updated_date": "2025-10-24T02:00:00-07:00",
    "variant_selector": "<string>",
    "variants": [
      "<string>"
    ],
    "version": 123
  }
]

GET

campaigns

deleted

List deleted campaigns

curl --request GET \
  --url https://api.extole.io/v2/campaigns/deleted \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/deleted', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extole.io/v2/campaigns/deleted",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extole.io/v2/campaigns/deleted"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/deleted")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "campaign_id": "<string>",
    "campaign_locks": [],
    "components": [
      {
        "assets": [
          {
            "description": "<string>",
            "filename": "<string>",
            "id": "<string>",
            "name": "<string>",
            "tags": [
              "<string>"
            ]
          }
        ],
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "created_date": "2025-10-24T02:00:00-07:00",
        "description": "<string>",
        "display_name": "<string>",
        "facets": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "id": "<string>",
        "install": {},
        "installed_into_socket": "<string>",
        "name": "<string>",
        "origin": {
          "client_id": "<string>",
          "component_id": "<string>",
          "component_version": 123
        },
        "tags": [
          "<string>"
        ],
        "type": "<string>",
        "types": [
          "<string>"
        ],
        "updated_date": "2025-10-24T02:00:00-07:00",
        "upload_version": "<string>",
        "variables": [
          {
            "description": "<string>",
            "display_name": "<string>",
            "name": "<string>",
            "priority": "10",
            "tags": [
              "<string>"
            ],
            "type": "ADMIN_ICON",
            "values": {
              "default": {},
              "en": {}
            }
          }
        ],
        "version": 123
      }
    ],
    "description": "<string>",
    "end_date": "2025-10-24T02:00:00-07:00",
    "flow_steps": [
      {
        "apps": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "description": "<string>",
            "id": "<string>",
            "name": "<string>",
            "type": {
              "name": "<string>"
            }
          }
        ],
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "description": "<string>",
        "flow_path": "<string>",
        "flow_step_id": "<string>",
        "icon_color": "<string>",
        "icon_type": "<string>",
        "metrics": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "description": "<string>",
            "expression": "<string>",
            "id": "<string>",
            "name": "<string>",
            "tags": [
              "<string>"
            ],
            "unit": "<string>"
          }
        ],
        "name": "<string>",
        "sequence": 123,
        "step_name": "<string>",
        "tags": [
          "<string>"
        ],
        "words": {
          "person_counting_name": "<string>",
          "plural_noun_name": "<string>",
          "rate_name": "<string>",
          "singular_noun_name": "<string>",
          "verb_name": "<string>"
        }
      }
    ],
    "incentive": {
      "id": "<string>",
      "quality_rules": [
        {
          "action_types": [],
          "enabled": true,
          "id": "<string>",
          "properties": {}
        }
      ],
      "reward_rules": [
        {
          "count_rewards_based_on_partner_user_id": true,
          "data_attribute_name": "<string>",
          "data_attribute_value": "<string>",
          "expression": {
            "value": "<string>"
          },
          "id": "<string>",
          "is_email_required": true,
          "is_referral_loop_allowed": true,
          "is_unique_friend_required": true,
          "min_cart_value": 123,
          "referrals_per_reward": 123,
          "reward_count_limit": 123,
          "reward_count_since_days": 123,
          "reward_count_since_month": 123,
          "reward_every_x_friend_actions": 123,
          "reward_slots": [
            "<string>"
          ],
          "reward_supplier_id": "<string>",
          "reward_value_limit": 123,
          "reward_value_since_days": 123,
          "reward_value_since_month": 123
        }
      ],
      "transition_rules": [
        {
          "approve_high_quality": true,
          "approve_low_quality": true,
          "transition_period_milliseconds": 123,
          "transition_rule_id": "<string>"
        }
      ]
    },
    "incentive_id": "<string>",
    "is_published": true,
    "labels": [
      {
        "name": "<string>"
      }
    ],
    "last_published_date": "2025-10-24T02:00:00-07:00",
    "name": "<string>",
    "parent_version": 123,
    "pause_date": "2025-10-24T02:00:00-07:00",
    "program_label": "<string>",
    "program_type": "<string>",
    "start_date": "2025-10-24T02:00:00-07:00",
    "steps": [
      {
        "component_ids": [
          "<string>"
        ],
        "component_references": [
          {
            "component_id": "<string>",
            "socket_names": [
              "<string>"
            ]
          }
        ],
        "created_date": "2025-10-24T02:00:00-07:00",
        "data": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "default_value": {},
            "dimension": true,
            "enabled": true,
            "id": "<string>",
            "name": "<string>",
            "persist_types": [],
            "value": {}
          }
        ],
        "enabled": true,
        "id": "<string>",
        "step_builder": {},
        "triggers": [
          {
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "enabled": true,
            "negated": true,
            "parent_trigger_group_name": "<string>",
            "trigger_description": "<string>",
            "trigger_id": "<string>",
            "trigger_name": "<string>",
            "trigger_type": "ACCESS",
            "trusted_scopes": []
          }
        ],
        "type": "CONTROLLER",
        "updated_date": "2025-10-24T02:00:00-07:00",
        "actions": [
          {
            "action_id": "<string>",
            "action_type": "APPROVE",
            "component_ids": [
              "<string>"
            ],
            "component_references": [
              {
                "component_id": "<string>",
                "socket_names": [
                  "<string>"
                ]
              }
            ],
            "enabled": true,
            "cause_type": "<string>",
            "event_type": "<string>",
            "force": "<string>",
            "legacy_action_id": "<string>",
            "note": "<string>",
            "partner_event_id": "<string>",
            "polling_id": "<string>",
            "polling_name": "<string>",
            "reward_tags": [
              "<string>"
            ]
          }
        ],
        "aliases": [
          "<string>"
        ],
        "controller_id": "<string>",
        "enabled_on_states": [],
        "journey_names": [
          "<string>"
        ],
        "name": "<string>",
        "selectors": []
      }
    ],
    "stop_date": "2025-10-24T02:00:00-07:00",
    "tags": [
      "<string>"
    ],
    "theme_name": "<string>",
    "updated_date": "2025-10-24T02:00:00-07:00",
    "variant_selector": "<string>",
    "variants": [
      "<string>"
    ],
    "version": 123
  }
]

Authorizations

Authorization

string

header

required

Response

Successful response

campaign_id

string

required

campaign_locks

enum<string>[]

required

Available options:

DUPLICATE,

EDIT

campaign_type

enum<string>

required

Available options:

CONFIGURATION,

EXTENSION,

INTEGRATION,

MARKETING

components

object[]

required

Show child attributes

description

string

required

end_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

flow_steps

object[]

required

Show child attributes

incentive

object

required

Show child attributes

incentive_id

string

required

is_published

boolean

required

labels

object[]

required

Show child attributes

last_published_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

name

string

required

parent_version

integer<int32> | null

required

pause_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

program_label

string

required

program_type

string

required

start_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

state

enum<string>

required

Available options:

ARCHIVED,

ENDED,

LIVE,

NOT_LAUNCHED,

PAUSED,

STOPPED

steps

(CONTROLLER · object | FRONTEND_CONTROLLER · object | JOURNEY_ENTRY · object)[]

required

Stored campaign controller definition. Fields enabled, name, scope, enabled_on_states, selectors, aliases, journey_names, send_policy, and step_builder are unevaluated and appear in buildtime-evaluatable form.

CONTROLLER
FRONTEND_CONTROLLER
JOURNEY_ENTRY

Show child attributes

stop_date

string

required

RFC 3339 or RFC 9557 date-time with a numeric UTC offset and an optional IANA time-zone suffix in square brackets. Precision up to milliseconds.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

List deleted campaigns

Authorizations

Response