Skip to content

Deel: EOR project assignment schemas

8 Deel schemas with complete fields and constraints.

← EOR project assignment operations · All schemas

Accept EOR project assignment as client — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
versionstringOptionalThis field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned.
Maximum length: 20
Minimum length: 20

Fetch Project Assignment Checkin Questionnaire Data — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data

Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data

Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentTimestamp indicating when the resource was created (ISO 8601).
Format: date-time
idstringRequired within parentUnique identifier of the resource
Format: uuid
sectionsarrayRequired within parentSections of questions
sections[]ModelEach itemExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item
updated_atstringRequired within parentTimestamp indicating when the resource was last updated (ISO 8601).
Format: date-time

Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item

Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item

FieldTypePresenceDescription and constraints
$objectRoot
questionsarrayRequired within parentList of questions within the section.
questions[]ModelEach itemExpand Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item
subtitlestringOptionalAdditional information shown at the top of the section.
titlestringRequired within parentTitle of the section.

Referenced models: Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item

Fetch Project Assignment Checkin Questionnaire Data — 200 response body — data sections item questions item

FieldTypePresenceDescription and constraints
$objectRoot
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.
is_only_digitsbooleanOptionalRestricts input to numeric characters only, for FreeText questions.
is_requiredbooleanOptionalIndicates if the question is required.
keystringRequired within parentUnique key identifier for the question.
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
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

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

Submit Project Assignment Checkin Questionnaire Data — request body — body data

FieldTypePresenceDescription and constraints
$objectRootForm submission payload containing respondent type, question answers, and optional version.
questions_with_answersobjectRequired within parentMap of question IDs to their corresponding answers.
Additional keys: see wildcard field
questions_with_answers.*stringAdditional keysMinimum length: 1
typestringRequired within parentIndicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'.
One of: EMPLOYEE, CLIENT
versionstringOptionalOptional version identifier of the form or schema.
Maximum length: 20

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.