Skip to content

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.

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 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.eor_hiring.get_create_contract_form(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 parentMaximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
queryobjectOptionalAdditional keys: not allowed
query.statestringOptional
query.start_datestringOptionalFormat: date
query.work_hours_per_weekintegerOptionalMaximum: 168
Minimum: 1
query.contract_duration_in_daysintegerOptionalMinimum: 1

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch EOR Contract form — 200 response body

Referenced models: Fetch EOR Contract form — 200 response body

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

Fetch EOR Contract form — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
pagesarrayRequired within parentList of pages in the form.
pages[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeWhether the entire page is disabled for the selected country.
is_disabled (anyOf 2)nullAlternativeWhether the entire page is disabled for the selected country.
sectionsarrayRequired within parentSections within the page.
sections[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item
titlestringRequired within parentTitle 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
FieldTypePresenceDescription and constraints
$objectRoot
is_disabledJSONOptional
is_disabled (anyOf 1)booleanAlternativeWhether the entire section is disabled.
is_disabled (anyOf 2)nullAlternativeWhether the entire section is disabled.
questionsarrayRequired within parentList of questions within the section.
questions[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item
subtitlestringOptionalAdditional information shown at the top of the section.
titlestringRequired within parentTitle 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
FieldTypePresenceDescription and constraints
$objectRootA 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
FieldTypePresenceDescription and constraints
$objectRootDefines dynamic data source for the question.
definitionstringOptionalReference URL for API documentation.
descriptionstringOptionalDescription of the data source.
urlstringOptionalAPI endpoint providing dynamic options.
Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value
FieldTypePresenceDescription and constraints
$JSONRootDefault value to pre-fill in the form.
$ (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
Fetch EOR Contract form — 200 response body — data pages item sections item questions item additional info value
FieldTypePresenceDescription and constraints
$JSONRootCountry-specific metadata for the question. The shape depends on the question key: `employment.start_date` → payroll scheduling info; `employment.end_date` → definite-contract configuration; `compensation_details.salary` → salary bounds; `employment.holidays` → PTO bounds; `employment.probation_period` → probation rules; `employment.notice_period_type` → notice period rules matrix.
$ (anyOf 1)ModelAlternativeExpand 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
$ (anyOf 2)ModelAlternativeExpand 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
$ (anyOf 3)ModelAlternativeExpand 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
$ (anyOf 4)ModelAlternativeExpand 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
$ (anyOf 5)ModelAlternativeExpand 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
$ (anyOf 6)ModelAlternativeExpand 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

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
FieldTypePresenceDescription and constraints
$JSONRootMaximum value allowed.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value
FieldTypePresenceDescription and constraints
$JSONRootMinimum value allowed.
$ (anyOf 1)stringAlternative
$ (anyOf 2)JSONAlternative
$ (anyOf 2) (anyOf 1)numberAlternativeFormat: double
$ (anyOf 2) (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRootAdditional info for the `employment.notice_period_type` question.
notice_period_rule_typestringRequired within parentNotice-period rule type for the country (e.g. LIMITED_AGREEMENT, FIXED_AGREEMENT).
notice_period_settingsarrayRequired within parentNotice-period configuration, one entry per employment type and term combination.
notice_period_settings[]ModelEach itemExpand 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_unitstringRequired within parentPrimary display time unit for the notice period (DAY, WEEK, or MONTH).

Referenced models: 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

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

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.