Deel: Positions schemas
9 Deel schemas with complete fields and constraints.
← Positions operations · All schemas
Apply changes to positions — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload containing the position changes to apply. |
add | array | Optional | |
add[] | Model | Each item | Expand Apply changes to positions — request body — body data add item |
delete | array | Optional | |
delete[] | Model | Each item | Expand Apply changes to positions — request body — body data delete item |
edit | array | Optional | |
edit[] | Model | Each item | Expand Apply changes to positions — request body — body data edit item |
profile_id | string | Required within parent | Id 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_supportive | boolean | Optional | Flag to indicate if the position is supportive. |
role_id | string or null | Optional | Id of the role to be assigned to the position. Format: uuid |
team_id | string | Required within parent | Id of the team to be assigned to the position. Format: uuid |
Apply changes to positions — request body — body data delete item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Id of the position to be deleted. Format: uuid |
Apply changes to positions — request body — body data edit item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Id of the position to be edited. Format: uuid |
is_supportive | boolean | Optional | Flag to indicate if the position is supportive. |
role_id | string or null | Optional | Id of the role to be assigned to the position. Format: uuid |
Get Positions by Profile — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | HRIS Position ID Format: uuid |
is_supportive | boolean | Optional | Is Supportive Position |
role | Model | Optional | Expand Get Positions by Profile — 200 response body — data item role |
team | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Role ID Format: uuid |
name | string | Optional | Role Name |
Get Positions by Profile — 200 response body — data item team
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Team ID Format: uuid |
name | string | Optional | Team Name |
organization_structure | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Organization Structure ID Format: uuid |
name | string | Optional | Organization Structure Name |