Skip to content

Deel: Custom fields people schemas

31 Deel schemas with complete fields and constraints.

← Custom fields people operations · All schemas

Get custom field from people by id — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Get custom field from people by id — 200 response body — data

Referenced models: Get custom field from people by id — 200 response body — data

Get custom field from people by id — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalCreation date of the custom field
Format: date
descriptionstringOptionalDescription of the custom field
idstringOptionalCustom field id
Format: uuid
namestringOptionalName of the custom field
placementstringOptionalValid placements for custom field
Known values: profile, contract
settingsModelOptionalExpand Get custom field from people by id — 200 response body — data settings
typeModelOptionalExpand Get custom field from people by id — 200 response body — data type

Referenced models: Get custom field from people by id — 200 response body — data settings, Get custom field from people by id — 200 response body — data type

Get custom field from people by id — 200 response body — data / type / name: currency

FieldTypePresenceDescription and constraints
$objectRoot
currencystringOptionalCurrency code
is_fixedbooleanOptionalWhen currency is fixed, only the amount can be edited by the users
namestringOptionalCurrency type
Known values: currency

Get custom field from people by id — 200 response body — data / type / name: list, multiselect

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalList types
Known values: list, multiselect
optionsarrayOptionalList of options for the custom field
options[]stringEach item

Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalSimple types
Known values: text, number, date, percentage

Get custom field from people by id — 200 response body — data settings

FieldTypePresenceDescription and constraints
$objectRoot
accessModelOptionalExpand Get custom field from people by id — 200 response body — data settings access
Access settings for the custom field
countriesarrayOptionalCountries for which the custom field is applicable.
countries[]stringEach item
is_enabledbooleanOptionalWhether the custom field is enabled
requiredbooleanOptionalWhether the custom field is required
worker_typesarrayOptionalWorker types for which the custom field is applicable
worker_types[]stringEach itemKnown values: eor, contractor, hris_direct_employee, direct_employee

Referenced models: Get custom field from people by id — 200 response body — data settings access

Get custom field from people by id — 200 response body — data settings access

FieldTypePresenceDescription and constraints
$objectRootAccess settings for the custom field
is_sensitivebooleanOptionalWhether the custom field is sensitive
provided_byarrayOptionalEntities providing access to the custom field
provided_by[]stringEach itemKnown values: organization, worker

Get custom field from people by id — 200 response body — data type

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage
$ (anyOf 2)ModelAlternativeExpand Get custom field from people by id — 200 response body — data / type / name: currency
$ (anyOf 3)ModelAlternativeExpand Get custom field from people by id — 200 response body — data / type / name: list, multiselect

Referenced models: Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage, Get custom field from people by id — 200 response body — data / type / name: currency, Get custom field from people by id — 200 response body — data / type / name: list, multiselect

List all people custom fields — 200 response body

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

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

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

FieldTypePresenceDescription and constraints
$objectRoot
currencyJSONOptional
currency (anyOf 1)stringAlternativeCurrency code
Maximum length: 3
currency (anyOf 2)nullAlternativeCurrency code
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 people custom fields — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalCreation 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
idstringOptionalUnique identifier of the custom field
Format: uuid
namestringOptionalName of the custom field
Maximum length: 255
placementJSONOptionalValid placements for custom field
placement (anyOf 1)stringAlternativeValid placements for custom field
Known values: profile, contract
placement (anyOf 2)nullAlternative
settingsModelOptionalExpand List all people custom fields — 200 response body — data item settings
Settings for the custom field
typeModelOptionalExpand List all people custom fields — 200 response body — data item type
Type of the custom field

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

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

FieldTypePresenceDescription and constraints
$objectRootSettings for the custom field
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.
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
worker_types[]stringEach itemKnown values: eor, peo, contractor, hris_direct_employee, hris_direct_contractor, direct_employee, contractor_outside_deel, person_without_contract

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

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

FieldTypePresenceDescription and constraints
$JSONRootType of the custom field
$ (anyOf 1)ModelAlternativeExpand List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink
$ (anyOf 2)ModelAlternativeExpand List all people 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: list, multiselect, List all people custom fields — 200 response body — data / item / type / name: currency

Retrieve custom fields for a worker — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve custom fields for a worker — 200 response body — data item

Referenced models: Retrieve custom fields for a worker — 200 response body — data item

Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD

FieldTypePresenceDescription and constraints
$objectRootDate type: YYYY-MM-DD
valuestringOptionalFormat: date

Retrieve custom fields for a worker — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve custom fields for a worker — 200 response body — data item data
idstringRequired within parentUUID for the custom field value
Format: uuid
namestringRequired within parentName of the custom field
typestringRequired within parentType of the custom field
Known values: text, number, currency, date, percentage, list, multiselect, hyperlink

Referenced models: Retrieve custom fields for a worker — 200 response body — data item data

Retrieve custom fields for a worker — 200 response body — data item 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 Retrieve custom fields for a worker — 200 response body — data item 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 Retrieve custom fields for a worker — 200 response body — data item data Percentage type
$ (anyOf 5)ModelAlternativeExpand Retrieve custom fields for a worker — 200 response body — data item 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, 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, Retrieve custom fields for a worker — 200 response body — data item data Number type, Retrieve custom fields for a worker — 200 response body — data item data Percentage type, Retrieve custom fields for a worker — 200 response body — data item data Currency type

Retrieve custom fields for a worker — 200 response body — data item data Currency type

FieldTypePresenceDescription and constraints
$objectRootCurrency type
amountJSONOptional
amount (anyOf 1)numberAlternativeFormat: double
amount (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencystringOptionalThe currency code in ISO 4217 format

Retrieve custom fields for a worker — 200 response body — data item data List type

FieldTypePresenceDescription and constraints
$objectRootList type
optionstringOptional

Retrieve custom fields for a worker — 200 response body — data item data Multiselect type

FieldTypePresenceDescription and constraints
$objectRootMultiselect type
optionsarrayOptional
options[]stringEach item

Retrieve custom fields for a worker — 200 response body — data item data Number type

FieldTypePresenceDescription and constraints
$objectRootNumber type
valueJSONOptional
value (anyOf 1)numberAlternativeFormat: double
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve custom fields for a worker — 200 response body — data item data Percentage type

FieldTypePresenceDescription and constraints
$objectRootPercentage type
textstringOptional
valueJSONOptional
value (anyOf 1)numberAlternativeFormat: double
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve custom fields for a worker — 200 response body — data item data Text type

FieldTypePresenceDescription and constraints
$objectRootText type
valuestringOptional

Update custom field value — custom Fields People put Person Custom Field — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Update custom field value — custom Fields People put Person 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 People put Person Custom Field — request body — body data data

Update custom field value — custom Fields People put Person Custom Field — request body — body data data

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Update custom field value — custom Fields People put Person Custom Field — request body — body data data Text type
$ (anyOf 2)ModelAlternativeExpand Update custom field value — custom Fields People put Person Custom Field — request body — body data data Number type
$ (anyOf 3)ModelAlternativeExpand Update custom field value — customFieldsPeople.putPersonCustomField — request body — body / data / data / Date type: YYYY-MM-DD
$ (anyOf 4)ModelAlternativeExpand Update custom field value — custom Fields People put Person 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 Update custom field value — custom Fields People put Person Custom Field — request body — body data 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 Multiselect 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 People put Person Custom Field — request body — body data data Text type, Update custom field value — custom Fields People put Person Custom Field — request body — body data data Number type, Update custom field value — customFieldsPeople.putPersonCustomField — request body — body / data / data / Date type: YYYY-MM-DD, Update custom field value — custom Fields People put Person 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 List type

Update custom field value — custom Fields People put Person Custom Field — request body — body data data Currency type

FieldTypePresenceDescription and constraints
$objectRootCurrency type
amountnumberOptionalFormat: double
currencystringOptionalImportant: When currency type is fixed, the currency field is ignored.
Pattern: ^[A-Z]{3}$

Update custom field value — custom Fields People put Person Custom Field — request body — body data data List type

FieldTypePresenceDescription and constraints
$objectRootList type
optionstringOptionalOption type

Update custom field value — custom Fields People put Person Custom Field — request body — body data data Number type

FieldTypePresenceDescription and constraints
$objectRootNumber type
valuenumberOptionalNumber type
Format: double

Update custom field value — custom Fields People put Person Custom Field — request body — body data data Percentage type

FieldTypePresenceDescription and constraints
$objectRootPercentage type
valuenumberOptionalPercentage type
Format: double

Update custom field value — custom Fields People put Person Custom Field — request body — body data data Text type

FieldTypePresenceDescription and constraints
$objectRootText type
valuestringOptionalText type

Update custom field value — customFieldsPeople.putPersonCustomField — request body — body / data / data / Date type: YYYY-MM-DD

FieldTypePresenceDescription and constraints
$objectRootDate type: YYYY-MM-DD
valuestringOptionalDate type: YYYY-MM-DD
Format: date

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.