Get an extended model detail
curl --request GET \
--url http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id} \
--header 'Authorization: <api-key>'import requests
url = "http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}",
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 := "http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}"
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("http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"ID": 1,
"ModelName": "User",
"LastUpdatedBy": "John Smith - john@tyk.io",
"UpdatedAt": "2023-06-25 13:37",
"CustomAttributes": [
{
"Name": "Terms of use",
"Identifier": "terms-of-use",
"Description": "I have read and agreed with...",
"Behaviour": 3,
"DropdownValues": "Fleet_management,Cities,EV_management",
"ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
"AddToKeyMetadata": true,
"Required": true,
"ShowOnSignUp": true,
"WriteOnceReadMany": true,
"ID": 1,
"Type": 2
}
],
"DefaultAttributes": [
{
"AddToKeyMetadata": true,
"ID": 1,
"Label": "First Name"
}
]
}{
"ID": 1,
"ModelName": "User",
"LastUpdatedBy": "John Smith - john@tyk.io",
"UpdatedAt": "2023-06-25 13:37",
"CustomAttributes": [
{
"Name": "Terms of use",
"Identifier": "terms-of-use",
"Description": "I have read and agreed with...",
"Behaviour": 3,
"DropdownValues": "Fleet_management,Cities,EV_management",
"ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
"AddToKeyMetadata": true,
"Required": true,
"ShowOnSignUp": true,
"WriteOnceReadMany": true,
"ID": 1,
"Type": 2
}
],
"DefaultAttributes": [
{
"AddToKeyMetadata": true,
"ID": 1,
"Label": "First Name"
}
]
}Custom Attributes
Get an extended model detail
Get an extended attribute detail
GET
/
extended_attributes
/
{extended_attribute_id}
Get an extended model detail
curl --request GET \
--url http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id} \
--header 'Authorization: <api-key>'import requests
url = "http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}",
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 := "http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}"
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("http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"ID": 1,
"ModelName": "User",
"LastUpdatedBy": "John Smith - john@tyk.io",
"UpdatedAt": "2023-06-25 13:37",
"CustomAttributes": [
{
"Name": "Terms of use",
"Identifier": "terms-of-use",
"Description": "I have read and agreed with...",
"Behaviour": 3,
"DropdownValues": "Fleet_management,Cities,EV_management",
"ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
"AddToKeyMetadata": true,
"Required": true,
"ShowOnSignUp": true,
"WriteOnceReadMany": true,
"ID": 1,
"Type": 2
}
],
"DefaultAttributes": [
{
"AddToKeyMetadata": true,
"ID": 1,
"Label": "First Name"
}
]
}{
"ID": 1,
"ModelName": "User",
"LastUpdatedBy": "John Smith - john@tyk.io",
"UpdatedAt": "2023-06-25 13:37",
"CustomAttributes": [
{
"Name": "Terms of use",
"Identifier": "terms-of-use",
"Description": "I have read and agreed with...",
"Behaviour": 3,
"DropdownValues": "Fleet_management,Cities,EV_management",
"ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
"AddToKeyMetadata": true,
"Required": true,
"ShowOnSignUp": true,
"WriteOnceReadMany": true,
"ID": 1,
"Type": 2
}
],
"DefaultAttributes": [
{
"AddToKeyMetadata": true,
"ID": 1,
"Label": "First Name"
}
]
}Authorizations
Path Parameters
UID of extended attribute
Example:
1
Response
OK
UID of this extended attribute
Example:
1
Name of the model for which the custom attributes are extended
Example:
"User"
User that made the last update of one of the custom attributes for the extended model
Example:
"John Smith - john@tyk.io"
Timestamp of the last update
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-25 13:37"
custom attributes extended for this model
Show child attributes
Show child attributes
default attributes included for this model
Show child attributes
Show child attributes
Was this page helpful?
⌘I