List Employee Job Fields

---

GET /services/api/v1/employee_job_fields

Returns a list of employee job fields.

Response

200

Results list.

Example

{
  "entries": [
    {
      "id": "RrB7LYD2",
      "type_of": "name",
      "accessor": "name",
      "name_de": "Bezeichnung",
      "name_it": "Mansione",
      "name_en": "Name",
      "hint_de": null,
      "hint_it": null,
      "hint_en": null,
      "placeholder_de": null,
      "placeholder_it": null,
      "placeholder_en": null,
      "values": null
    },
    {
      "id": "R5BPAYxp",
      "type_of": "time_type",
      "accessor": "time_type",
      "name_de": "Vollzeit/Teilzeit",
      "name_it": "Tipo Orario",
      "name_en": "Full-time/part-time",
      "hint_de": null,
      "hint_it": null,
      "hint_en": null,
      "placeholder_de": null,
      "placeholder_it": null,
      "placeholder_en": null,
      "values": [
        {
          "id": "full_time",
          "label_de": "Vollzeit",
          "label_it": "tempo pieno",
          "label_en": "full-time"
        },
        {
          "id": "horizontal_part_time",
          "label_de": "horizontale Teilzeit",
          "label_it": "tempo parziale orizzontale",
          "label_en": "horizontal part-time"
        },
        {
          "id": "vertical_part_time",
          "label_de": "vertikale Teilzeit",
          "label_it": "tempo parziale verticale",
          "label_en": "vertical part-time"
        },
        {
          "id": "mixed_part_time",
          "label_de": "gemischte Teilzeit",
          "label_it": "tempo parziale misto",
          "label_en": "mixed part-time"
        }
      ]
    }
  ],
  "current_page": 1,
  "per_page": 30,
  "total_entries": 2
}

Schema

Attribute	Type	Description
id	string	Employee job field id.
type_of	string	Type of the employee job field.
accessor	string	Accessor for the employee job field.
name_{locale}	string	Name of the employee job field in all locales of the business.
hint_{locale}	string	Hint for the employee job field in all locales of the business.
placeholder_{locale}	string	Placeholder for the employee job field in all locales of the business.
values	json[]	Possible values for the employee job field as seen in the values table below.

Values

"values": [
  {
    "id": "unknown",
    "label_de": "-",
    "label_it": "-",
    "label_en": "-",
  },
  {
    "id": "c1",
    "label_de": "C1 (ehemals A)",
    "label_it": "C1 (ex A)",
    "label_en": "C1 (formerly A)",
  },
  ...
]

Attribute	Type	Description
id	string	The identifier of the value
label_{locale}	string	Label of the employee field value in all locales of the business.

Employee Job Field Types

Employee Job Field Type	Type	Accessor	Description
text	string	cf_{number}	Short text string.
currency	float	cf_{number}	Float number input. Rounded to 2 decimals.
integer	integer	cf_{number}	Integer input.
float	integer	cf_{number}	Float input.
select_single	string	cf_{number}	Single value dropdown. Possible values are provided in the 'values' field.
select_multiple	string[]	cf_{number}	Multi value dropdown. Possible values are provided in the 'values' field.
select_radio	string	cf_{number}	Radio button select. Possible values are provided in the 'values' field.
checkbox	boolean	cf_{number}	Simple checkbox.
date	string	cf_{number}	Date field for ISO 8601 timestamps.
datetime	string	cf_{number}	Datetime field for ISO 8601 datetime-timestamps.
name	string	name	Short text string.
job_type	string	job_type	Select field for job types, for example "limited", "unlimited", "internship", "apprenticeship".
classification	string	classification	Text input field for employee classification.
time_table	string	time_table	Text input field for work times.
time_type	string	time_type	Select field for time types.
time_hours	integer	time_hours	Number input field for work hours.
time_percentage	integer	time_percentage	Worktime percentage. 0-100 with 3 decimal places.
location_id	string	location_id	Location id of the employee.
department_id	string	department_id	Department id of the employee.
supervisor_id	string	supervisor_id	Employee id of the supervisor.
notes	string	notes	Text input field.
work_days_per_week	integer	cf_{number}	Number input field for amount of work days per week. Allowed values are 1-7.