Skip to content

Deel: Forms schemas

14 Deel schemas with complete fields and constraints.

← Forms operations · All schemas

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 — 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 multiple EOR Contract forms — 200 response body — data item pages item sections item questions item

FieldTypePresenceDescription and constraints
$objectRoot
date_limitationJSONOptional
date_limitation (anyOf 1)stringAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.
date_limitation (anyOf 2)nullAlternativeLimits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now.
default_valueModelOptionalExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value
Default value to pre-fill in the form.
helper_textJSONOptional
helper_text (anyOf 1)stringAlternativeAdditional information to assist the user.
helper_text (anyOf 2)nullAlternativeAdditional information to assist the user.
is_disabledbooleanOptionalIf true, the field is disabled and cannot be edited.
is_multiple_selectionbooleanOptionalIndicates if the user can select multiple values.
is_only_digitsbooleanOptionalRestricts input to numeric characters only, for FreeText questions.
is_rangebooleanOptionalSpecifies whether a date picker allows range selection.
is_requiredbooleanOptionalIndicates if the question is required.
keystringRequired within parentUnique key identifier for the question.
max_lengthJSONOptional
max_length (anyOf 1)JSONAlternative
max_length (anyOf 1) (anyOf 1)integerAlternativeMaximum character length for text responses.
max_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max_length (anyOf 2)nullAlternativeMaximum character length for text responses.
max_valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value
Maximum value allowed.
min_lengthJSONOptional
min_length (anyOf 1)JSONAlternative
min_length (anyOf 1) (anyOf 1)integerAlternativeMinimum character length for text responses.
min_length (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
min_length (anyOf 2)nullAlternativeMinimum character length for text responses.
min_valueModelOptionalExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value
Minimum value allowed.
must_request_validationbooleanOptionalWhether additional validation should be triggered for this field.
number_typestringOptionalUsed for number fields to define the unit or representation.
optionsJSONOptional
options (anyOf 1)arrayAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 1)[]ModelEach itemExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
options (anyOf 2)nullAlternativeList of selectable options for selection-type questions. Value may be of any type.
options (anyOf 2)[]ModelEach itemExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item
rulesJSONOptional
rules (anyOf 1)arrayAlternativeValidation rules for the question.
rules (anyOf 1)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item
rules (anyOf 2)nullAlternativeValidation rules for the question.
rules (anyOf 2)[]ModelEach itemExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item
sourceJSONOptionalDefines dynamic data source for the question.
source (anyOf 1)ModelAlternativeExpand Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question
source (anyOf 2)nullAlternative
titlestringRequired within parentTitle of the question.
typestringRequired within parentType of the question.
Known values: FreeText, Paragraph, SingleSelection, MultiSelection, Address, PhoneNumber, DocumentUpload, Number, Dropdown, DatePicker, Email, CustomDropdown, PresetDropdown, Nested

Referenced models: Fetch EOR Contract form — 200 response body — data pages item sections item questions item source Defines dynamic data source for the question, Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item default value, Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item options null item, Fetch EOR Contract form — 200 response body — data pages item sections item questions item max value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item min value, Fetch EOR Contract form — 200 response body — data pages item sections item questions item rules Validation rules for the question item

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 — 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.

Get worker additional fields for (EOR) — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentArray of field configuration objects
data[]ModelEach itemExpand Get worker additional fields for (EOR) — 200 response body — data item

Referenced models: Get worker additional fields for (EOR) — 200 response body — data item

Get worker additional fields for (EOR) — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
dependenciesarrayRequired within parentArray of field dependencies that determine when this field should be displayed
dependencies[]ModelEach itemExpand Get worker additional fields for (EOR) — 200 response body — data item dependencies item
is_requiredbooleanRequired within parentIndicates if the field is required
keystringRequired within parentUnique identifier for the field
required_bystringOptionalIndicates when the field is required (e.g., sign_up, contract_signing)
typestringRequired within parentData type of the field
ui_guideModelRequired within parentExpand Get worker additional fields for (EOR) — 200 response body — data item ui guide
UI guidelines for rendering the field
validationarrayRequired within parentArray of validation rules to apply to the field input
validation[]ModelEach itemExpand Get worker additional fields for (EOR) — 200 response body — data item validation item
values_allowedarrayOptionalList of allowed values for select fields
values_allowed[]stringEach item

Referenced models: Get worker additional fields for (EOR) — 200 response body — data item validation item, Get worker additional fields for (EOR) — 200 response body — data item dependencies item, Get worker additional fields for (EOR) — 200 response body — data item ui guide

Get worker additional fields for (EOR) — 200 response body — data item dependencies item

FieldTypePresenceDescription and constraints
$objectRoot
keystringRequired within parentUnique identifier for the dependant field
valueModelRequired within parentExpand Get worker additional fields for (EOR) — 200 response body — data item dependencies item value
Value expected from dependant in order to display field. Can be a plain value or an object with an operator.

Referenced models: Get worker additional fields for (EOR) — 200 response body — data item dependencies item value

Get worker additional fields for (EOR) — 200 response body — data item dependencies item value

FieldTypePresenceDescription and constraints
$JSONRootValue expected from dependant in order to display field. Can be a plain value or an object with an operator.
$ (anyOf 1)stringAlternative
$ (anyOf 2)ModelAlternativeExpand Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value
$ (anyOf 3)arrayAlternative
$ (anyOf 3)[]stringEach item

Referenced models: Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value

Get worker additional fields for (EOR) — 200 response body — data item dependencies item value op, value

FieldTypePresenceDescription and constraints
$objectRoot
opstringRequired within parentComparison operator (e.g., gt, gte, lt, lte, eq, neq)
valueModelRequired within parentExpand Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value

Referenced models: Retrieve bank guide — global Payroll get Gp Contract Bank Guide — 200 response body — data item validations item value

Get worker additional fields for (EOR) — 200 response body — data item ui guide

FieldTypePresenceDescription and constraints
$objectRootUI guidelines for rendering the field
descriptionstringRequired within parentAdditional description for the field UI
field_typestringRequired within parentType of the input field in the UI
helper_textstringOptionalHelper text to guide user input
labelstringRequired within parentThe primary label for the field
local_labelstringOptionalLocalized version of the field label
orderJSONRequired within parent
order (anyOf 1)integerAlternativeDisplay order of the field in the UI
order (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get worker additional fields for (EOR) — 200 response body — data item validation item

FieldTypePresenceDescription and constraints
$objectRootValidation rules for the field
error_messagestringRequired within parentError message shown if the validation fails
typestringRequired within parentType of the validation
valuestringOptionalValue to be used in the validation according to the type

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.