List client domain patterns

curl --request GET \
  --url https://api.extole.io/v1/client-domain-patterns \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v1/client-domain-patterns', 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/client-domain-patterns",
  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/client-domain-patterns"

	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/v1/client-domain-patterns")

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

[
  {
    "client_domain_id": "<string>",
    "component_ids": [
      "<string>"
    ],
    "component_references": [
      {
        "component_id": "<string>",
        "socket_names": [
          "<string>"
        ]
      }
    ],
    "id": "<string>",
    "pattern": "<string>",
    "test": true
  }
]

Domains

List client domain patterns

Returns all domain pattern definitions for the calling client. Domain patterns define which URL patterns the Extole platform recognises as belonging to this client — they control campaign-tracking domain matching, shareable link generation, and zone-rendering domain allow-listing. Each entry includes its pattern, type (GLOB, DOMAIN, or SUB_DOMAIN), and the optional client_domain_id that links it to a specific program domain configuration.

GET

client-domain-patterns

curl --request GET \
  --url https://api.extole.io/v1/client-domain-patterns \
  --header 'Authorization: <api-key>'

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

fetch('https://api.extole.io/v1/client-domain-patterns', 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/client-domain-patterns",
  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/client-domain-patterns"

	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/v1/client-domain-patterns")

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

[
  {
    "client_domain_id": "<string>",
    "component_ids": [
      "<string>"
    ],
    "component_references": [
      {
        "component_id": "<string>",
        "socket_names": [
          "<string>"
        ]
      }
    ],
    "id": "<string>",
    "pattern": "<string>",
    "test": true
  }
]

Authorizations

Authorization

string

header

required

Query Parameters

client_domain_id

string

include_archived

boolean

limit

integer<int32>

offset

integer<int32>

Response

Successful response

client_domain_id

string

required

Optional program domain identifier associated with this pattern.

component_ids

string[]

required

component_references

object[]

required

Show child attributes

string

required

read-only

Unique identifier for the client domain pattern.

pattern

required

Build-time expression that resolves to the domain pattern used for matching.

test

required

Build-time expression that marks whether the pattern is used for test traffic only.

type

enum<string>

required

Pattern matching type that controls how the pattern is interpreted.

Available options:

DOMAIN,

GLOB,

SUB_DOMAIN

Create an erasure request Create client domain pattern

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

List client domain patterns

Authorizations

Query Parameters

Response