Skip to content

JobFormFields Object ​



id
string
REQUIRED · The form field's unique identifier
name
string
The form field's name. Use this when submitting the application.
job
object
The form field's job
id
string
Unique identifier of the job
label
string
The form field's label.
index
integer
The form field's position inside a form. If `group_id` is present, the index is relative to the group.
is_required
boolean
Whether the form field is required or not.
answer_visibility
string
The form field's answer visibility inside the ATS.
All possible enum values:
  • private
  • public
description
string
The form field's description.
type
string
The form field's type. If no clear mapping exists, then raw value is returned.
All possible enum values:
  • text
  • textarea
  • dropdown
  • file
  • radio
  • checkbox
  • date
  • number
options
object[]
The form field's options. Only present for dropdown, radio and checkbox types.
id
string
The option's unique identifier
label
string
The option's label
value
string
The option's value
group_id
string
The form field's group identifier. If present, the form field is part of a group.
group_name
string
The form field's group name or label. If present, the form field is part of a group.
remote_data
object
Raw data returned from the remote API call.