Quicklinks

Fields

Objects have default fields, with some fields only being available when workflow data is associated with an object. These fields cannot be deleted, but the % chance to close field and last modified field can both be hidden from view in the UI.

Custom Fields

Additional fields defined on an object are called custom fields. These fields can be hidden like some of the default fields, and can be deleted at any time.

When adding a custom field, an assortment of field types are supported, with unique validation logic and rules:

Field TypeLimits or RestrictionsTable Display Behavior
CheckboxIf value is null, considered uncheckedDisplays as text "yes" or "no"
Checkboxes
Date
DateTime
Number (Decimal)
Number (Integer)4 bytes
Dropdown
Dynamic Tags
EmailMust be a valid email formatDisplays as a clickable mailto link
Files10Mb limit
LongText
Text255 character limit
Money/Currency/Price
Phone NumberMust be a valid phone number
Radio Buttons
RatingConfigurable to allow a range of 5 or 10 values
RelationshipMultiple types of relationships:

- 1:1
- 1:Many
- Many:1
- Many:Many

Will also create an inverse relationship field.
Summary is displayed after 20 values on the timeline. API response for this field will be summarized if there are more than 100 field values*
StatusShows colored dots associated with each status
Team SelectorOnly displays active employees as options
Yes/No/Maybe"Maybe" is optional, can be set to only "Yes"/"No" as options

*When a relationship field response is summaried,  the API returns a value_summary. In this case, an additional call can be made to /api/custom_objects/{object_id}/fields/{field_id}/options to fetch all the non-summarized values.

Up Next

Further documentation on default fields for different objects.

Objects

Custom Objects are how data is modeled in Kizen. Learn more about interacting with them using the API.