Skip to content

Deel: Custom fields contracts schemas

20 Deel schemas with complete fields and constraints.

← Custom fields contracts operations · All schemas

Get custom fields from contracts — 200 response body

FieldTypePresenceDescription and constraints
$objectRootResponse wrapper object
dataModelRequired within parentExpand Get custom fields from contracts — 200 response body — data
Custom field object

Referenced models: Get custom fields from contracts — 200 response body — data

Get custom fields from contracts — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRootCustom field object
created_atstringOptionalCreation timestamp
Format: date-time
descriptionJSONOptional
description (anyOf 1)stringAlternativeOptional description of the custom field
description (anyOf 2)nullAlternativeOptional description of the custom field
idstringOptionalCustom field id
Format: uuid
namestringOptionalName of the custom field
placementstringOptionalWhere the custom field is displayed
Known values: profile, contract
settingsModelOptionalExpand Get custom fields from contracts — 200 response body — data settings
Configuration settings for the custom field
typeModelOptionalExpand Get custom fields from contracts — 200 response body — data type
Type definition of the custom field

Referenced models: Get custom fields from contracts — 200 response body — data settings, Get custom fields from contracts — 200 response body — data type

Get custom fields from contracts — 200 response body — data / type / name: currency

FieldTypePresenceDescription and constraints
$objectRootCurrency custom field type
currencystringOptionalISO currency code
is_fixedbooleanOptionalWhether the currency is fixed
namestringOptionalCurrency field type
Known values: currency

Get custom fields from contracts — 200 response body — data / type / name: list, multiselect

FieldTypePresenceDescription and constraints
$objectRootList or multiselect custom field type
namestringOptionalList field type
Known values: list, multiselect
optionsarrayOptionalAvailable options for the list field
options[]stringEach item

Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink

FieldTypePresenceDescription and constraints
$objectRootSimple custom field types
namestringOptionalSimple field type
Known values: text, number, date, percentage, hyperlink

Get custom fields from contracts — 200 response body — data settings

FieldTypePresenceDescription and constraints
$objectRootConfiguration settings for the custom field
accessModelOptionalExpand Get custom fields from contracts — 200 response body — data settings access
Access control settings
countriesarrayOptionalCountries where the field applies
countries[]stringEach item
is_enabledbooleanOptionalWhether the field is enabled
requiredbooleanOptionalWhether the field is mandatory
worker_typesarrayOptionalApplicable worker types
worker_types[]stringEach itemWorker type
Known values: eor, contractor, hris_direct_employee, direct_employee

Referenced models: Get custom fields from contracts — 200 response body — data settings access

Get custom fields from contracts — 200 response body — data settings access

FieldTypePresenceDescription and constraints
$objectRootAccess control settings
is_sensitivebooleanOptionalWhether the field contains sensitive data
provided_byJSONOptionalEntity providing access
provided_by (anyOf 1)stringAlternativeEntity providing access
Known values: organization, worker
provided_by (anyOf 2)nullAlternative

Get custom fields from contracts — 200 response body — data type

FieldTypePresenceDescription and constraints
$JSONRootType definition of the custom field
$ (anyOf 1)ModelAlternativeExpand Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink
$ (anyOf 2)ModelAlternativeExpand Get custom fields from contracts — 200 response body — data / type / name: currency
$ (anyOf 3)ModelAlternativeExpand Get custom fields from contracts — 200 response body — data / type / name: list, multiselect

Referenced models: Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink, Get custom fields from contracts — 200 response body — data / type / name: currency, Get custom fields from contracts — 200 response body — data / type / name: list, multiselect

List all custom fields — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand List all custom fields — 200 response body — data item

Referenced models: List all custom fields — 200 response body — data item

List all custom fields — 200 response body — data / item / type / name: currency

FieldTypePresenceDescription and constraints
$objectRoot
currencyJSONOptional
currency (anyOf 1)stringAlternativeCurrency code (null when is_fixed is false)
Maximum length: 3
currency (anyOf 2)nullAlternativeCurrency code (null when is_fixed is false)
Maximum length: 3
is_fixedbooleanRequired within parentWhen currency is fixed, only the amount can be edited by the users
namestringRequired within parentCurrency type
Known values: currency

List all custom fields — 200 response body — data / item / type / name: list, multiselect

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentList types
Known values: list, multiselect
optionsarrayRequired within parentList of options for the custom field
options[]stringEach item

List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentSimple types
Known values: text, number, date, percentage, hyperlink

List all custom fields — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentCreation date of the custom field
Format: date-time
descriptionJSONOptional
description (anyOf 1)stringAlternativeDescription of the custom field
Maximum length: 140
description (anyOf 2)nullAlternativeDescription of the custom field
Maximum length: 140
idstringRequired within parentUnique identifier of the custom field
Format: uuid
namestringRequired within parentName of the custom field
placementJSONOptionalValid placements for custom field
placement (anyOf 1)stringAlternativeValid placements for custom field
Known values: profile, contract
placement (anyOf 2)nullAlternative
settingsModelRequired within parentExpand List all custom fields — 200 response body — data item settings
Configuration settings for the custom field including requirements, visibility, and access controls
typeModelRequired within parentExpand List all custom fields — 200 response body — data item type
Type configuration of the custom field including its data type and type-specific properties

Referenced models: List all custom fields — 200 response body — data item settings, List all custom fields — 200 response body — data item type

List all custom fields — 200 response body — data item settings

FieldTypePresenceDescription and constraints
$objectRootConfiguration settings for the custom field including requirements, visibility, and access controls
accessModelRequired within parentExpand List all custom fields — 200 response body — data item settings access
Access settings for the custom field
countriesarrayOptionalCountries for which the custom field is applicable. Omitted when applicable to all.
countries[]stringEach item
is_enabledbooleanRequired within parentWhether the custom field is enabled
requiredbooleanRequired within parentWhether the custom field is required
worker_typesarrayOptionalWorker types for which the custom field is applicable. Omitted when applicable to all.
worker_types[]stringEach itemKnown values: eor, contractor, hris_direct_employee, direct_employee

Referenced models: List all custom fields — 200 response body — data item settings access

List all custom fields — 200 response body — data item settings access

FieldTypePresenceDescription and constraints
$objectRootAccess settings for the custom field
group_permission_setJSONOptional
group_permission_set (anyOf 1)stringAlternativePermission set identifier for the custom field
group_permission_set (anyOf 2)nullAlternativePermission set identifier for the custom field
is_sensitivebooleanRequired within parentWhether the custom field is sensitive
provided_byJSONOptionalEntity providing access to the custom field
provided_by (anyOf 1)stringAlternativeEntity providing access to the custom field
Known values: organization, worker
provided_by (anyOf 2)nullAlternative

List all custom fields — 200 response body — data item type

FieldTypePresenceDescription and constraints
$JSONRootType configuration of the custom field including its data type and type-specific properties
$ (anyOf 1)ModelAlternativeExpand List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink
$ (anyOf 2)ModelAlternativeExpand List all custom fields — 200 response body — data / item / type / name: currency
$ (anyOf 3)ModelAlternativeExpand List all custom fields — 200 response body — data / item / type / name: list, multiselect

Referenced models: List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink, List all custom fields — 200 response body — data / item / type / name: currency, List all custom fields — 200 response body — data / item / type / name: list, multiselect

Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data
idstringRequired within parentUUID for the custom field value
Format: uuid

Referenced models: Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data

Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data Text type
$ (anyOf 2)ModelAlternativeExpand Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data Number type
$ (anyOf 3)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD
$ (anyOf 4)ModelAlternativeExpand Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data Percentage type
$ (anyOf 5)ModelAlternativeExpand Update custom field value — custom Fields People put Person Custom Field — request body — body data data Currency type
$ (anyOf 6)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data List type
$ (anyOf 7)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item data Multiselect type

Referenced models: Retrieve custom fields for a worker — 200 response body — data item data Text type, Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data Number type, Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD, Retrieve custom fields for a worker — 200 response body — data item data List type, Retrieve custom fields for a worker — 200 response body — data item data Multiselect type, Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data Percentage type, Update custom field value — custom Fields People put Person Custom Field — request body — body data data Currency type

Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data Number type

FieldTypePresenceDescription and constraints
$objectRootNumber type
valuenumberOptionalFormat: double

Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data Percentage type

FieldTypePresenceDescription and constraints
$objectRootPercentage type
valuenumberOptionalFormat: double

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.