List built campaign controllers

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

import requests

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

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/built', 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/built",
  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/built"

	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/built")

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

built

List built campaign controllers

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

import requests

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

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/built', 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/built",
  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/built"

	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/built")

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

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

boolean

required

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

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

Show child attributes

aliases

string[]

required

controller_id

string

required

enabled_on_states

enum<string>[]

required

Available options:

ARCHIVED,

ENDED,

LIVE,

NOT_LAUNCHED,

PAUSED,

STOPPED

journey_names

string[]

required

name

string

required

scope

enum<string>

required

Available options:

CLIENT,

PRIVATE,

PUBLIC

selectors

enum<string>[]

required

Available options:

BEST_REFERRAL,

BEST_REFERRAL_SAME_PROGRAM,

MATCHING_CAMPAIGN,

TARGET

send_policy

enum<string>

required

Available options:

ALL,

FIRST_ONLY

Create a campaign controller List all campaign controller actions

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

List built campaign controllers

Authorizations

Path Parameters

Query Parameters

Response