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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response wrapper object |
data | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Custom field object |
created_at | string | Optional | Creation timestamp Format: date-time |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | Optional description of the custom field |
description (anyOf 2) | null | Alternative | 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 | Where the custom field is displayed Known values: profile, contract |
settings | Model | Optional | Expand Get custom fields from contracts — 200 response body — data settings Configuration settings for the custom field |
type | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Currency custom field type |
currency | string | Optional | ISO currency code |
is_fixed | boolean | Optional | Whether the currency is fixed |
name | string | Optional | Currency field type Known values: currency |
Get custom fields from contracts — 200 response body — data / type / name: list, multiselect
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | List or multiselect custom field type |
name | string | Optional | List field type Known values: list, multiselect |
options | array | Optional | Available options for the list field |
options[] | string | Each item |
Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Simple custom field types |
name | string | Optional | Simple field type Known values: text, number, date, percentage, hyperlink |
Get custom fields from contracts — 200 response body — data settings
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration settings for the custom field |
access | Model | Optional | Expand Get custom fields from contracts — 200 response body — data settings access Access control settings |
countries | array | Optional | Countries where the field applies |
countries[] | string | Each item | |
is_enabled | boolean | Optional | Whether the field is enabled |
required | boolean | Optional | Whether the field is mandatory |
worker_types | array | Optional | Applicable worker types |
worker_types[] | string | Each item | Worker 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Access control settings |
is_sensitive | boolean | Optional | Whether the field contains sensitive data |
provided_by | JSON | Optional | Entity providing access |
provided_by (anyOf 1) | string | Alternative | Entity providing access Known values: organization, worker |
provided_by (anyOf 2) | null | Alternative |
Get custom fields from contracts — 200 response body — data type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Type definition of the custom field |
$ (anyOf 1) | Model | Alternative | Expand Get custom fields from contracts — 200 response body — data / type / name: text, number, date, percentage, hyperlink |
$ (anyOf 2) | Model | Alternative | Expand Get custom fields from contracts — 200 response body — data / type / name: currency |
$ (anyOf 3) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
currency | JSON | Optional | |
currency (anyOf 1) | string | Alternative | Currency code (null when is_fixed is false) Maximum length: 3 |
currency (anyOf 2) | null | Alternative | Currency code (null when is_fixed is false) 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 custom fields — 200 response body — data / item / type / name: list, multiselect
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | List types Known values: list, multiselect |
options | array | Required within parent | List of options for the custom field |
options[] | string | Each item |
List all custom fields — 200 response body — data / item / type / name: text, number, date, percentage, hyperlink
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Required within parent | Simple types Known values: text, number, date, percentage, hyperlink |
List all custom fields — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | 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 | Required within parent | Unique identifier of the custom field Format: uuid |
name | string | Required within parent | Name of the custom field |
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 | Required within parent | Expand List all custom fields — 200 response body — data item settings Configuration settings for the custom field including requirements, visibility, and access controls |
type | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration settings for the custom field including requirements, visibility, and access controls |
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. Omitted when applicable to all. |
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. Omitted when applicable to all. |
worker_types[] | string | Each item | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Access settings for the custom field |
group_permission_set | JSON | Optional | |
group_permission_set (anyOf 1) | string | Alternative | Permission set identifier for the custom field |
group_permission_set (anyOf 2) | null | Alternative | Permission set identifier for the custom field |
is_sensitive | boolean | Required within parent | Whether the custom field is sensitive |
provided_by | JSON | Optional | Entity providing access to the custom field |
provided_by (anyOf 1) | string | Alternative | Entity providing access to the custom field Known values: organization, worker |
provided_by (anyOf 2) | null | Alternative |
List all custom fields — 200 response body — data item type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Type configuration of the custom field including its data type and type-specific properties |
$ (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 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: 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Update custom field value — custom Fields Contracts put Contract 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 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Number type |
value | number | Optional | Format: double |
Update custom field value — custom Fields Contracts put Contract Custom Field — request body — body data data Percentage type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Percentage type |
value | number | Optional | Format: double |