Deel: Fetch EOR Contract form
Deel eorHiring.getCreateContractForm: arguments, response, policy and SDK examples.
← EOR hiring operations · Get started
Operation deel.eorhiring_getcreatecontractform
Provider route: GET /forms/eor/create-contract/{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["eorHiring"]["getCreateContractForm"]>[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.eorHiring.getCreateContractForm(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.eor_hiring.get_create_contract_form(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 | Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
query | object | Optional | Additional keys: not allowed |
query.state | string | Optional | |
query.start_date | string | Optional | Format: date |
query.work_hours_per_week | integer | Optional | Maximum: 168 Minimum: 1 |
query.contract_duration_in_days | integer | Optional | Minimum: 1 |
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 Fetch EOR Contract form — 200 response body |
Referenced models: Fetch EOR Contract form — 200 response body
Schemas
Section titled “Schemas”20 more schemas are linked from the tables above, on the schema pages.
Fetch EOR Contract form — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Fetch EOR Contract form — 200 response body — data |
Referenced models: Fetch EOR Contract form — 200 response body — data
Fetch EOR Contract form — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
pages | array | Required within parent | List of pages in the form. |
pages[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item |
Referenced models: Fetch EOR Contract form — 200 response body — data pages item
Fetch EOR Contract form — 200 response body — data pages item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Whether the entire page is disabled for the selected country. |
is_disabled (anyOf 2) | null | Alternative | Whether the entire page is disabled for the selected country. |
sections | array | Required within parent | Sections within the page. |
sections[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item |
title | string | Required within parent | Title of the form page. |
Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item
Fetch EOR Contract form — 200 response body — data pages item sections item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_disabled | JSON | Optional | |
is_disabled (anyOf 1) | boolean | Alternative | Whether the entire section is disabled. |
is_disabled (anyOf 2) | null | Alternative | Whether the entire section is disabled. |
questions | array | Required within parent | List of questions within the section. |
questions[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item |
subtitle | string | Optional | Additional information shown at the top of the section. |
title | string | Required within parent | Title of the section. |
Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item
Fetch EOR Contract form — 200 response body — data pages item sections item questions item questions null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single child question within a Nested parent. |
Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Defines dynamic data source for the question. |
definition | string | Optional | Reference URL for API documentation. |
description | string | Optional | Description of the data source. |
url | string | Optional | API endpoint providing dynamic options. |
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Default value to pre-fill in the form. |
$ (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 |
Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value
Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value is same month payment country, min value buffer in days, payroll lock, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value maximum limitation in months, min value buffer in days, type, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value additional payments, max salary, min salary, part time holiday type, standard hours per week, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value max holidays, min holidays, part time holiday type, standard hours per week, Fetch EOR Contract form — 200 response body — data / pages / item / sections / item / questions / item / additional_info / value / probation_type_for_definite: STANDARD, SPECIFIC CALCULATION, SPECIFIC TO DURATION OF CONTRACT, Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit
Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Maximum value allowed. |
$ (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]+)?$ |
Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Minimum value allowed. |
$ (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]+)?$ |
Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional info for the `employment.notice_period_type` question. |
notice_period_rule_type | string | Required within parent | Notice-period rule type for the country (e.g. LIMITED_AGREEMENT, FIXED_AGREEMENT). |
notice_period_settings | array | Required within parent | Notice-period configuration, one entry per employment type and term combination. |
notice_period_settings[] | Model | Each item | Expand Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value notice period rule type, notice period settings, notice period time unit notice period settings item |
notice_period_time_unit | string | Required within parent | Primary display time unit for the notice period (DAY, WEEK, or MONTH). |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.eorhiring_getcreatecontractform. Catalog operation: eorhiring_getcreatecontractform. 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"}