Data fields API

Available Endpoints

Endpoints

GET/api/v1/data_fields

The Data Field Object

variable string

Variable name used in templates

data_path string

Path to the data within the structure

display_label string

Display label for the data type

format string

Format specification for the data type

groups array

Permission groups for this data type

item_type string

Type of each item in a List (e.g., 'Object', 'String', 'Integer')

iterator string

Variable name for the current item when iterating over a List

list_values_variable string

Variable name for list values

object string

Object type identifier

required boolean

Whether this data type is required

source string

Source identifier for the data type

type string

Data type identifier

value string

Default or current value

children array

Nested schema definitions. For arrays: single element defining item type. For objects: multiple elements defining properties

Data Field Object

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "variable": "first_name",
  "children": null,
  "data_path": "first_name",
  "display_label": "First Name",
  "format": null,
  "groups": null,
  "item_type": null,
  "iterator": null,
  "list_values_variable": null,
  "object": "data_type",
  "required": false,
  "source": "user",
  "type": "String",
  "value": "John"
}