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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
default | JSON | Optional | Value applied when the field is omitted. |
dependencies | array | Optional | Other fields this field is conditional on. |
dependencies[] | Model | Each item | Expand Retrieve the Global Payroll worker creation schema — 200 response body — data item dependencies item |
is_nullable | boolean | Optional | Whether null is an accepted value. |
is_required | boolean | Required within parent | Whether the field must be provided for the given country, legal entity and payroll group. |
key | string | Required within parent | Field to send, exactly as the create endpoint accepts it. Dotted for nested objects. Maximum length: 200 Minimum length: 1 |
type | string | Required within parent | Transport type of the field. Known values: string, number, boolean, object, array |
validation | array | Optional | Constraints applied to the value. |
validation[] | Model | Each item | Expand Retrieve the Global Payroll worker creation schema — 200 response body — data item validation item |
values_allowed | array | Optional | Permitted values, when the field is restricted to a fixed set. For contract_state these are the provinces of the country. |
values_allowed[] | JSON | Each item | Any 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