EndUserEntity
Get the definitions for all end user entities
GET
/
api
/
end_user_entities
Get the definitions for all end user entities
curl --request GET \
--url https://app.herondata.io/api/end_user_entities \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_user_entities"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.herondata.io/api/end_user_entities', 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://app.herondata.io/api/end_user_entities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://app.herondata.io/api/end_user_entities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://app.herondata.io/api/end_user_entities")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_user_entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"display_order": 123,
"entity_attributes": [
{
"attribute_description": "<string>",
"attribute_name": "<string>",
"attribute_sources": [
{
"heron_id": "<string>",
"sort_order": 123,
"source_config": {},
"source_type": "parsed_end_user_file"
}
],
"attribute_type": "float",
"display_order": 123,
"heron_id": "<string>",
"is_dedupe_key": false,
"reconciliation_config": {},
"reconciliation_strategy": "sort_order"
}
],
"entity_description": "<string>",
"entity_name": "<string>",
"entity_post_processor_configs": [],
"heron_id": "<string>",
"is_custom": true,
"is_list": true,
"saved_query_heron_id": "<string>"
}
]Authorizations
Response
200 - application/json
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
True when no entity template the customer set up in full creates this entity.
Was this page helpful?
⌘I
Get the definitions for all end user entities
curl --request GET \
--url https://app.herondata.io/api/end_user_entities \
--header 'x-api-key: <api-key>'import requests
url = "https://app.herondata.io/api/end_user_entities"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.herondata.io/api/end_user_entities', 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://app.herondata.io/api/end_user_entities",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://app.herondata.io/api/end_user_entities"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://app.herondata.io/api/end_user_entities")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.herondata.io/api/end_user_entities")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"display_order": 123,
"entity_attributes": [
{
"attribute_description": "<string>",
"attribute_name": "<string>",
"attribute_sources": [
{
"heron_id": "<string>",
"sort_order": 123,
"source_config": {},
"source_type": "parsed_end_user_file"
}
],
"attribute_type": "float",
"display_order": 123,
"heron_id": "<string>",
"is_dedupe_key": false,
"reconciliation_config": {},
"reconciliation_strategy": "sort_order"
}
],
"entity_description": "<string>",
"entity_name": "<string>",
"entity_post_processor_configs": [],
"heron_id": "<string>",
"is_custom": true,
"is_list": true,
"saved_query_heron_id": "<string>"
}
]