Skip to content

Deel: Retrieve employee additional info template

Deel employeeInformation.employeeAdditionalInfoTemplate: arguments, response, policy and SDK examples.

← Employee information operations · Get started

Operation deel.employeeinformation_employeeadditionalinfotemplate_v2026_01_01

Provider route: GET /employee-info/contract-types/{type}/countries/{country}. 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["employeeInformation"]["employeeAdditionalInfoTemplate"]>[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.employeeInformation.employeeAdditionalInfoTemplate(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.employee_information.employee_additional_info_template(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.typestringRequired within parentOne of: eor, gp
path.countrystringRequired 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 Retrieve employee additional info template — 200 response body

Referenced models: Retrieve employee additional info template — 200 response body

3 more schemas are linked from the tables above, on the schema pages.

Retrieve employee additional info template — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Retrieve employee additional info template — 200 response body — data item

Referenced models: Retrieve employee additional info template — 200 response body — data item

Retrieve employee additional info template — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
aliasstringOptionalAlias for the field
can_be_skippedJSONOptional
can_be_skipped (anyOf 1)booleanAlternativeIndicates if the field can be skipped
can_be_skipped (anyOf 2)nullAlternativeIndicates if the field can be skipped
dependenciesJSONOptional
dependencies (anyOf 1)arrayAlternativeDependencies for the field
dependencies (anyOf 1)[]ModelEach itemExpand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item
dependencies (anyOf 2)nullAlternativeDependencies for the field
dependencies (anyOf 2)[]ModelEach itemExpand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item
dependency_condition_match_modeJSONOptionalCondition match mode for dependencies
dependency_condition_match_mode (anyOf 1)stringAlternativeCondition match mode for dependencies
Known values: ALL, ANY
dependency_condition_match_mode (anyOf 2)nullAlternative
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the field
description (anyOf 2)nullAlternativeDescription of the field
display_orderJSONOptional
display_order (anyOf 1)stringAlternativeDisplay order of the field
display_order (anyOf 2)nullAlternativeDisplay order of the field
footnoteJSONOptional
footnote (anyOf 1)stringAlternativeFootnote for the field
footnote (anyOf 2)nullAlternativeFootnote for the field
how_to_obtainJSONOptional
how_to_obtain (anyOf 1)stringAlternativeInstructions on how to obtain the field value
how_to_obtain (anyOf 2)nullAlternativeInstructions on how to obtain the field value
idstringOptionalUnique identifier for the field
input_configurationJSONOptionalConfiguration object for the input field. Present for input types that require additional format or display configuration, such as date fields.
input_configuration (anyOf 1)ModelAlternativeExpand Retrieve employee additional info template — 200 response body — data item input configuration format, type
input_configuration (anyOf 2)nullAlternative
input_typestringOptionalType of input for the field
is_optionalbooleanOptionalIndicates if the field is optional
labelstringOptionalLabel for the field
link_to_obtainJSONOptional
link_to_obtain (anyOf 1)stringAlternativeLink to obtain the field value
link_to_obtain (anyOf 2)nullAlternativeLink to obtain the field value
link_to_obtain_labelJSONOptional
link_to_obtain_label (anyOf 1)stringAlternativeLabel for the link to obtain the field value
link_to_obtain_label (anyOf 2)nullAlternativeLabel for the link to obtain the field value
local_nameJSONOptional
local_name (anyOf 1)stringAlternativeLocal name for the field
local_name (anyOf 2)nullAlternativeLocal name for the field
namestringOptionalName of the field
optionsJSONOptional
options (anyOf 1)arrayAlternativeOptions for select input type
options (anyOf 1)[]stringEach item
options (anyOf 2)nullAlternativeOptions for select input type
options (anyOf 2)[]stringEach item
required_bystringOptionalSpecifies when the field is required
validation_error_messageJSONOptional
validation_error_message (anyOf 1)stringAlternativeValidation error message for the field
validation_error_message (anyOf 2)nullAlternativeValidation error message for the field
validation_ruleJSONOptional
validation_rule (anyOf 1)stringAlternativeValidation rule for the field
validation_rule (anyOf 2)nullAlternativeValidation rule for the field

Referenced models: Retrieve employee additional info template — 200 response body — data item input configuration format, type, Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item

Retrieve employee additional info template — 200 response body — data item input configuration format, type
FieldTypePresenceDescription and constraints
$objectRootConfiguration object for the input field. Present for input types that require additional format or display configuration, such as date fields.
formatModelOptionalExpand Retrieve employee additional info template — 200 response body — data item input configuration format, type format
Format configuration for the input
typestringOptionalThe configuration type matching the input type

Referenced models: Retrieve employee additional info template — 200 response body — data item input configuration format, type format

Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalID of the dependency
valueModelOptionalExpand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value
Value the parent field is compared against. A bare scalar or array implies equality (membership for arrays); the object form specifies an explicit comparison operator, and requires value for every operator except notnull.

Referenced models: Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value

Retrieve employee additional info template — 200 response body — data item input configuration format, type format
FieldTypePresenceDescription and constraints
$objectRootFormat configuration for the input
patternstringOptionalDate format pattern
separatorstringOptionalSeparator character for the format
Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value
FieldTypePresenceDescription and constraints
$JSONRootValue the parent field is compared against. A bare scalar or array implies equality (membership for arrays); the object form specifies an explicit comparison operator, and requires value for every operator except notnull.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 3)booleanAlternative
$ (anyOf 4)ModelAlternativeExpand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value array
$ (anyOf 5)ModelAlternativeExpand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value value

Referenced models: Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value array, Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value value

Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value array
FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value array item

Referenced models: Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value array item

Retrieve employee additional info template — 200 response body — data / item / dependencies / Dependencies for the field / item / value / value / op: eq, ne, gt, gte, lt, lte, contains
FieldTypePresenceDescription and constraints
$objectRoot
opstringRequired within parentKnown values: eq, ne, gt, gte, lt, lte, contains

SDK function policy ID: deel.employeeinformation_employeeadditionalinfotemplate_v2026_01_01. Catalog operation: employeeinformation_employeeadditionalinfotemplate_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: ["contracts: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.