CustomField object

An object representing a custom field associated with employees.

AttributesTypeDescription
idIntegerCustom field identifier.
typeStringThe object field type. Available types:

TextField, MultilineTextField, DateField, NumberField, CurrencyField, DropdownField, RadioField, CheckboxField, MultiCheckboxField.
labelStringThe custom field input label.
descriptionStringThe description or hint for a custom field.
requiredBooleanWhether or not the field is required to be completed.
internalBooleanWhen true, only admins can view and edit the field value. When false, it is expected that employees edit the field.
positionIntegerThe location (index) of the field on the screen in relation to other custom fields.
optionsFieldOptionsVarious options depending on the field type.