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.
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["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 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.forms.fetch_multiple_eor_contract_forms(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.limit | integer | Optional | Default: 10 Maximum: 10 Minimum: 1 |
query.cursor | string | Optional | |
body | object | Optional | |
body.data | Model | Required within parent | Expand Fetch multiple EOR Contract forms — request body — body data |
Referenced models: Fetch multiple EOR Contract forms — request body — body data
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 multiple EOR Contract forms — 200 response body |
Referenced models: Fetch multiple EOR Contract forms — 200 response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Fetch multiple EOR Contract forms — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_duration_in_days | integer | Optional | The contract duration in days for definite contracts. Minimum: 1 |
countries | array | Required within parent | Array of countries for which to fetch quote forms. Maximum 10 countries per request. |
countries[] | Model | Each item | Expand Fetch multiple EOR Contract forms — request body — body data countries item |
start_date | string | Optional | The selected start date of the contract in ISO 8601 formatted date string. Format: date |
work_hours_per_week | integer | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Array of quote forms for the requested countries. |
data[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item |
has_more | boolean | Required within parent | Indicates if there are more results available beyond the current page. |
next_cursor | JSON | Optional | |
next_cursor (anyOf 1) | string | Alternative | Cursor for fetching the next page of results. Null if no more results. |
next_cursor (anyOf 2) | null | Alternative | Cursor for fetching the next page of results. Null if no more results. |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of countries in the request. |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country_code | string | Required within parent | Two-letter country code in ISO 3166-1 alpha-2 format Maximum length: 2 Minimum length: 2 Pattern: ^[A-Z]{2}$ |
state | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
country | string | Required within parent | Two-letter country code in ISO 3166-1 alpha-2 format Pattern: ^[A-Z]{2}$ |
pages | array | Required within parent | List of pages in the form. |
pages[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item pages item |
state | JSON | Optional | |
state (anyOf 1) | string | Alternative | State or province code if applicable |
state (anyOf 2) | null | Alternative | State 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
sections | array | Required within parent | Sections within the page. |
sections[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item pages item sections item |
title | string | Required within parent | Title 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
questions | array | Required within parent | List of questions within the section. |
questions[] | Model | Each item | Expand Fetch multiple EOR Contract forms — 200 response body — data item 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 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
| 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 Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
title | string | Optional | Display text for the option. |
value | JSON | Optional | |
value (anyOf 1) | string | Alternative | Value associated with the option. |
value (anyOf 2) | null | Alternative | Value associated with the option. |
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 rules Validation rules for the question item requires item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
compare_key | JSON | Optional | |
compare_key (anyOf 1) | string | Alternative | Key of the field to compare against. |
compare_key (anyOf 2) | null | Alternative | Key of the field to compare against. |
key | string | Optional | Key of the dependent field. |
operator | JSON | Optional | |
operator (anyOf 1) | string | Alternative | Comparison operator (e.g., 'eq', 'ne'). |
operator (anyOf 2) | null | Alternative | Comparison operator (e.g., 'eq', 'ne'). |
value | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Expected value for the condition. |
$ (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 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}