Deel: Get worker additional fields for (EOR)
Deel forms.getWorkerAdditionalFieldsForEor: arguments, response, policy and SDK examples.
← Forms operations · Get started
Operation deel.forms_getworkeradditionalfieldsforeor_v2026_01_01
Provider route: GET /forms/eor/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["forms"]["getWorkerAdditionalFieldsForEor"]>[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.forms.getWorkerAdditionalFieldsForEor(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.forms.get_worker_additional_fields_for_eor(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 Get worker additional fields for (EOR) — 200 response body |
Referenced models: Get worker additional fields for (EOR) — 200 response body
Schemas
Section titled “Schemas”Get worker additional fields for (EOR) — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Array of field configuration objects |
data[] | Model | Each item | Expand Get worker additional fields for (EOR) — 200 response body — data item |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item
Get worker additional fields for (EOR) — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dependencies | array | Required within parent | Array of field dependencies that determine when this field should be displayed |
dependencies[] | Model | Each item | Expand Get worker additional fields for (EOR) — 200 response body — data item dependencies item |
is_required | boolean | Required within parent | Indicates if the field is required |
key | string | Required within parent | Unique identifier for the field |
required_by | string | Optional | Indicates when the field is required (e.g., sign_up, contract_signing) |
type | string | Required within parent | Data type of the field |
ui_guide | Model | Required within parent | Expand Get worker additional fields for (EOR) — 200 response body — data item ui guide UI guidelines for rendering the field |
validation | array | Required within parent | Array of validation rules to apply to the field input |
validation[] | Model | Each item | Expand Get worker additional fields for (EOR) — 200 response body — data item validation item |
values_allowed | array | Optional | List of allowed values for select fields |
values_allowed[] | string | Each item |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item validation item, Get worker additional fields for (EOR) — 200 response body — data item dependencies item, Get worker additional fields for (EOR) — 200 response body — data item ui guide
Get worker additional fields for (EOR) — 200 response body — data item validation item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Validation rules for the field |
error_message | string | Required within parent | Error message shown if the validation fails |
type | string | Required within parent | Type of the validation |
value | string | Optional | Value to be used in the validation according to the type |
Get worker additional fields for (EOR) — 200 response body — data item dependencies item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
key | string | Required within parent | Unique identifier for the dependant field |
value | Model | Required within parent | Expand Get worker additional fields for (EOR) — 200 response body — data item dependencies item value Value expected from dependant in order to display field. Can be a plain value or an object with an operator. |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item dependencies item value
Get worker additional fields for (EOR) — 200 response body — data item ui guide
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | UI guidelines for rendering the field |
description | string | Required within parent | Additional description for the field UI |
field_type | string | Required within parent | Type of the input field in the UI |
helper_text | string | Optional | Helper text to guide user input |
label | string | Required within parent | The primary label for the field |
local_label | string | Optional | Localized version of the field label |
order | JSON | Required within parent | |
order (anyOf 1) | integer | Alternative | Display order of the field in the UI |
order (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get worker additional fields for (EOR) — 200 response body — data item dependencies item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Value expected from dependant in order to display field. Can be a plain value or an object with an operator. |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | Model | Alternative | Expand Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value |
$ (anyOf 3) | array | Alternative | |
$ (anyOf 3)[] | string | Each item |
Referenced models: Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value
Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
op | string | Required within parent | Comparison operator (e.g., gt, gte, lt, lte, eq, neq) |
value | Model | Required within parent | Expand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value |
Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (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]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.forms_getworkeradditionalfieldsforeor_v2026_01_01. Catalog operation: forms_getworkeradditionalfieldsforeor_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"}