List additional entity fields

Returns all configured additional entity fields that extend the standard entity model with custom attributes.

Reference

GET https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do

Returns all configured additional entity fields that extend the standard entity model with custom attributes. Each field includes its unique ID, internal name, display title, and the entity type it belongs to (e.g. BANNER, CAMPAIGN). The response is wrapped in a SearchResult container with 'data' array and 'total' count. Requires the ADDITIONAL_ENTITIES_FIELDS_CONFIGURATION admin permission; without it the call answers 403 naming the permission.

Responses

200

SearchResult containing the list of AdditionalEntityField objects in 'data' and total count in 'total'

400

Bad request — invalid or missing parameters

401

Authentication error - invalid hash, timestamp, or username

403

Forbidden - user lacks ADDITIONAL_ENTITIES_FIELDS_CONFIGURATION permission

Language

cURL Request

curl --request GET \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do', {
  method: 'GET',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("GET"), "https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/additional-entity-fields-configuration/list.do")
request = Net::HTTP::Get.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body