Deel: Retrieve additional information fields for GP workers by country — 200 response body — data item
Retrieve additional information fields for GP workers by country: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve additional information fields for GP workers by country — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dependencies | array | Required within parent | Use this array to implement conditional field visibility. When non-empty, this field should only be displayed and required when the referenced dependency conditions are met. An empty array means the field has no conditional dependencies. |
dependencies[] | Model | Each item | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item |
is_required | boolean | Required within parent | Use this flag to determine whether the field must be provided when submitting additional information. For GP workers, the value considers the GP-specific optionality setting when available, falling back to the general optionality flag. |
key | string | Required within parent | Use this value as the field identifier when submitting additional information. Represents the snake_case version of the internal field name, generated by the API naming convention service. |
required_by | string | Optional | Use this value to determine at which stage in the payroll lifecycle this field must be collected. Known values: ‘before_payroll’ (required before payroll processing), ‘after_payroll’ (can be collected after initial payroll), ‘contract_signing’ (required at contract signing). Absent from the response when no lifecycle stage is configured. |
type | Model | Required within parent | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item type Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: ‘date’, ‘text’, ‘select’, ‘textarea’, ‘tel’, ‘phone’, and ‘string’ map to “string”; ‘number’ maps to “number”; ‘checkbox’ maps to “boolean”. An empty string indicates an unrecognized input type. |
ui_guide | Model | Required within parent | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item ui guide Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text. |
validation | array | Required within parent | Use this array to apply client-side validation before form submission. Contains zero or one validation rule per field. An empty array means no validation is configured. |
validation[] | Model | Each item | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item validation item |
values_allowed | array | Optional | Use this array to populate dropdown or select options when field_type is ‘select’. Only present when the field has predefined options. Absent from the response for free-text, date, number, and other non-select field types. |
values_allowed[] | string | Each item |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body — data item validation item, Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item, Retrieve additional information fields for GP workers by country — 200 response body — data item type, Retrieve additional information fields for GP workers by country — 200 response body — data item ui guide