Deel: Worker relations schemas
23 Deel schemas with complete fields and constraints.
← Worker relations operations · All schemas
Create a parent worker relation with external id — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload containing parent relationship details. |
hris_relationship_type_external_id | string | Required within parent | The external identifier of the relationship type to apply. Maximum length: 100 |
parent_profile_external_id | string or null | Required within parent | The external identifier of the parent HRIS Profile. Pass null to remove the existing parent relationship. Maximum length: 100 |
relation_external_id | string or null | Optional | The external identifier for this specific relation record. Maximum length: 100 |
Create a parent worker relation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hris_relationship_type_id | string | Required within parent | The ID of the relationship type Format: uuid |
id | string | Required within parent | The ID of the parent profile Format: uuid |
Create a worker relation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The request payload containing the relationship details. |
child_hris_profile_ids | array | Required within parent | An array containing the secondary HrisProfiles IDs. |
child_hris_profile_ids[] | string | Each item | Format: uuid |
hris_relationship_type_id | string | Required within parent | The ID of the Worker Relation Type. Format: uuid |
parent_hris_profile_id | string | Required within parent | Primary HrisProfile ID Format: uuid |
Create child worker relation with external Id — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_hris_profile_ids | array | Required within parent | |
child_hris_profile_ids[] | Model | Each item | Expand Create child worker relation with external Id — request body — body data child hris profile ids item |
hris_relationship_type_external_id | string | Optional | Format: uuid |
Referenced models: Create child worker relation with external Id — request body — body data child hris profile ids item
Create child worker relation with external Id — request body — body data child hris profile ids item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (oneOf 1) | Model | Alternative | Expand Create child worker relation with external Id — request body — body data child hris profile ids item external hris profile id, relation external id |
Referenced models: Create child worker relation with external Id — request body — body data child hris profile ids item external hris profile id, relation external id
Create child worker relation with external Id — request body — body data child hris profile ids item external hris profile id, relation external id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_hris_profile_id | string | Required within parent | Maximum length: 100 |
relation_external_id | string | Required within parent | Maximum length: 100 |
Create child worker relation — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hris_relationship_type_id | string | Required within parent | The ID of the relationship type Format: uuid |
ids | array | Required within parent | An array containing the IDs of the child profiles |
ids[] | string | Each item | Format: uuid |
Create worker relation type — 201 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Create worker relation type — 201 response body — data |
Referenced models: Create worker relation type — 201 response body — data
Create worker relation type — 201 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_name | string | Optional | The name of the secondary party in the relationship |
external_id | string | Optional | A custom ID for the relation type |
id | string | Optional | The ID of the relation type Format: uuid |
is_default | boolean | Optional | Whether this relation is default or not |
parent_name | string | Optional | The name of the primary party in the relationship |
Create worker relation type — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_name | string | Optional | The name of the secondary party in the relationship Maximum length: 100 |
external_id | string | Optional | A custom ID for the relation type Maximum length: 100 |
is_default | boolean | Optional | Whether this relation is default or not Default: false |
parent_name | string | Optional | The name of the primary party in the relationship Maximum length: 100 |
Create worker relation with external Ids — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_hris_profile_ids | array | Required within parent | An array containing the secondary HrisProfiles external IDs and the relation external ID. |
child_hris_profile_ids[] | Model | Each item | Expand Create worker relation with external Ids — request body — body data child hris profile ids item |
hris_relationship_type_external_id | string | Required within parent | The external ID of the Worker Relation Type. Maximum length: 100 |
parent_external_hris_profile_id | string | Required within parent | Primary HrisProfile external ID Maximum length: 100 |
Referenced models: Create worker relation with external Ids — request body — body data child hris profile ids item
Create worker relation with external Ids — request body — body data child hris profile ids item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_hris_profile_id | string | Required within parent | The external ID of the secondary HrisProfile. Maximum length: 100 |
relation_external_id | string | Required within parent | A custom ID to set to the relation. Maximum length: 100 |
Fetch Worker Relations of a given Hris Profile by external id — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | An array containing the Worker Relations of the profile. It includes either the parent or child relations. |
data[] | Model | Each item | Expand Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item |
Referenced models: Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item
Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_relationships | array | Optional | An array containing the information about the child profiles in the relation. |
child_relationships[] | Model | Each item | Expand Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item child relationships item |
id | string | Optional | The ID of the relation type Format: uuid |
is_default | boolean | Optional | Whether this relation is default or not |
is_parent | boolean | Optional | Whether this relation is the parent or not |
name | string | Optional | The name of the relation type |
parent_relationship | Model | Optional | Expand Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item parent relationship An object that has information about the parent profile in the relation. |
Referenced models: Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item child relationships item, Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item parent relationship
Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item child relationships item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
external_id | string | Optional | The external ID of the child profile |
first_name | string | Optional | The first name of the child profile |
last_name | string | Optional | The last name of the child profile |
profile_id | string | Optional | The ID of the child profile Format: uuid |
relation_id | string | Optional | The ID of the relation between the profiles Format: uuid |
Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item parent relationship
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object that has information about the parent profile in the relation. |
first_name | string | Optional | The first name of the parent profile |
last_name | string | Optional | The last name of the parent profile |
profile_external_id | string | Optional | The external ID of the parent profile |
profile_id | string | Optional | The ID of the parent profile Format: uuid |
relation_external_id | string | Optional | The external ID of the relation |
relation_id | string | Optional | The ID of the relation between the profiles Format: uuid |
List of worker relations — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | An array containing the Worker Relations of the profile. It includes either the parent or child relations. |
data[] | Model | Each item | Expand List of worker relations — 200 response body — data item |
Referenced models: List of worker relations — 200 response body — data item
List of worker relations — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_relationships | array | Optional | An array containing the information about the child profiles in the relation. |
child_relationships[] | Model | Each item | Expand List of worker relations — 200 response body — data item child relationships item |
id | string | Optional | The ID of the relation type Format: uuid |
is_default | boolean | Optional | Whether this relation is default or not |
is_parent | boolean | Optional | Whether this relation is the parent or not |
name | string | Optional | The name of the relation type |
parent_relationship | JSON | Optional | An object that has information about the parent profile in the relation. |
parent_relationship (anyOf 1) | Model | Alternative | Expand List of worker relations — 200 response body — data item parent relationship first name, last name, profile id, relation id |
parent_relationship (anyOf 2) | null | Alternative |
Referenced models: List of worker relations — 200 response body — data item child relationships item, List of worker relations — 200 response body — data item parent relationship first name, last name, profile id, relation id
List of worker relations — 200 response body — data item child relationships item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
first_name | string | Optional | The first name of the child profile |
last_name | string | Optional | The last name of the child profile |
profile_id | string | Optional | The ID of the child profile Format: uuid |
relation_id | string | Optional | The ID of the relation between the profiles Format: uuid |
List of worker relations — 200 response body — data item parent relationship first name, last name, profile id, relation id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An object that has information about the parent profile in the relation. |
first_name | string | Optional | The first name of the parent profile |
last_name | string | Optional | The last name of the parent profile |
profile_id | string | Optional | The ID of the parent profile Format: uuid |
relation_id | string | Optional | The ID of the relation between the profiles Format: uuid |
Retrieve all worker relation types — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Optional | |
data[] | Model | Each item | Expand Retrieve all worker relation types — 200 response body — data item |
Referenced models: Retrieve all worker relation types — 200 response body — data item
Retrieve all worker relation types — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_name | string | Optional | The name of the secondary party in the relationship |
external_id | JSON | Optional | |
external_id (anyOf 1) | string | Alternative | A custom ID for the relation type Maximum length: 100 |
external_id (anyOf 2) | null | Alternative | A custom ID for the relation type Maximum length: 100 |
id | string | Optional | The ID of the relation type Format: uuid |
is_default | boolean | Optional | Whether this relation is default or not |
parent_name | string | Optional | The name of the primary party in the relationship |
Update a worker relation type — request body — body data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
child_name | string | Optional | The name of the secondary party in the relationship Maximum length: 100 |
external_id | string | Optional | A custom ID for the relation type Maximum length: 100 |
parent_name | string | Optional | The name of the primary party in the relationship Maximum length: 100 |