Skip to content

Properties

idstring
required·

The form field's unique identifier

answer_visibilitystring

The form field's answer visibility inside the ATS.

Possible values:
privatepublic
descriptionstring

The form field's description.

group_idstring

The form field's group identifier. If present, the form field is part of a group.

group_namestring

The form field's group name or label. If present, the form field is part of a group.

indexinteger

The form field's position inside a form. If group_id is present, the index is relative to the group.

is_requiredboolean

Whether the form field is required or not.

jobobject

The form field's job

idstring

Unique identifier of the job

labelstring

The form field's label.

namestring

The form field's name. Use this when submitting the application.

optionsobject[]

The form field's options. Only present for dropdown, radio and checkbox types.

idstring

The option's unique identifier

labelstring

The option's label

valuestring

The option's value

remote_dataRecord<string, any>

Raw data returned from the remote API call.

typestring

The form field's type. If no clear mapping exists, then raw value is returned.

Possible values:
texttextareadropdownfileradiocheckboxdatenumber