List custom field options
curl --request GET \
--url https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options \
--header 'Authorization: <api-key>'import requests
url = "https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options', 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.terminal49.com/v2/custom_field_definitions/{definition_id}/options",
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 := "https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options"
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("https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "custom_field_option",
"attributes": {
"label": "<string>",
"value": "<string>",
"position": 123
}
}
],
"links": {
"last": "<string>",
"next": "<string>",
"prev": "<string>",
"first": "<string>",
"self": "<string>"
},
"meta": {
"size": 123,
"total": 123
}
}Custom Field Options
List custom field options
List every enum option configured for a custom field definition in the Terminal49 API. Use this to populate selectors in your tracking UI or app.
GET
/
custom_field_definitions
/
{definition_id}
/
options
List custom field options
curl --request GET \
--url https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options \
--header 'Authorization: <api-key>'import requests
url = "https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options', 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.terminal49.com/v2/custom_field_definitions/{definition_id}/options",
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 := "https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options"
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("https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.terminal49.com/v2/custom_field_definitions/{definition_id}/options")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "custom_field_option",
"attributes": {
"label": "<string>",
"value": "<string>",
"position": 123
}
}
],
"links": {
"last": "<string>",
"next": "<string>",
"prev": "<string>",
"first": "<string>",
"self": "<string>"
},
"meta": {
"size": 123,
"total": 123
}
}List all options for a custom field definition.
Path parameters
| Parameter | Description |
|---|---|
definition_id | The unique identifier of the custom field definition |
Authorizations
Use a Terminal49 API key in the Authorization header with the Token prefix.
Authorization: Token YOUR_API_KEY
Path Parameters
Custom field definition ID
Was this page helpful?
⌘I