Deel: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item
Retrieve ATS Application form: 200 response body, field data / form_builder_form / Form builder configuration / pages / item / sections / item / questions / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List of questions within the section |
date_limitation | JSON | Optional | |
date_limitation (anyOf 1) | string | Alternative | Limits date selection (e.g., blocking past dates). Will always be ‘BLOCK_PAST’ for now |
date_limitation (anyOf 2) | null | Alternative | Limits date selection (e.g., blocking past dates). Will always be ‘BLOCK_PAST’ for now |
default_value | JSON | Optional | |
default_value (anyOf 1) | string | Alternative | Default value to pre-fill in the form |
default_value (anyOf 2) | null | Alternative | Default value to pre-fill in the form |
has_request_validation | boolean | Optional | Whether additional validation should be triggered for this field |
helper_text | JSON | Optional | |
helper_text (anyOf 1) | string | Alternative | Additional information to assist the user |
helper_text (anyOf 2) | null | Alternative | Additional information to assist the user |
is_disabled | boolean | Optional | If true, the field is disabled and cannot be edited |
is_multiple_selection | boolean | Optional | Indicates if the user can select multiple values |
is_only_digits | boolean | Optional | Restricts input to numeric characters only, for FreeText questions |
is_range | boolean | Optional | Specifies whether a date picker allows range selection |
is_required | boolean | Optional | Indicates if the question is required |
key | string | Optional | Unique key identifier for the question |
max_length | JSON | Optional | |
max_length (anyOf 1) | JSON | Alternative | |
max_length (anyOf 1) (anyOf 1) | integer | Alternative | Maximum character length for text responses |
max_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_length (anyOf 2) | null | Alternative | Maximum character length for text responses |
max_value | JSON | Optional | |
max_value (anyOf 1) | JSON | Alternative | |
max_value (anyOf 1) (anyOf 1) | number | Alternative | Maximum value allowed Format: double |
max_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
max_value (anyOf 2) | null | Alternative | Maximum value allowed Format: double |
min_length | JSON | Optional | |
min_length (anyOf 1) | JSON | Alternative | |
min_length (anyOf 1) (anyOf 1) | integer | Alternative | Minimum character length for text responses |
min_length (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_length (anyOf 2) | null | Alternative | Minimum character length for text responses |
min_value | JSON | Optional | |
min_value (anyOf 1) | JSON | Alternative | |
min_value (anyOf 1) (anyOf 1) | number | Alternative | Minimum value allowed Format: double |
min_value (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
min_value (anyOf 2) | null | Alternative | Minimum value allowed Format: double |
number_type | string | Optional | Used for number fields to define the unit or representation |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | List of selectable options for selection-type questions |
options (anyOf 1)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item |
options (anyOf 2) | null | Alternative | List of selectable options for selection-type questions |
options (anyOf 2)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item |
rules | JSON | Optional | |
rules (anyOf 1) | array | Alternative | Validation rules for the question |
rules (anyOf 1)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item |
rules (anyOf 2) | null | Alternative | Validation rules for the question |
rules (anyOf 2)[] | Model | Each item | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item |
source | JSON | Optional | Defines dynamic data source for the question |
source (anyOf 1) | Model | Alternative | Expand Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question |
source (anyOf 2) | null | Alternative | |
title | string | Required within parent | Title of the question |
type | string | Required within parent | Type of the question Known values: FREETEXT, PARAGRAPH, SINGLESELECTION, MULTISELECTION, ADDRESS, PHONENUMBER, DOCUMENTUPLOAD, NUMBER, DROPDOWN, DATEPICKER, EMAIL, CUSTOMDROPDOWN, PRESETDROPDOWN, NESTED |
Referenced models: Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item source Defines dynamic data source for the question, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item options null item, Retrieve ATS Application form — 200 response body — data form builder form Form builder configuration pages item sections item questions item rules Validation rules for the question item