Deel: Retrieve additional information fields for GP workers by country — 200 response body — data item ui guide
Retrieve additional information fields for GP workers by country: 200 response body, field data / item / ui_guide. 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 ui guide
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text. |
description | string | Required within parent | Use this value to display supplementary context about the field below or beside the input. HTML tags are stripped. Returns an empty string when no description is configured. |
field_type | string | Required within parent | Use this value to select the appropriate UI input component. Represents the raw input type from the field configuration. Known values include ‘text’, ‘date’, ‘select’, ‘textarea’, ‘tel’, ‘phone’, ‘number’, ‘checkbox’, and ‘string’. Additional values may exist. |
helper_text | string | Required within parent | Use this value to display footnote or instructional text near the field. HTML tags are stripped. Returns an empty string when no helper text is configured. |
label | string | Required within parent | Use this value as the primary English-language label when rendering the field in the UI. |
local_label | string | Required within parent | Use this value as the localized field label when rendering the form in the worker’s local language. |
order | JSON | Required within parent | |
order (anyOf 1) | integer | Alternative | Use this value to determine the display position of the field in the form. Starts at 1 and reflects the position in the response array, which is pre-sorted by the configured display order. Minimum: 1 |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |