Returns the complete collection of core and custom fields for the current tenant.
curl --request GET \
--url https://{install}/api/field \
--header 'Authorization: Bearer <token>'import requests
url = "https://{install}/api/field"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{install}/api/field', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/field");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/field",
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: Bearer <token>"
],
]);
$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://{install}/api/field"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{install}/api/field")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/field")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"typeDate": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": "2023-11-07T05:31:56Z",
"maximum": "2023-11-07T05:31:56Z",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeDecimal": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeInteger": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeList": [
{
"entity": "<string>",
"fieldType": "<string>",
"multiSelect": true,
"data": [
{
"id": "<string>",
"value": "<string>",
"image": "<string>",
"metadata": "<string>",
"active": true
}
],
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePercent": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePicker": [
{
"entity": "<string>",
"fieldType": "<string>",
"scope": "<string>",
"multiSelect": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeText": [
{
"entity": "<string>",
"fieldType": "<string>",
"contentType": "<string>",
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeTime": [
{
"entity": "<string>",
"fieldType": "<string>",
"allowDay": true,
"allowHour": true,
"allowMinute": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeToggle": [
{
"entity": "<string>",
"fieldType": "<string>",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
]
}Data & Fields
Returns the complete collection of core and custom fields for the current tenant.
GET
/
api
/
field
Returns the complete collection of core and custom fields for the current tenant.
curl --request GET \
--url https://{install}/api/field \
--header 'Authorization: Bearer <token>'import requests
url = "https://{install}/api/field"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{install}/api/field', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));using RestSharp;
var options = new RestClientOptions("https://{install}/api/field");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{install}/api/field",
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: Bearer <token>"
],
]);
$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://{install}/api/field"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{install}/api/field")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{install}/api/field")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"typeDate": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": "2023-11-07T05:31:56Z",
"maximum": "2023-11-07T05:31:56Z",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeDecimal": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeInteger": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeList": [
{
"entity": "<string>",
"fieldType": "<string>",
"multiSelect": true,
"data": [
{
"id": "<string>",
"value": "<string>",
"image": "<string>",
"metadata": "<string>",
"active": true
}
],
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePercent": [
{
"entity": "<string>",
"fieldType": "<string>",
"minimum": 123,
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typePicker": [
{
"entity": "<string>",
"fieldType": "<string>",
"scope": "<string>",
"multiSelect": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeText": [
{
"entity": "<string>",
"fieldType": "<string>",
"contentType": "<string>",
"maximum": 123,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeTime": [
{
"entity": "<string>",
"fieldType": "<string>",
"allowDay": true,
"allowHour": true,
"allowMinute": true,
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
],
"typeToggle": [
{
"entity": "<string>",
"fieldType": "<string>",
"defaultValue": "<string>",
"name": "<string>",
"prompt": "<string>",
"description": "<string>",
"isCore": true,
"isFeature": true,
"featureName": "<string>",
"placement": [
123
],
"usage": [
123
],
"listEditable": true,
"tenantId": "<string>",
"id": "<string>",
"created": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updated": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"deleted": true
}
]
}Authorizations
JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.
Response
The field collection.
All field definitions visible to a tenant, bucketed by type. Acts as the lookup surface for "give me the id of the Status field" / "what's the data list on Priority" — used at item-build time (server onboarding, CLI apply layer) and at rule-evaluation time.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I