Skip to content

Deel: Positions schemas

9 Deel schemas with complete fields and constraints.

← Positions operations · All schemas

Apply changes to positions — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe request payload containing the position changes to apply.
addarrayOptional
add[]ModelEach itemExpand Apply changes to positions — request body — body data add item
deletearrayOptional
delete[]ModelEach itemExpand Apply changes to positions — request body — body data delete item
editarrayOptional
edit[]ModelEach itemExpand Apply changes to positions — request body — body data edit item
profile_idstringRequired within parentId of the profile to which the positions belong.
Format: uuid

Referenced models: Apply changes to positions — request body — body data add item, Apply changes to positions — request body — body data delete item, Apply changes to positions — request body — body data edit item

Apply changes to positions — request body — body data add item

FieldTypePresenceDescription and constraints
$objectRoot
is_supportivebooleanOptionalFlag to indicate if the position is supportive.
role_idstring or nullOptionalId of the role to be assigned to the position.
Format: uuid
team_idstringRequired within parentId of the team to be assigned to the position.
Format: uuid

Apply changes to positions — request body — body data delete item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentId of the position to be deleted.
Format: uuid

Apply changes to positions — request body — body data edit item

FieldTypePresenceDescription and constraints
$objectRoot
idstringRequired within parentId of the position to be edited.
Format: uuid
is_supportivebooleanOptionalFlag to indicate if the position is supportive.
role_idstring or nullOptionalId of the role to be assigned to the position.
Format: uuid

Get Positions by Profile — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptional
data[]ModelEach itemExpand Get Positions by Profile — 200 response body — data item

Referenced models: Get Positions by Profile — 200 response body — data item

Get Positions by Profile — 200 response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalHRIS Position ID
Format: uuid
is_supportivebooleanOptionalIs Supportive Position
roleModelOptionalExpand Get Positions by Profile — 200 response body — data item role
teamModelOptionalExpand Get Positions by Profile — 200 response body — data item team

Referenced models: Get Positions by Profile — 200 response body — data item role, Get Positions by Profile — 200 response body — data item team

Get Positions by Profile — 200 response body — data item role

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalRole ID
Format: uuid
namestringOptionalRole Name

Get Positions by Profile — 200 response body — data item team

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalTeam ID
Format: uuid
namestringOptionalTeam Name
organization_structureModelOptionalExpand Get Positions by Profile — 200 response body — data item team organization structure

Referenced models: Get Positions by Profile — 200 response body — data item team organization structure

Get Positions by Profile — 200 response body — data item team organization structure

FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalOrganization Structure ID
Format: uuid
namestringOptionalOrganization Structure Name

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.