Skip to content

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

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date and time when the organization structure was created.
Format: date-time
enable_rolesbooleanOptionalWhether roles are enabled for the organization structure.
external_idstringOptionalThe external identifier of the organization structure.
idstringOptionalThe unique identifier of the organization structure.
is_multi_selectbooleanOptionalWhether multiple selection is enabled for the organization structure.
namestringOptionalThe name of the organization structure.
organization_idJSONOptional
organization_id (anyOf 1)integerAlternativeThe unique identifier of the organization.
organization_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringOptionalThe type of the organization structure.
updated_atstringOptionalThe date and time when the organization structure was last updated.
Format: date-time

Create a new HRIS Organization Structure — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
enable_rolesbooleanOptionalWhether roles are enabled for the organization structure.
Default: true
external_idstringOptionalThe external identifier of the organization structure.
is_multiple_selectbooleanOptionalWhether multiple selection is enabled for the organization structure.
Default: true
namestringOptionalThe name of the organization structure.
teamsarrayOptional
teams[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringOptionalThe external identifier of the team.
namestringOptionalThe name of the team.

Get Organization Structure by External ID — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
enable_rolesbooleanOptionalFlag to enable roles in the organization
external_idstringOptionalExternal ID
idstringOptionalOrganization ID
Format: uuid
is_multiselectbooleanOptionalFlag to enable multiselect in the organization
namestringOptionalOrganization name
rolesarrayOptional
roles[]ModelEach itemExpand Get Organization Structure by External ID — 200 response body — data roles item
teamsarrayOptional
teams[]ModelEach itemExpand Get Organization Structure — 200 response body — data teams item
teams_countJSONOptional
teams_count (anyOf 1)integerAlternativeNumber of teams in the organization
teams_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringOptionalOrganization 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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)integerAlternativeRole ID
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalRole name

Get Organization Structure — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Get Organization Structure — 200 response body — data

Referenced models: Get Organization Structure — 200 response body — data

Get Organization Structure — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
enable_rolesbooleanOptionalHRIS Organization Structure Enable Roles
external_idstringOptionalHRIS Organization Structure External ID
idstringOptionalHRIS Organization Structure ID
Format: uuid
is_multiselectbooleanOptionalHRIS Organization Structure Is Multiselect
namestringOptionalHRIS Organization Structure Name
rolesarrayOptional
roles[]ModelEach itemExpand Get Organization Structure — 200 response body — data roles item
teamsarrayOptional
teams[]ModelEach itemExpand Get Organization Structure — 200 response body — data teams item
teams_countJSONOptional
teams_count (anyOf 1)integerAlternativeHRIS Organization Structure Teams Count
teams_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringOptionalHRIS 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

FieldTypePresenceDescription and constraints
$objectRoot
idJSONOptional
id (anyOf 1)integerAlternativeRole ID
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalRole Name

Get Organization Structure — 200 response body — data teams item

FieldTypePresenceDescription and constraints
$objectRoot

Get Organization Structures — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date and time when the Org Structure was created.
Format: date-time
editablebooleanOptionalWhether the caller can edit the Org Structure.
enable_rolesbooleanOptionalWhether the Org Structure has Roles enabled.
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external identifier of the Org Structure.
external_id (anyOf 2)nullAlternativeThe external identifier of the Org Structure.
idstringOptionalThe unique identifier of the Org Structure.
Format: uuid
is_multiselectbooleanOptionalWhether the Org Structure is multiselect.
namestringOptionalThe name of the Org Structure.
rolesarrayOptional
roles[]ModelEach itemExpand Get Organization Structures — 200 response body — data item roles item
teamsarrayOptional
teams[]ModelEach itemExpand Get Organization Structures — 200 response body — data item teams item
teams_countJSONOptional
teams_count (anyOf 1)integerAlternativeThe number of Teams in the Org Structure.
teams_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
typestringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier of the Role.
Format: uuid
namestringOptionalThe name of the Role.

Get Organization Structures — 200 response body — data item teams item

FieldTypePresenceDescription and constraints
$objectRoot
childrenarrayOptional
children[]ModelEach itemExpand Get Organization Structure — 200 response body — data teams item
created_atstringOptionalThe date and time when the Org Structure was created.
Format: date-time
external_idJSONOptional
external_id (anyOf 1)stringAlternativeThe external identifier of the Team.
external_id (anyOf 2)nullAlternativeThe external identifier of the Team.
idstringOptionalThe unique identifier of the Team.
Format: uuid
namestringOptionalThe name of the Team.
name_routeJSONOptional
name_route (anyOf 1)stringAlternativeThe route name of the Team.
name_route (anyOf 2)nullAlternativeThe route name of the Team.
parentJSONOptional
parent (anyOf 1)stringAlternativeThe name of the parent Org Structure.
parent (anyOf 2)nullAlternativeThe 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

FieldTypePresenceDescription and constraints
$objectRoot
enable_rolesbooleanOptionalEnable roles
external_idstringOptionalExternal ID
is_multiselectbooleanOptionalIs multiselect
namestringOptionalName of the organization
teamsarrayRequired within parent
teams[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
enable_rolesbooleanOptionalEnable roles for the Org Structure
external_idstringOptionalExternal ID of the Org Structure
is_multiselectbooleanOptionalEnable multiselect for the Org Structure
namestringOptionalName of the Org Structure
teamsarrayRequired within parentTeams 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[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRootA team of the org structure, with its child teams nested under it.
childrenarrayOptionalTeams 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[]ModelEach itemExpand Update an existing HRIS Org Structure — request body — body data teams item children item
externalIdstring or nullOptionalExternal ID of the team. To set or clear one team's external ID, use PATCH /rest/hris/organization-structures/teams/{team_id}.
idstringOptionalID 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.
namestringOptionalName 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

FieldTypePresenceDescription and constraints
$objectRootA child team, with the same fields as a top-level item, nested to any depth.

Update organization structure — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
department_idstringRequired within parentUnique identifier of this resource.
Format: uuid
effective_datestringOptionalEffective date in YYYY-MM-DD format.
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.