Show Application Field

---

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

Returns the requested application field.

Parameters

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

Response

200

Requested application field.

Example

{
  "id": "A96ey16n",
  "type_of": "text",
  "accessor": "first_name",
  "required": true,
  "internal": 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	Application field id.
type_of	string	Type of the application field.
accessor	string	Accessor for the application field.
internal	boolean	Is the application field visible in the application form?
required	boolean	Is application field mandatory?
name_{locale}	string	Name of the application field in all locales of the business.
hint_{locale}	string	Hint for the application field in all locales of the business.
placeholder_{locale}	string	Placeholder for the application field in all locales of the business.
values	json[]	Possible values for the application field as seen in the values table below.

Values

info

While originally keys were unique in different locales and could therefore for example exist in german, but not in english, this is not supported by the API anymore and is considered bad practice.

If this occures to you, we recommend to add every key to every language in onboard or remove locale-specific keys entirely.

"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.

Application Field Types

Application 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.
date	string	cf_{number}	Date field for ISO 8601 timestamps.
datetime	string	cf_{number}	Datetime field for ISO 8601 datetime-timestamps.
gender	string	gender	Select field for genders. Possible values are: ["male", "female", "unknown", "diverse"].
first_name	string	first_name	Text field for applicant first name.
last_name	string	last_name	Text field for applicant last name.
email	string	email	Text field for applicant email address. Only accepts valid email addresses.
phone	string	phone	Text field for applicant phone number. Only accepts valid phone numbers.
tax_number	string	tax_number	Text field for valid italian tax numbers, like RSSMRA84A41F132U.
birthday	string	birthday	ISO 8601 timestamp field for applicant birthday.
nationality	string	nationality	Text field for nationality as ISO 3166-1 A2 country code.
residence_municipality_code	string	residence_municipality_code	Text field for 'codice catastale' of applicant residence. Italian codice catastale for municipalities. Italian codice catastale for countries.
birthplace_municipality_code	string	birthplace_municipality_code	Text field for 'codice catastale' of applicant birthplace. Italian codice catastale for municipalities. Italian codice catastale for countries.
birthplace	string	birthplace	Text field for applicant birthplace.
postal_code	string	postal_code	Text field for applicant postal code.
city	string	city	Text field for applicant city.
street	string	street	Text field for applicant street.
street_number	string	street_number	Text field for applicant street number.
region	string	region	Text field for applicant region.
country_code	string	country_code	Text field for applicant country code as ISO 3166-1 A2 country code.
photo_url	string	photo_url	Temporary url to applicant profile picture.
remove_photo	string	remove_photo	Photo will be removed when truthy value is passed.
cv_url	string	cv_url	Temporary url to applicant cv.
remove_cv	string	remove_cv	CV will be removed when truthy value is passed.
file_{1-10}_url	string	file_{1-10}_url	Temporary url to application file.
remove_file_{1-10}	string	remove_file_{1-10}	File will be removed when truthy value is passed.
video_url	string	video_url	Temporary url to video file.
remove_video	string	remove_video	Video will be removed when truthy value is passed.
notes	string	notes	Text input field for notes by applicant.