Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
CustomFields > Field

Creates a Field

Creates a Field

post/api/2026-07-01/resources/custom_fields/fields

Request body

company_idstring required

Company identifier where this field belongs

editable'owned' | 'reportees' | 'team_leader' | 'legal_entity' | 'everybody'

Group of employees that can edit the field

visible'owned' | 'reportees' | 'team_leader' | 'legal_entity' | 'everybody'

Group of employees that can see the field

labelstring

Field label

field_type'text' | 'long_text' | 'date' | 'rating' | 'checkbox' | 'single_choice' | 'multiple_choice' | 'money' | 'cents' required
min_valueinteger

Minimum value in range field type

max_valueinteger

Maximum value in range field type

requiredboolean

Requirement to fill this field

optionsstring[]

Array of options

positioninteger

Example request

{
  "company_id": "3",
  "editable": "owned",
  "visible": "everybody",
  "label": "T-Shirt Size",
  "min_value": 10,
  "required": true,
  "options": [
    true,
    false,
    "maybe"
  ]
}

Response

CREATED

idstring required

Field identifier

field_type'text' | 'long_text' | 'date' | 'rating' | 'checkbox' | 'single_choice' | 'multiple_choice' | 'money' | 'cents' required

The type of the field's value

label_textstring required

Field label

positioninteger

Field position within employee profile

requiredboolean

Requirement to fill this field

min_valueinteger

Minimum value in range field type

max_valueinteger

Maximum value in range field type

legal_entity_namestring

Legal entity name where this field belongs

legal_entity_idstring

Legal entity id where this field belongs

slugstring

Custom field slug

Example response

{
  "id": "2",
  "field_type": "text",
  "label_text": "T-Shirt Size",
  "position": 3,
  "required": true,
  "min_value": 10,
  "legal_entity_name": "Factorial Legal",
  "legal_entity_id": "1",
  "slug": "tshirt_size"
}