Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.country_codestringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get worker additional fields for (EOR) — 200 response body

Referenced models: Get worker additional fields for (EOR) — 200 response body

Get worker additional fields for (EOR) — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentArray of field configuration objects
data[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
dependenciesarrayRequired within parentArray of field dependencies that determine when this field should be displayed
dependencies[]ModelEach itemExpand Get worker additional fields for (EOR) — 200 response body — data item dependencies item
is_requiredbooleanRequired within parentIndicates if the field is required
keystringRequired within parentUnique identifier for the field
required_bystringOptionalIndicates when the field is required (e.g., sign_up, contract_signing)
typestringRequired within parentData type of the field
ui_guideModelRequired within parentExpand Get worker additional fields for (EOR) — 200 response body — data item ui guide
UI guidelines for rendering the field
validationarrayRequired within parentArray of validation rules to apply to the field input
validation[]ModelEach itemExpand Get worker additional fields for (EOR) — 200 response body — data item validation item
values_allowedarrayOptionalList of allowed values for select fields
values_allowed[]stringEach 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
FieldTypePresenceDescription and constraints
$objectRootValidation rules for the field
error_messagestringRequired within parentError message shown if the validation fails
typestringRequired within parentType of the validation
valuestringOptionalValue to be used in the validation according to the type
Get worker additional fields for (EOR) — 200 response body — data item dependencies item
FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentUnique identifier for the dependant field
valueModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRootUI guidelines for rendering the field
descriptionstringRequired within parentAdditional description for the field UI
field_typestringRequired within parentType of the input field in the UI
helper_textstringOptionalHelper text to guide user input
labelstringRequired within parentThe primary label for the field
local_labelstringOptionalLocalized version of the field label
orderJSONRequired within parent
order (anyOf 1)integerAlternativeDisplay order of the field in the UI
order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Get worker additional fields for (EOR) — 200 response body — data item dependencies item value
FieldTypePresenceDescription and constraints
$JSONRootValue expected from dependant in order to display field. Can be a plain value or an object with an operator.
$ (anyOf 1)stringAlternative
$ (anyOf 2)ModelAlternativeExpand Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value
$ (anyOf 3)arrayAlternative
$ (anyOf 3)[]stringEach 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
FieldTypePresenceDescription and constraints
$objectRoot
opstringRequired within parentComparison operator (e.g., gt, gte, lt, lte, eq, neq)
valueModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.