Deel: Retrieve employee additional info template — 200 response body — data item
Retrieve employee additional info template: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve employee additional info template — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
alias | string | Optional | Alias for the field |
can_be_skipped | JSON | Optional | |
can_be_skipped (anyOf 1) | boolean | Alternative | Indicates if the field can be skipped |
can_be_skipped (anyOf 2) | null | Alternative | Indicates if the field can be skipped |
dependencies | JSON | Optional | |
dependencies (anyOf 1) | array | Alternative | Dependencies for the field |
dependencies (anyOf 1)[] | Model | Each item | Expand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item |
dependencies (anyOf 2) | null | Alternative | Dependencies for the field |
dependencies (anyOf 2)[] | Model | Each item | Expand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item |
dependency_condition_match_mode | JSON | Optional | Condition match mode for dependencies |
dependency_condition_match_mode (anyOf 1) | string | Alternative | Condition match mode for dependencies Known values: ALL, ANY |
dependency_condition_match_mode (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the field |
description (anyOf 2) | null | Alternative | Description of the field |
display_order | JSON | Optional | |
display_order (anyOf 1) | string | Alternative | Display order of the field |
display_order (anyOf 2) | null | Alternative | Display order of the field |
footnote | JSON | Optional | |
footnote (anyOf 1) | string | Alternative | Footnote for the field |
footnote (anyOf 2) | null | Alternative | Footnote for the field |
how_to_obtain | JSON | Optional | |
how_to_obtain (anyOf 1) | string | Alternative | Instructions on how to obtain the field value |
how_to_obtain (anyOf 2) | null | Alternative | Instructions on how to obtain the field value |
id | string | Optional | Unique identifier for the field |
input_configuration | JSON | Optional | Configuration object for the input field. Present for input types that require additional format or display configuration, such as date fields. |
input_configuration (anyOf 1) | Model | Alternative | Expand Retrieve employee additional info template — 200 response body — data item input configuration format, type |
input_configuration (anyOf 2) | null | Alternative | |
input_type | string | Optional | Type of input for the field |
is_optional | boolean | Optional | Indicates if the field is optional |
label | string | Optional | Label for the field |
link_to_obtain | JSON | Optional | |
link_to_obtain (anyOf 1) | string | Alternative | Link to obtain the field value |
link_to_obtain (anyOf 2) | null | Alternative | Link to obtain the field value |
link_to_obtain_label | JSON | Optional | |
link_to_obtain_label (anyOf 1) | string | Alternative | Label for the link to obtain the field value |
link_to_obtain_label (anyOf 2) | null | Alternative | Label for the link to obtain the field value |
local_name | JSON | Optional | |
local_name (anyOf 1) | string | Alternative | Local name for the field |
local_name (anyOf 2) | null | Alternative | Local name for the field |
name | string | Optional | Name of the field |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | Options for select input type |
options (anyOf 1)[] | string | Each item | |
options (anyOf 2) | null | Alternative | Options for select input type |
options (anyOf 2)[] | string | Each item | |
required_by | string | Optional | Specifies when the field is required |
validation_error_message | JSON | Optional | |
validation_error_message (anyOf 1) | string | Alternative | Validation error message for the field |
validation_error_message (anyOf 2) | null | Alternative | Validation error message for the field |
validation_rule | JSON | Optional | |
validation_rule (anyOf 1) | string | Alternative | Validation rule for the field |
validation_rule (anyOf 2) | null | Alternative | Validation rule for the field |
Referenced models: Retrieve employee additional info template — 200 response body — data item input configuration format, type, Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item