Skip to content

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

FieldTypePresenceDescription and constraints
$objectRootThe request payload containing parent relationship details.
hris_relationship_type_external_idstringRequired within parentThe external identifier of the relationship type to apply.
Maximum length: 100
parent_profile_external_idstring or nullRequired within parentThe external identifier of the parent HRIS Profile. Pass null to remove the existing parent relationship.
Maximum length: 100
relation_external_idstring or nullOptionalThe external identifier for this specific relation record.
Maximum length: 100

Create a parent worker relation — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
hris_relationship_type_idstringRequired within parentThe ID of the relationship type
Format: uuid
idstringRequired within parentThe ID of the parent profile
Format: uuid

Create a worker relation — request body — body data

FieldTypePresenceDescription and constraints
$objectRootThe request payload containing the relationship details.
child_hris_profile_idsarrayRequired within parentAn array containing the secondary HrisProfiles IDs.
child_hris_profile_ids[]stringEach itemFormat: uuid
hris_relationship_type_idstringRequired within parentThe ID of the Worker Relation Type.
Format: uuid
parent_hris_profile_idstringRequired within parentPrimary HrisProfile ID
Format: uuid

Create child worker relation with external Id — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
child_hris_profile_idsarrayRequired within parent
child_hris_profile_ids[]ModelEach itemExpand Create child worker relation with external Id — request body — body data child hris profile ids item
hris_relationship_type_external_idstringOptionalFormat: 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (oneOf 1)ModelAlternativeExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
external_hris_profile_idstringRequired within parentMaximum length: 100
relation_external_idstringRequired within parentMaximum length: 100

Create child worker relation — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
hris_relationship_type_idstringRequired within parentThe ID of the relationship type
Format: uuid
idsarrayRequired within parentAn array containing the IDs of the child profiles
ids[]stringEach itemFormat: uuid

Create worker relation type — 201 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
child_namestringOptionalThe name of the secondary party in the relationship
external_idstringOptionalA custom ID for the relation type
idstringOptionalThe ID of the relation type
Format: uuid
is_defaultbooleanOptionalWhether this relation is default or not
parent_namestringOptionalThe name of the primary party in the relationship

Create worker relation type — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
child_namestringOptionalThe name of the secondary party in the relationship
Maximum length: 100
external_idstringOptionalA custom ID for the relation type
Maximum length: 100
is_defaultbooleanOptionalWhether this relation is default or not
Default: false
parent_namestringOptionalThe name of the primary party in the relationship
Maximum length: 100

Create worker relation with external Ids — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
child_hris_profile_idsarrayRequired within parentAn array containing the secondary HrisProfiles external IDs and the relation external ID.
child_hris_profile_ids[]ModelEach itemExpand Create worker relation with external Ids — request body — body data child hris profile ids item
hris_relationship_type_external_idstringRequired within parentThe external ID of the Worker Relation Type.
Maximum length: 100
parent_external_hris_profile_idstringRequired within parentPrimary 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

FieldTypePresenceDescription and constraints
$objectRoot
external_hris_profile_idstringRequired within parentThe external ID of the secondary HrisProfile.
Maximum length: 100
relation_external_idstringRequired within parentA custom ID to set to the relation.
Maximum length: 100

Fetch Worker Relations of a given Hris Profile by external id — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalAn array containing the Worker Relations of the profile. It includes either the parent or child relations.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
child_relationshipsarrayOptionalAn array containing the information about the child profiles in the relation.
child_relationships[]ModelEach itemExpand Fetch Worker Relations of a given Hris Profile by external id — 200 response body — data item child relationships item
idstringOptionalThe ID of the relation type
Format: uuid
is_defaultbooleanOptionalWhether this relation is default or not
is_parentbooleanOptionalWhether this relation is the parent or not
namestringOptionalThe name of the relation type
parent_relationshipModelOptionalExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
external_idstringOptionalThe external ID of the child profile
first_namestringOptionalThe first name of the child profile
last_namestringOptionalThe last name of the child profile
profile_idstringOptionalThe ID of the child profile
Format: uuid
relation_idstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootAn object that has information about the parent profile in the relation.
first_namestringOptionalThe first name of the parent profile
last_namestringOptionalThe last name of the parent profile
profile_external_idstringOptionalThe external ID of the parent profile
profile_idstringOptionalThe ID of the parent profile
Format: uuid
relation_external_idstringOptionalThe external ID of the relation
relation_idstringOptionalThe ID of the relation between the profiles
Format: uuid

List of worker relations — 200 response body

FieldTypePresenceDescription and constraints
$objectRoot
dataarrayOptionalAn array containing the Worker Relations of the profile. It includes either the parent or child relations.
data[]ModelEach itemExpand 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

FieldTypePresenceDescription and constraints
$objectRoot
child_relationshipsarrayOptionalAn array containing the information about the child profiles in the relation.
child_relationships[]ModelEach itemExpand List of worker relations — 200 response body — data item child relationships item
idstringOptionalThe ID of the relation type
Format: uuid
is_defaultbooleanOptionalWhether this relation is default or not
is_parentbooleanOptionalWhether this relation is the parent or not
namestringOptionalThe name of the relation type
parent_relationshipJSONOptionalAn object that has information about the parent profile in the relation.
parent_relationship (anyOf 1)ModelAlternativeExpand List of worker relations — 200 response body — data item parent relationship first name, last name, profile id, relation id
parent_relationship (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$objectRoot
first_namestringOptionalThe first name of the child profile
last_namestringOptionalThe last name of the child profile
profile_idstringOptionalThe ID of the child profile
Format: uuid
relation_idstringOptionalThe 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

FieldTypePresenceDescription and constraints
$objectRootAn object that has information about the parent profile in the relation.
first_namestringOptionalThe first name of the parent profile
last_namestringOptionalThe last name of the parent profile
profile_idstringOptionalThe ID of the parent profile
Format: uuid
relation_idstringOptionalThe ID of the relation between the profiles
Format: uuid

Retrieve all worker relation types — 200 response body

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

FieldTypePresenceDescription and constraints
$objectRoot
child_namestringOptionalThe name of the secondary party in the relationship
external_idJSONOptional
external_id (anyOf 1)stringAlternativeA custom ID for the relation type
Maximum length: 100
external_id (anyOf 2)nullAlternativeA custom ID for the relation type
Maximum length: 100
idstringOptionalThe ID of the relation type
Format: uuid
is_defaultbooleanOptionalWhether this relation is default or not
parent_namestringOptionalThe name of the primary party in the relationship

Update a worker relation type — request body — body data

FieldTypePresenceDescription and constraints
$objectRoot
child_namestringOptionalThe name of the secondary party in the relationship
Maximum length: 100
external_idstringOptionalA custom ID for the relation type
Maximum length: 100
parent_namestringOptionalThe name of the primary party in the relationship
Maximum length: 100

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.