CustomField object

An object representing a custom field associated with employees.

Attributes

Type

Description

id

Integer

Custom field identifier.

type

String

The object field type. Available types:

TextField, MultilineTextField, DateField, NumberField, CurrencyField, DropdownField, RadioField, CheckboxField, MultiCheckboxField.

label

String

The custom field input label.

description

String

The description or hint for a custom field.

required

Boolean

Whether or not the field is required to be completed.

internal

Boolean

When true, only admins can view and edit the field value. When false, it is expected that employees edit the field.

position

Integer

The location (index) of the field on the screen in relation to other custom fields.

options

FieldOptions

Various options depending on the field type.