Deel: Retrieve additional information fields for GP workers by country
Deel globalPayroll.retrieveAdditionalInformationFieldsForGpWorkersByCountry: arguments, response, policy and SDK examples.
← Global payroll operations · Get started
Operation deel.globalpayroll_retrieveadditionalinformationfieldsforgpworkersbycountry_v2026_01_01
Provider route: GET /forms/gp/worker-additional-fields/{country_code}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["globalPayroll"]["retrieveAdditionalInformationFieldsForGpWorkersByCountry"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.globalPayroll.retrieveAdditionalInformationFieldsForGpWorkersByCountry(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.global_payroll.retrieve_additional_information_fields_for_gp_workers_by_country(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.country_code | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve additional information fields for GP workers by country — 200 response body |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Retrieve additional information fields for GP workers by country — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Use this array to build the form UI. Each item defines one field with its type, validation, and display configuration. Items are pre-sorted by EDM display order. An empty array means no additional fields are configured for the requested country. |
data[] | Model | Each item | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item |
Referenced models: 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 — 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
Retrieve additional information fields for GP workers by country — 200 response body — data item validation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error_message | string | Required within parent | Use this message to display to the user when the field value fails validation. Defaults to 'Review the value entered' when no custom message is configured. |
type | string | Required within parent | Use this value to determine which validation strategy to apply. "REGEX" indicates the 'value' field contains a regular expression pattern. Any other value indicates a custom validation type identified by its uppercase name. |
value | string | Optional | Use this value as the validation parameter. For REGEX type, contains the regular expression pattern to validate the field input against. Absent when the validation type is a custom type that does not require a parameter. |
Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | Use this value to identify the field that this dependency refers to. Contains the snake_case key of the dependency field, matching another field's 'key' property in the same response. |
value | Model | Required within parent | Expand Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item value Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an array, the condition is satisfied when the referenced field equals any one of its entries. When the value is an object, apply the operator in 'op': 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'gte' (greater than or equal), 'lt' (less than), 'lte' (less than or equal), 'contains' (field value contains the specified substring) each compare against 'value', while 'notnull' takes no operand and is satisfied when the referenced field holds any non-empty value. |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item value
Retrieve additional information fields for GP workers by country — 200 response body — data item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | 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. Known values: string, number, boolean, "" (empty string) |
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]+)?$ |
Retrieve additional information fields for GP workers by country — 200 response body — data item dependencies item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an array, the condition is satisfied when the referenced field equals any one of its entries. When the value is an object, apply the operator in 'op': 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'gte' (greater than or equal), 'lt' (less than), 'lte' (less than or equal), 'contains' (field value contains the specified substring) each compare against 'value', while 'notnull' takes no operand and is satisfied when the referenced field holds any non-empty value. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | JSON | Alternative | |
$ (anyOf 2) (anyOf 1) | number | Alternative | Format: double |
$ (anyOf 2) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 3) | boolean | Alternative | |
$ (anyOf 4) | Model | Alternative | Expand Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: eq, ne, gt, gte, lt, lte, contains |
$ (anyOf 5) | Model | Alternative | Expand Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: notnull |
$ (anyOf 6) | array | Alternative | |
$ (anyOf 6)[] | string | Each item |
Referenced models: Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: eq, ne, gt, gte, lt, lte, contains, Retrieve additional information fields for GP workers by country — 200 response body — data / item / dependencies / item / value / op: notnull
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.globalpayroll_retrieveadditionalinformationfieldsforgpworkersbycountry_v2026_01_01. Catalog operation: globalpayroll_retrieveadditionalinformationfieldsforgpworkersbycountry_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["forms:read"]
Pinned headers: {"X-Version": "2026-01-01"}