Skip to main content

The Field Object

{
"id": "fld_6lUmhjszoQzO6I8IGRtG8QWR",
"name": "Status",
"type": "checkbox",
"options": null,
"create_time": 1704786716,
"update_time": 1704786716
}

Parameters

{
"name": "Status",
"type": "checkbox"
}

ParameterTypeRequiredDescription
namestringYesname of the field
typestringYestype of the field
optionsarray of the option objectNooptions of the field, only for singleSelect and multipleSelects field
The option object

Example:

{
"color": "red1",
"text": "Option 1"
}

Defination:

ParameterTypeRequiredDescription
textstringYestext of the option
colorstringYescolor of the option

The color should be one of:

  • gray1
  • gray2
  • gray3
  • red1
  • red2
  • red3
  • orange1
  • orange2
  • orange3
  • yellow1
  • yellow2
  • yellow3
  • green1
  • green2
  • green3
  • cyan1
  • cyan2
  • cyan3
  • blue1
  • blue2
  • blue3
  • violet1
  • violet2
  • violet3
  • fuchsia1
  • fuchsia2
  • fuchsia3
  • pink1
  • pink2
  • pink3

Response

{
"id": "fld_6lUmhjszoQzO6I8IGRtG8QWR",
"name": "Status",
"type": "checkbox",
"options": null,
"create_time": 1704786716,
"update_time": 1704786716
}