Show
curl --request POST \
--url https://api.example.com/api/directory/kinds.show \
--header 'Content-Type: application/json' \
--data '
{
"id": "872815618512410358"
}
'import requests
url = "https://api.example.com/api/directory/kinds.show"
payload = { "id": "872815618512410358" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({id: '872815618512410358'})
};
fetch('https://api.example.com/api/directory/kinds.show', 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.example.com/api/directory/kinds.show",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '872815618512410358'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/directory/kinds.show"
payload := strings.NewReader("{\n \"id\": \"872815618512410358\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/directory/kinds.show")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"872815618512410358\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/directory/kinds.show")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"872815618512410358\"\n}"
response = http.request(request)
puts response.read_body{
"id": "872815618512410358",
"machine_name": "<string>",
"attributes": [
{
"attribute": {
"id": "<string>",
"content_type": "text/address",
"label": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"choices": {
"values": {},
"strict": true,
"input_type": "select"
},
"icon": "email",
"type": "boolean",
"format": "avs"
},
"classification_level": "unclassified",
"access_level": "none",
"searchable": true,
"sortable": true
}
],
"relation_types": [
{
"id": "872815618512410358",
"label": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"inverse_label": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"classification_level": "unclassified",
"access_level": "none",
"inverse": true
}
],
"sections": [
{
"id": "<string>",
"label": "<string>",
"classification_level": "unclassified",
"attribute_ids": [
"<string>"
],
"relation_type_ids": [
"872815618512410358"
]
}
],
"sorting_attribute_ids": [
"<string>"
]
}Kinds
Show
Retrieves a specific kind with its attributes. Regarding attributes, while using ‘api/directory/resources.list’, ‘searchable’ refers to whether you can apply a filter to it or not (according to the filter type) and ‘sortable’ refers to ‘orders’.
POST
/
api
/
directory
/
kinds.show
Show
curl --request POST \
--url https://api.example.com/api/directory/kinds.show \
--header 'Content-Type: application/json' \
--data '
{
"id": "872815618512410358"
}
'import requests
url = "https://api.example.com/api/directory/kinds.show"
payload = { "id": "872815618512410358" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({id: '872815618512410358'})
};
fetch('https://api.example.com/api/directory/kinds.show', 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.example.com/api/directory/kinds.show",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'id' => '872815618512410358'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/directory/kinds.show"
payload := strings.NewReader("{\n \"id\": \"872815618512410358\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/directory/kinds.show")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"872815618512410358\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/directory/kinds.show")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"872815618512410358\"\n}"
response = http.request(request)
puts response.read_body{
"id": "872815618512410358",
"machine_name": "<string>",
"attributes": [
{
"attribute": {
"id": "<string>",
"content_type": "text/address",
"label": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"choices": {
"values": {},
"strict": true,
"input_type": "select"
},
"icon": "email",
"type": "boolean",
"format": "avs"
},
"classification_level": "unclassified",
"access_level": "none",
"searchable": true,
"sortable": true
}
],
"relation_types": [
{
"id": "872815618512410358",
"label": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"inverse_label": {
"en": "Hello",
"fr": "Bonjour",
"de": "Guten Tag"
},
"classification_level": "unclassified",
"access_level": "none",
"inverse": true
}
],
"sections": [
{
"id": "<string>",
"label": "<string>",
"classification_level": "unclassified",
"attribute_ids": [
"<string>"
],
"relation_type_ids": [
"872815618512410358"
]
}
],
"sorting_attribute_ids": [
"<string>"
]
}Body
application/json
Example:
"872815618512410358"
⌘I