Skip to content

Deel: Fetch multiple EOR Contract forms

Deel forms.fetchMultipleEorContractForms: arguments, response, policy and SDK examples.

← Forms operations · Get started

Operation deel.forms_fetchmultipleeorcontractforms_v2026_01_01

Provider route: POST /forms/eor/create-contract/definitions. 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"]["fetchMultipleEorContractForms"]>[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.fetchMultipleEorContractForms(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.fetch_multiple_eor_contract_forms(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 10
Maximum: 10
Minimum: 1
query.cursorstringOptional
bodyobjectOptional
body.dataModelRequired within parentExpand Fetch multiple EOR Contract forms — request body — body data

Referenced models: Fetch multiple EOR Contract forms — request body — body data

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

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

Referenced models: Fetch multiple EOR Contract forms — 200 response body

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

Fetch multiple EOR Contract forms — request body — body data
FieldTypePresenceDescription and constraints
$objectRoot
contract_duration_in_daysintegerOptionalThe contract duration in days for definite contracts.
Minimum: 1
countriesarrayRequired within parentArray of countries for which to fetch quote forms. Maximum 10 countries per request.
countries[]ModelEach itemExpand Fetch multiple EOR Contract forms — request body — body data countries item
start_datestringOptionalThe selected start date of the contract in ISO 8601 formatted date string.
Format: date
work_hours_per_weekintegerOptionalThe selected number of work hours per week.
Maximum: 168
Minimum: 1

Referenced models: Fetch multiple EOR Contract forms — request body — body data countries item

Fetch multiple EOR Contract forms — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentArray of quote forms for the requested countries.
data[]ModelEach itemExpand Fetch multiple EOR Contract forms — 200 response body — data item
has_morebooleanRequired within parentIndicates if there are more results available beyond the current page.
next_cursorJSONOptional
next_cursor (anyOf 1)stringAlternativeCursor for fetching the next page of results. Null if no more results.
next_cursor (anyOf 2)nullAlternativeCursor for fetching the next page of results. Null if no more results.
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of countries in the request.
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Fetch multiple EOR Contract forms — 200 response body — data item

Fetch multiple EOR Contract forms — request body — body data countries item
FieldTypePresenceDescription and constraints
$objectRoot
country_codestringRequired within parentTwo-letter country code in ISO 3166-1 alpha-2 format
Maximum length: 2
Minimum length: 2
Pattern: ^[A-Z]{2}$
statestringOptionalThe selected state code of the contract. This is only required for countries that specify it.
Fetch multiple EOR Contract forms — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
countrystringRequired within parentTwo-letter country code in ISO 3166-1 alpha-2 format
Pattern: ^[A-Z]{2}$
pagesarrayRequired within parentList of pages in the form.
pages[]ModelEach itemExpand Fetch multiple EOR Contract forms — 200 response body — data item pages item
stateJSONOptional
state (anyOf 1)stringAlternativeState or province code if applicable
state (anyOf 2)nullAlternativeState or province code if applicable

Referenced models: Fetch multiple EOR Contract forms — 200 response body — data item pages item

Fetch multiple EOR Contract forms — 200 response body — data item pages item
FieldTypePresenceDescription and constraints
$objectRoot
sectionsarrayRequired within parentSections within the page.
sections[]ModelEach itemExpand Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item
titlestringRequired within parentTitle of the form page.

Referenced models: Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item

Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item
FieldTypePresenceDescription and constraints
$objectRoot
questionsarrayRequired within parentList of questions within the section.
questions[]ModelEach itemExpand Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item questions item
subtitlestringOptionalAdditional information shown at the top of the section.
titlestringRequired within parentTitle of the section.

Referenced models: Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item questions item

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 Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
FieldTypePresenceDescription and constraints
$objectRoot
titlestringOptionalDisplay text for the option.
valueJSONOptional
value (anyOf 1)stringAlternativeValue associated with the option.
value (anyOf 2)nullAlternativeValue associated with the option.
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 rules Validation rules for the question item requires item
FieldTypePresenceDescription and constraints
$objectRoot
compare_keyJSONOptional
compare_key (anyOf 1)stringAlternativeKey of the field to compare against.
compare_key (anyOf 2)nullAlternativeKey of the field to compare against.
keystringOptionalKey of the dependent field.
operatorJSONOptional
operator (anyOf 1)stringAlternativeComparison operator (e.g., 'eq', 'ne').
operator (anyOf 2)nullAlternativeComparison operator (e.g., 'eq', 'ne').
valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item value
Expected value for the condition.

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item value

Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item requires item value
FieldTypePresenceDescription and constraints
$JSONRootExpected value for the condition.
$ (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

SDK function policy ID: deel.forms_fetchmultipleeorcontractforms_v2026_01_01. Catalog operation: forms_fetchmultipleeorcontractforms_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.