Skip to main content

Represents Input Field data as accepted by the API

​
type
string
required

The type of Input Field

​
id
string
required

The identifier for this Input Field

​
default_value
string
required

The default value for this Input Field if not otherwise specified

​
depends_on
string[]
required

A list of dependencies for this Input Field

​
description
string
required

The description of this Input Field

​
format
enum<string>
required

The format of this Input Field from one of options provided

  • DATETIME - DATETIME
  • MULTILINE - MULTILINE
  • PASSWORD - PASSWORD
  • CODE - CODE
  • READONLY - READONLY
  • FILE - FILE
  • SELECT - SELECT
Available options:
DATETIME,
MULTILINE,
PASSWORD,
CODE,
READONLY,
FILE,
SELECT
​
invalidates_input_fields
boolean
required

Whether this Input Field invalidates

​
is_required
boolean
required

Whether this Input Field is required

​
items
object
required

A freeform object of items for this Input Field

​
placeholder
string
required

The placeholder for this Input Field when shown

​
title
string
required

The title of this Input Field

​
value_type
enum<string>
required

The type of the value of this Input Field

  • STRING - STRING
  • NUMBER - NUMBER
  • INTEGER - INTEGER
  • BOOLEAN - BOOLEAN
  • ARRAY - ARRAY
  • OBJECT - OBJECT
Available options:
STRING,
NUMBER,
INTEGER,
BOOLEAN,
ARRAY,
OBJECT