List selectable components for a component reference
curl --request GET \
--url https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components"
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/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components', 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/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components",
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/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components"
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))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components")
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[
{
"assets": [
{
"description": "<string>",
"filename": "<string>",
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
]
}
],
"campaign_id": "<string>",
"campaign_state": "<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>",
"duplicatable": true,
"facets": [
{
"name": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"install": {},
"installed_into_socket": "<string>",
"name": "<string>",
"origin": {
"client_id": "<string>",
"component_id": "<string>",
"component_version": 123
},
"owner": "CLIENT",
"source_client_id": "<string>",
"tags": [
"<string>"
],
"type": "<string>",
"types": [
"<string>"
],
"updated_date": "2025-10-24T02:00:00-07:00",
"upload_version": "<string>",
"variables": [
{
"display_name": "<string>",
"name": "<string>",
"priority": "10",
"tags": [
"<string>"
],
"type": "ADMIN_ICON",
"values": {
"default": {},
"en": {}
},
"description": "<string>",
"source": "INHERITED",
"source_component_id": "<string>",
"source_version": 123
}
],
"version": 123
}
]Components
List selectable components for a component reference
Returns the components eligible to be selected for the named COMPONENT_REFERENCE setting. Eligibility is evaluated on the server from the setting’s component type, its selectable filters, its boundary, and whether the setting’s lookup can capture key values for the candidate, so a picker never reproduces those rules. Candidates from this component’s own campaign are resolved against its current draft; candidates from every other campaign are resolved against that campaign’s published version, so a component that exists only in another campaign’s unpublished draft is never eligible.
GET
https://api.extole.io
/
v1
/
components
/
{component_id}
/
settings
/
component-reference
/
{setting_name}
/
selectable-components
List selectable components for a component reference
curl --request GET \
--url https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components \
--header 'Authorization: <api-key>'import requests
url = "https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components"
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/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components', 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/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components",
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/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components"
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))
}HttpResponse<String> response = Unirest.get("https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.extole.io/v1/components/{component_id}/settings/component-reference/{setting_name}/selectable-components")
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[
{
"assets": [
{
"description": "<string>",
"filename": "<string>",
"id": "<string>",
"name": "<string>",
"tags": [
"<string>"
]
}
],
"campaign_id": "<string>",
"campaign_state": "<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>",
"duplicatable": true,
"facets": [
{
"name": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"install": {},
"installed_into_socket": "<string>",
"name": "<string>",
"origin": {
"client_id": "<string>",
"component_id": "<string>",
"component_version": 123
},
"owner": "CLIENT",
"source_client_id": "<string>",
"tags": [
"<string>"
],
"type": "<string>",
"types": [
"<string>"
],
"updated_date": "2025-10-24T02:00:00-07:00",
"upload_version": "<string>",
"variables": [
{
"display_name": "<string>",
"name": "<string>",
"priority": "10",
"tags": [
"<string>"
],
"type": "ADMIN_ICON",
"values": {
"default": {},
"en": {}
},
"description": "<string>",
"source": "INHERITED",
"source_component_id": "<string>",
"source_version": 123
}
],
"version": 123
}
]Authorizations
HEADERQUERYCOOKIE
Query Parameters
Response
The components eligible for selection.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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"
Show child attributes
Show child attributes
install
Static Value · objectInstalltime - Handlebars · stringInstalltime - Javascript · string
required
The install as configured: a literal value, or an expression (type:string) when defined dynamically. Installtime expressions use ComponentInstalltimeContext.
The component this one was copied from, at the version it had at the copy. A duplicate sets it. A copy of a copy in the same client keeps the first copy's origin. A change to the component's types, its install, its first-level elements other than child components, or the account-level elements it uses clears it. The component upgrade does not clear it. A component with no origin is offered no upgrade.
Show child attributes
Show child attributes
Available options:
CLIENT, EXTOLE, EXTOLE_BETA 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"
variables
(ADMIN_ICON · object | AUDIENCE_ID · object | AUDIENCE_ID_LIST · object | BOOLEAN · object | BROWSER_SIDE_JAVASCRIPT · object | CLIENT_DOMAIN_ID · object | CLIENT_DOMAIN_ID_LIST · object | CLIENT_KEY · object | CLIENT_KEY_FLOW · object | COLOR · object | COMPONENT_ID · object | COMPONENT_REFERENCE · object | COMPONENT_REFERENCE_LIST · object | COMPONENT_SETTING_LOOKUP · object | CSS · object | DATE_TIME · object | DELAY · object | DELAY_LIST · object | ENUM · object | ENUM_LIST · object | EXTOLE_CLIENT_KEY · object | FONT · object | GLOB_COMPONENT_PATH · object | HTML · object | IMAGE · object | INTEGER · object | INTEGER_LIST · object | JSON · object | MULTI_SOCKET · object | PARTNER_ENUM · object | PARTNER_ENUM_LIST · object | PERSON_KEY_NAME · object | REWARD_SUPPLIER_ID · object | REWARD_SUPPLIER_ID_LIST · object | SFTP_DIRECTORY · object | SOCKET · object | STRING · object | STRING_LIST · object | STRING_MAP · object | TRIGGER_CONFIGURATION · object | URL · object | WEBHOOK_ID · object)[]
required
- ADMIN_ICON
- AUDIENCE_ID
- AUDIENCE_ID_LIST
- BOOLEAN
- BROWSER_SIDE_JAVASCRIPT
- CLIENT_DOMAIN_ID
- CLIENT_DOMAIN_ID_LIST
- CLIENT_KEY
- CLIENT_KEY_FLOW
- COLOR
- COMPONENT_ID
- COMPONENT_REFERENCE
- COMPONENT_REFERENCE_LIST
- COMPONENT_SETTING_LOOKUP
- CSS
- DATE_TIME
- DELAY
- DELAY_LIST
- ENUM
- ENUM_LIST
- EXTOLE_CLIENT_KEY
- FONT
- GLOB_COMPONENT_PATH
- HTML
- IMAGE
- INTEGER
- INTEGER_LIST
- JSON
- MULTI_SOCKET
- PARTNER_ENUM
- PARTNER_ENUM_LIST
- PERSON_KEY_NAME
- REWARD_SUPPLIER_ID
- REWARD_SUPPLIER_ID_LIST
- SFTP_DIRECTORY
- SOCKET
- STRING
- STRING_LIST
- STRING_MAP
- TRIGGER_CONFIGURATION
- URL
- WEBHOOK_ID
Show child attributes
Show child attributes
Was this page helpful?