Deel: Organization structure schemas
20 Deel schemas with complete fields and constraints.
← Organization structure operations · All schemas
Create a new HRIS Organization Structure — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Create a new HRIS Organization Structure — 200 response body — data |
Referenced models: Create a new HRIS Organization Structure — 200 response body — data
Create a new HRIS Organization Structure — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The date and time when the organization structure was created. Format: date-time |
enable_roles | boolean | Optional | Whether roles are enabled for the organization structure. |
external_id | string | Optional | The external identifier of the organization structure. |
id | string | Optional | The unique identifier of the organization structure. |
is_multi_select | boolean | Optional | Whether multiple selection is enabled for the organization structure. |
name | string | Optional | The name of the organization structure. |
organization_id | JSON | Optional | |
organization_id (anyOf 1) | integer | Alternative | The unique identifier of the organization. |
organization_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Optional | The type of the organization structure. |
updated_at | string | Optional | The date and time when the organization structure was last updated. Format: date-time |
Create a new HRIS Organization Structure — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enable_roles | boolean | Optional | Whether roles are enabled for the organization structure. Default: true |
external_id | string | Optional | The external identifier of the organization structure. |
is_multiple_select | boolean | Optional | Whether multiple selection is enabled for the organization structure. Default: true |
name | string | Optional | The name of the organization structure. |
teams | array | Optional | |
teams[] | Model | Each item | Expand Create a new HRIS Organization Structure — request body — body data teams item |
Referenced models: Create a new HRIS Organization Structure — request body — body data teams item
Create a new HRIS Organization Structure — request body — body data teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Optional | The external identifier of the team. |
name | string | Optional | The name of the team. |
Get Organization Structure by External ID — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get Organization Structure by External ID — 200 response body — data |
Referenced models: Get Organization Structure by External ID — 200 response body — data
Get Organization Structure by External ID — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enable_roles | boolean | Optional | Flag to enable roles in the organization |
external_id | string | Optional | External ID |
id | string | Optional | Organization ID Format: uuid |
is_multiselect | boolean | Optional | Flag to enable multiselect in the organization |
name | string | Optional | Organization name |
roles | array | Optional | |
roles[] | Model | Each item | Expand Get Organization Structure by External ID — 200 response body — data roles item |
teams | array | Optional | |
teams[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
teams_count | JSON | Optional | |
teams_count (anyOf 1) | integer | Alternative | Number of teams in the organization |
teams_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Optional | Organization type |
Referenced models: Get Organization Structure — 200 response body — data teams item, Get Organization Structure by External ID — 200 response body — data roles item
Get Organization Structure by External ID — 200 response body — data roles item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | Role ID |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Role name |
Get Organization Structure — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Get Organization Structure — 200 response body — data |
Referenced models: Get Organization Structure — 200 response body — data
Get Organization Structure — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enable_roles | boolean | Optional | HRIS Organization Structure Enable Roles |
external_id | string | Optional | HRIS Organization Structure External ID |
id | string | Optional | HRIS Organization Structure ID Format: uuid |
is_multiselect | boolean | Optional | HRIS Organization Structure Is Multiselect |
name | string | Optional | HRIS Organization Structure Name |
roles | array | Optional | |
roles[] | Model | Each item | Expand Get Organization Structure — 200 response body — data roles item |
teams | array | Optional | |
teams[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
teams_count | JSON | Optional | |
teams_count (anyOf 1) | integer | Alternative | HRIS Organization Structure Teams Count |
teams_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Optional | HRIS Organization Structure Type |
Referenced models: Get Organization Structure — 200 response body — data teams item, Get Organization Structure — 200 response body — data roles item
Get Organization Structure — 200 response body — data roles item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | JSON | Optional | |
id (anyOf 1) | integer | Alternative | Role ID |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Optional | Role Name |
Get Organization Structure — 200 response body — data teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root |
Get Organization Structures — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Get Organization Structures — 200 response body — data item |
Referenced models: Get Organization Structures — 200 response body — data item
Get Organization Structures — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The date and time when the Org Structure was created. Format: date-time |
editable | boolean | Optional | Whether the caller can edit the Org Structure. |
enable_roles | boolean | Optional | Whether the Org Structure has Roles enabled. |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external identifier of the Org Structure. |
external_id (anyOf 2) | null | Alternative | The external identifier of the Org Structure. |
id | string | Optional | The unique identifier of the Org Structure. Format: uuid |
is_multiselect | boolean | Optional | Whether the Org Structure is multiselect. |
name | string | Optional | The name of the Org Structure. |
roles | array | Optional | |
roles[] | Model | Each item | Expand Get Organization Structures — 200 response body — data item roles item |
teams | array | Optional | |
teams[] | Model | Each item | Expand Get Organization Structures — 200 response body — data item teams item |
teams_count | JSON | Optional | |
teams_count (anyOf 1) | integer | Alternative | The number of Teams in the Org Structure. |
teams_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Optional | The type of the Org Structure. |
Referenced models: Get Organization Structures — 200 response body — data item roles item, Get Organization Structures — 200 response body — data item teams item
Get Organization Structures — 200 response body — data item roles item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The unique identifier of the Role. Format: uuid |
name | string | Optional | The name of the Role. |
Get Organization Structures — 200 response body — data item teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
children | array | Optional | |
children[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
created_at | string | Optional | The date and time when the Org Structure was created. Format: date-time |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | The external identifier of the Team. |
external_id (anyOf 2) | null | Alternative | The external identifier of the Team. |
id | string | Optional | The unique identifier of the Team. Format: uuid |
name | string | Optional | The name of the Team. |
name_route | JSON | Optional | |
name_route (anyOf 1) | string | Alternative | The route name of the Team. |
name_route (anyOf 2) | null | Alternative | The route name of the Team. |
parent | JSON | Optional | |
parent (anyOf 1) | string | Alternative | The name of the parent Org Structure. |
parent (anyOf 2) | null | Alternative | The name of the parent Org Structure. |
Referenced models: Get Organization Structure — 200 response body — data teams item
Update an existing HRIS Org Structure by external ID — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enable_roles | boolean | Optional | Enable roles |
external_id | string | Optional | External ID |
is_multiselect | boolean | Optional | Is multiselect |
name | string | Optional | Name of the organization |
teams | array | Required within parent | |
teams[] | Model | Each item | Expand Get Organization Structure — 200 response body — data teams item |
Referenced models: Get Organization Structure — 200 response body — data teams item
Update an existing HRIS Org Structure — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
enable_roles | boolean | Optional | Enable roles for the Org Structure |
external_id | string | Optional | External ID of the Org Structure |
is_multiselect | boolean | Optional | Enable multiselect for the Org Structure |
name | string | Optional | Name of the Org Structure |
teams | array | Required within parent | Teams to create, update or delete. Items with an id update that team and items without one create a team. A top-level item with only an id deletes that team, which is rejected while the team or its descendants have positions. Teams not listed are left untouched. The parent of a team is expressed by nesting it in children. |
teams[] | Model | Each item | Expand Update an existing HRIS Org Structure — request body — body data teams item |
Referenced models: Update an existing HRIS Org Structure — request body — body data teams item
Update an existing HRIS Org Structure — request body — body data teams item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A team of the org structure, with its child teams nested under it. |
children | array | Optional | Teams nested under this team. A team is a child of the item it is nested under; teams at the top level of the teams array are root teams. |
children[] | Model | Each item | Expand Update an existing HRIS Org Structure — request body — body data teams item children item |
externalId | string or null | Optional | External ID of the team. To set or clear one team's external ID, use PATCH /rest/hris/organization-structures/teams/{team_id}. |
id | string | Optional | ID of an existing team to update. Omit to create a new team. A top-level item with an id and no name deletes that team. |
name | string | Optional | Name of the team. Required to create or update a team; omit it, and send only the id, to delete the team. |
Referenced models: Update an existing HRIS Org Structure — request body — body data teams item children item
Update an existing HRIS Org Structure — request body — body data teams item children item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A child team, with the same fields as a top-level item, nested to any depth. |
Update organization structure — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
department_id | string | Required within parent | Unique identifier of this resource. Format: uuid |
effective_date | string | Optional | Effective date in YYYY-MM-DD format. Format: date |