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.
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["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 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.employee_information.employee_additional_info_template(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.type | string | Required within parent | One of: eor, gp |
path.country | 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 employee additional info template — 200 response body |
Referenced models: Retrieve employee additional info template — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Retrieve employee additional info template — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
alias | string | Optional | Alias for the field |
can_be_skipped | JSON | Optional | |
can_be_skipped (anyOf 1) | boolean | Alternative | Indicates if the field can be skipped |
can_be_skipped (anyOf 2) | null | Alternative | Indicates if the field can be skipped |
dependencies | JSON | Optional | |
dependencies (anyOf 1) | array | Alternative | Dependencies for the field |
dependencies (anyOf 1)[] | Model | Each item | Expand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item |
dependencies (anyOf 2) | null | Alternative | Dependencies for the field |
dependencies (anyOf 2)[] | Model | Each item | Expand Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item |
dependency_condition_match_mode | JSON | Optional | Condition match mode for dependencies |
dependency_condition_match_mode (anyOf 1) | string | Alternative | Condition match mode for dependencies Known values: ALL, ANY |
dependency_condition_match_mode (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the field |
description (anyOf 2) | null | Alternative | Description of the field |
display_order | JSON | Optional | |
display_order (anyOf 1) | string | Alternative | Display order of the field |
display_order (anyOf 2) | null | Alternative | Display order of the field |
footnote | JSON | Optional | |
footnote (anyOf 1) | string | Alternative | Footnote for the field |
footnote (anyOf 2) | null | Alternative | Footnote for the field |
how_to_obtain | JSON | Optional | |
how_to_obtain (anyOf 1) | string | Alternative | Instructions on how to obtain the field value |
how_to_obtain (anyOf 2) | null | Alternative | Instructions on how to obtain the field value |
id | string | Optional | Unique identifier for the field |
input_configuration | JSON | Optional | Configuration object for the input field. Present for input types that require additional format or display configuration, such as date fields. |
input_configuration (anyOf 1) | Model | Alternative | Expand Retrieve employee additional info template — 200 response body — data item input configuration format, type |
input_configuration (anyOf 2) | null | Alternative | |
input_type | string | Optional | Type of input for the field |
is_optional | boolean | Optional | Indicates if the field is optional |
label | string | Optional | Label for the field |
link_to_obtain | JSON | Optional | |
link_to_obtain (anyOf 1) | string | Alternative | Link to obtain the field value |
link_to_obtain (anyOf 2) | null | Alternative | Link to obtain the field value |
link_to_obtain_label | JSON | Optional | |
link_to_obtain_label (anyOf 1) | string | Alternative | Label for the link to obtain the field value |
link_to_obtain_label (anyOf 2) | null | Alternative | Label for the link to obtain the field value |
local_name | JSON | Optional | |
local_name (anyOf 1) | string | Alternative | Local name for the field |
local_name (anyOf 2) | null | Alternative | Local name for the field |
name | string | Optional | Name of the field |
options | JSON | Optional | |
options (anyOf 1) | array | Alternative | Options for select input type |
options (anyOf 1)[] | string | Each item | |
options (anyOf 2) | null | Alternative | Options for select input type |
options (anyOf 2)[] | string | Each item | |
required_by | string | Optional | Specifies when the field is required |
validation_error_message | JSON | Optional | |
validation_error_message (anyOf 1) | string | Alternative | Validation error message for the field |
validation_error_message (anyOf 2) | null | Alternative | Validation error message for the field |
validation_rule | JSON | Optional | |
validation_rule (anyOf 1) | string | Alternative | Validation rule for the field |
validation_rule (anyOf 2) | null | Alternative | Validation 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration object for the input field. Present for input types that require additional format or display configuration, such as date fields. |
format | Model | Optional | Expand Retrieve employee additional info template — 200 response body — data item input configuration format, type format Format configuration for the input |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | ID of the dependency |
value | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Format configuration for the input |
pattern | string | Optional | Date format pattern |
separator | string | Optional | Separator character for the format |
Retrieve employee additional info template — 200 response body — data item dependencies Dependencies for the field item value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | 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. |
$ (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 employee additional info template — 200 response body — data item dependencies Dependencies for the field item value array |
$ (anyOf 5) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
op | string | Required within parent | Known values: eq, ne, gt, gte, lt, lte, contains |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}