List campaign controllers

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers', 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/{campaignId}{version}/controllers",
  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/{campaignId}{version}/controllers"

	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/{campaignId}{version}/controllers")

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

[
  {
    "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": []
  }
]

GET

campaigns

{campaignId}

{version}

controllers

List campaign controllers

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers', 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/{campaignId}{version}/controllers",
  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/{campaignId}{version}/controllers"

	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/{campaignId}{version}/controllers")

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

[
  {
    "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": []
  }
]

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

Query Parameters

type

enum<string>

Available options:

CONTROLLER,

FRONTEND_CONTROLLER,

JOURNEY_ENTRY

Response

Successful response

CONTROLLER
FRONTEND_CONTROLLER
JOURNEY_ENTRY

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.

component_ids

string[]

required

component_references

object[]

required

Show child attributes

created_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"

data

object[]

required

Show child attributes

enabled

required

The enabled as configured: a literal value, or an expression (type:string) when defined dynamically.

string

required

read-only

step_builder

required

The step builder as configured: a literal value, or an expression (type:string) when defined dynamically.

triggers

required

Stored campaign controller trigger definition. Fields trigger_phase, trigger_name, parent_trigger_group_name, trigger_description, enabled, and negated are unevaluated and appear in buildtime-evaluatable form.

Show child attributes

type

enum<string>

required

Available options:

CONTROLLER

updated_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"

actions

required

Stored campaign controller action definition. Field enabled is unevaluated and appears in buildtime-evaluatable form.

Show child attributes

aliases

required

The aliases as configured: a literal value, or an expression (type:string) when defined dynamically.

controller_id

string

required

enabled_on_states

required

The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

ARCHIVED,

ENDED,

LIVE,

NOT_LAUNCHED,

PAUSED,

STOPPED

journey_names

required

The journey names as configured: a literal value, or an expression (type:string) when defined dynamically.

name

required

The name as configured: a literal value, or an expression (type:string) when defined dynamically.

scope

required

The scope as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

CLIENT,

PRIVATE,

PUBLIC

selectors

required

The selectors as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

BEST_REFERRAL,

BEST_REFERRAL_SAME_PROGRAM,

MATCHING_CAMPAIGN,

TARGET

send_policy

required

The send policy as configured: a literal value, or an expression (type:string) when defined dynamically.

Available options:

ALL,

FIRST_ONLY

Unarchive a JavaScript SDK core extension Create a campaign controller

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

List campaign controllers

Authorizations

Path Parameters

Query Parameters

Response