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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation date of the custom field Format: date |
description | string | Optional | Description of the custom field |
id | string | Optional | Custom field id Format: uuid |
name | string | Optional | Name of the custom field |
placement | string | Optional | Valid placements for custom field Known values: profile, contract |
settings | Model | Optional | Expand Get custom field from people by id — 200 response body — data settings |
type | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | string | Optional | Currency code |
is_fixed | boolean | Optional | When currency is fixed, only the amount can be edited by the users |
name | string | Optional | Currency type Known values: currency |
Get custom field from people by id — 200 response body — data / type / name: list, multiselect
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | List types Known values: list, multiselect |
options | array | Optional | List of options for the custom field |
options[] | string | Each item |
Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | Simple types Known values: text, number, date, percentage |
Get custom field from people by id — 200 response body — data settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
access | Model | Optional | Expand Get custom field from people by id — 200 response body — data settings access Access settings for the custom field |
countries | array | Optional | Countries for which the custom field is applicable. |
countries[] | string | Each item | |
is_enabled | boolean | Optional | Whether the custom field is enabled |
required | boolean | Optional | Whether the custom field is required |
worker_types | array | Optional | Worker types for which the custom field is applicable |
worker_types[] | string | Each item | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Access settings for the custom field |
is_sensitive | boolean | Optional | Whether the custom field is sensitive |
provided_by | array | Optional | Entities providing access to the custom field |
provided_by[] | string | Each item | Known values: organization, worker |
Get custom field from people by id — 200 response body — data type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Get custom field from people by id — 200 response body — data / type / name: text, number, date, percentage |
$ (anyOf 2) | Model | Alternative | Expand Get custom field from people by id — 200 response body — data / type / name: currency |
$ (anyOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Currency code Maximum length: 3 |
currency (anyOf 2) | null | Alternative | Currency code Maximum length: 3 |
is_fixed | boolean | Required within parent | When currency is fixed, only the amount can be edited by the users |
name | string | Required within parent | Currency type Known values: currency |
List all people custom fields — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | Creation date of the custom field Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Description of the custom field Maximum length: 140 |
description (anyOf 2) | null | Alternative | Description of the custom field Maximum length: 140 |
id | string | Optional | Unique identifier of the custom field Format: uuid |
name | string | Optional | Name of the custom field Maximum length: 255 |
placement | JSON | Optional | Valid placements for custom field |
placement (anyOf 1) | string | Alternative | Valid placements for custom field Known values: profile, contract |
placement (anyOf 2) | null | Alternative | |
settings | Model | Optional | Expand List all people custom fields — 200 response body — data item settings Settings for the custom field |
type | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Settings for the custom field |
access | Model | Required within parent | Expand List all custom fields — 200 response body — data item settings access Access settings for the custom field |
countries | array | Optional | Countries for which the custom field is applicable. |
countries[] | string | Each item | |
is_enabled | boolean | Required within parent | Whether the custom field is enabled |
required | boolean | Required within parent | Whether the custom field is required |
worker_types | array | Optional | Worker types for which the custom field is applicable |
worker_types[] | string | Each item | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Type of the custom field |
$ (anyOf 1) | Model | Alternative | Expand List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink |
$ (anyOf 2) | Model | Alternative | Expand List all people custom fields — 200 response body — data / item / type / name: currency |
$ (anyOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Date type: YYYY-MM-DD |
value | string | Optional | Format: date |
Retrieve custom fields for a worker — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve custom fields for a worker — 200 response body — data item data |
id | string | Required within parent | UUID for the custom field value Format: uuid |
name | string | Required within parent | Name of the custom field |
type | string | Required within parent | Type 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Text type |
$ (anyOf 2) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Number type |
$ (anyOf 3) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data / item / data / Date type: YYYY-MM-DD |
$ (anyOf 4) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Percentage type |
$ (anyOf 5) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data Currency type |
$ (anyOf 6) | Model | Alternative | Expand Retrieve custom fields for a worker — 200 response body — data item data List type |
$ (anyOf 7) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Currency type |
amount | JSON | Optional | |
amount (anyOf 1) | number | Alternative | Format: double |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Optional | The currency code in ISO 4217 format |
Retrieve custom fields for a worker — 200 response body — data item data List type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List type |
option | string | Optional |
Retrieve custom fields for a worker — 200 response body — data item data Multiselect type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Multiselect type |
options | array | Optional | |
options[] | string | Each item |
Retrieve custom fields for a worker — 200 response body — data item data Number type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Number type |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve custom fields for a worker — 200 response body — data item data Percentage type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Percentage type |
text | string | Optional | |
value | JSON | Optional | |
value (anyOf 1) | number | Alternative | Format: double |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve custom fields for a worker — 200 response body — data item data Text type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Text type |
value | string | Optional |
Update custom field value — custom Fields People put Person Custom Field — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update custom field value — custom Fields People put Person Custom Field — request body — body data data |
id | string | Required within parent | UUID 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Currency type |
amount | number | Optional | Format: double |
currency | string | Optional | Important: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List type |
option | string | Optional | Option type |
Update custom field value — custom Fields People put Person Custom Field — request body — body data data Number type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Number type |
value | number | Optional | Number type Format: double |
Update custom field value — custom Fields People put Person Custom Field — request body — body data data Percentage type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Percentage type |
value | number | Optional | Percentage type Format: double |
Update custom field value — custom Fields People put Person Custom Field — request body — body data data Text type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Text type |
value | string | Optional | Text type |
Update custom field value — customFieldsPeople.putPersonCustomField — request body — body / data / data / Date type: YYYY-MM-DD
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Date type: YYYY-MM-DD |
value | string | Optional | Date type: YYYY-MM-DD Format: date |