Skip to content

Deel: Retrieve the Global Payroll worker creation schema — 200 response body — data item

Retrieve the Global Payroll worker creation schema: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Retrieve the Global Payroll worker creation schema — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
defaultJSONOptionalValue applied when the field is omitted.
dependenciesarrayOptionalOther fields this field is conditional on.
dependencies[]ModelEach itemExpand Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item
is_nullablebooleanOptionalWhether null is an accepted value.
is_requiredbooleanRequired within parentWhether the field must be provided for the given country, legal entity and payroll group.
keystringRequired within parentField to send, exactly as the create endpoint accepts it. Dotted for nested objects.
Maximum length: 200
Minimum length: 1
typestringRequired within parentTransport type of the field.
Known values: string, number, boolean, object, array
validationarrayOptionalConstraints applied to the value.
validation[]ModelEach itemExpand Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item
values_allowedarrayOptionalPermitted values, when the field is restricted to a fixed set. For contract_state these are the provinces of the country.
values_allowed[]JSONEach itemAny type

Referenced models: Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item, Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item

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.