The custom fields API allowes you to retrieve information about existing custom fields.
URL
You can access the custom fields API with the followong base URL:
https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields
List Custom Fields [GET]
Request:
GET https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields HTTP/1.1
Response:
[
{
"field_id": 123,
"field_name": "field_customer_id",
"label": "Customer ID",
"description": "Example description",
"type": "text_textfield",
"required": false,
},
{
"field_id": 156,
"field_name": "field_confirmation",
"label": "Cookie confirmation",
"description": "Example description",
"type": "checkbox_confirmation",
"required": true,
}
]
Get Custom Field By Id [GET]
Request:
GET https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields/<field_id>
Response:
{
"field_id": 123,
"field_name": "field_customer_id",
"label": "Customer ID",
"description": "Example description",
"type": "text_textfield",
"required": false,
}
Get Custom Field By Name [GET]
Request:
GET https://<system_id>.<server_id>.quentn.com/public/api/V1/custom-fields/<field_name>
Response:
{
"field_id": 156,
"field_name": "field_confirmation",
"label": "Cookie confirmation",
"description": "Example description",
"type": "checkbox_confirmation",
"required": true,
}