Custom Field Section

CustomFieldSection is an entity that serves as a container for employee custom fields, enabling the grouping of those fields. Also in this way, employee custom fields cannot exist without belonging to a section.
Each employee custom field belongs to a specific section and has section_id set, while one section contains several possible employee custom fields.

For more details on how to work with custom fields please refer to Working with custom fields guide.

Following diagram shows custom field sections in our data hierarchy:

Custom Field SectionCustom Fields

Attributes

customizable_type object
Request

The type of resource whose custom fields this section groups (e.g. tasks, projects, people).

name string
Response Request

The display name of this custom field section.

organization organization
Response

The organization this custom field section belongs to.

position integer
Response Request

The display order position of this section among custom field sections.

status integer
Parameter `filter` Enum

The current status of the custom field section (e.g. active).

Enum Values (2 values)

  • 1
    Active
  • 2
    Archived

Examples

Loading example