Show Employee Field

---

GET /services/api/v1/employee_fields/{id}

Returns the requested employee field.

Parameters

Parameter	Type	Description
id	string	The ID of the employee field.

Response

200

Requested employee field.

Example

{
  "id": "A96ey16n",
  "type_of": "text",
  "accessor": "first_name",
  "required": true,
  "unique": false,
  "name_de": "Vorname",
  "name_it": "Nome",
  "name_en": "First name",
  "hint_de": null,
  "hint_it": null,
  "hint_en": null,
  "placeholder_de": null,
  "placeholder_it": null,
  "placeholder_en": null,
  "values": null
}

Schema

Attribute	Type	Description
id	string	Employee field id.
type_of	string	Type of the employee field.
accessor	string	Accessor for the employee field.
required	boolean	Is employee field mandatory?
unique	boolean	Is the value of the field unique for each employee?
name_{locale}	string	Name of the employee field in all locales of the business.
hint_{locale}	string	Hint for the employee field in all locales of the business.
placeholder_{locale}	string	Placeholder for the employee field in all locales of the business.
values	json[]	Possible values for the employee 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 Field Types

Employee Field Type	Type	Accessor	Description
text	string	cf_{number}	Short text string.
textarea	string	cf_{number}	Longer text string with line breaks.
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.
country	string	cf_{number}	Text field only accepting valid ISO 3166-1 A2 country code.
custom_phone	string	cf_{number}	Text field for custom phone numbers.
custom_email	string	cf_{number}	Text field for custom email address. Only accepts valid email addresses.
date	string	cf_{number}	Date field for ISO 8601 timestamps.
datetime	string	cf_{number}	Datetime field for ISO 8601 datetime-timestamps.
photo_url	string	cf_{number}	Temporary url to picture.
link	string	cf_{number}	Text field for links.
gender	string	gender	Select field for genders. Possible values are: ["male", "female", "unknown", "diverse"].
first_name	string	first_name	Text field for employee first name.
last_name	string	last_name	Text field for employee last name.
email	string	email	Text field for employee email address. Only accepts valid email addresses.
phone	string	phone	Text field for employee phone number. Only accepts valid phone numbers.
tax_number	string	tax_number	Text field for valid italian tax numbers, like RSSMRA84A41F132U.
social_security_number	string	social_security_number	Text field for austrian social security number, like 1234 567890.
tax_identification_number	string	tax_identification_number	Text field for german tax identification number. Only accepts 10-11 digit versions.
birthday	string	birthday	ISO 8601 timestamp field for employee birthday.
passport	string	passport	Text field for passport.
nationality	string	nationality	Text field for nationality as ISO 3166-1 A2 country code.
employee_number	string	employee_number	Text field for employee personnel number.
iban	string	iban	Text field for employee IBAN, like DE27100777770209299700.
swift	string	swift	Text field for SWIFT codex, like UNCRITMMXXX.
residence_municipality_code	string	residence_municipality_code	Text field for 'codice catastale' of employee residence. Italian codice catastale for municipalities. Italian codice catastale for countries.
birthplace_municipality_code	string	birthplace_municipality_code	Text field for 'codice catastale' of employee birthplace. Italian codice catastale for municipalities. Italian codice catastale for countries.
birthplace	string	birthplace	Text field for employee birthplace.
postal_code	string	postal_code	Text field for employee postal code.
city	string	city	Text field for employee city.
company_phone	string	company_phone	Text field for employee company phone. Only accepts valid phone numbers.
company_email	string	company_email	Text field for employee company email. Only accepts valid email address.
street	string	street	Text field for employee street.
street_number	string	street_number	Text field for employee street number.
region	string	region	Text field for employee region.
country_code	string	country_code	Text field for employee country code as ISO 3166-1 A2 country code.