How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Deel subpackage_workerRelations API

The subpackage_workerRelations API from Deel — 15 operation(s) for subpackage_workerrelations.

Deel subpackage_workerRelations API is one of 91 APIs that Deel publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include subpackage_workerRelations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 20 operations across 15 paths, and defines 59 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.letsdeel.com/rest/v2, https://api-staging.letsdeel.com/rest/v2.

20 operations 15 paths 59 schemas 5 DELETE4 GET2 PATCH3 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Servers
https://api.letsdeel.com/rest/v2
https://api-staging.letsdeel.com/rest/v2
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Deel subpackage_workerRelations API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (deelToken). It accepts HTTP bearer tokens (oauth2).

  • deelToken — Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authenticatio…
  • oauth2 — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 5 DELETE, 4 GET, 2 PATCH, 3 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

subpackage_workerRelations 20
PUT
/hris/worker_relations/profile/{hrisProfileOid}/child
Add Worker Relation Child
add-worker-relation-child 1 param → 200
PUT
/hris/worker_relations/profile/external/{profileId}/parent
Add Worker Relation Parent By External Id
add-worker-relation-parent-by-external-id 1 param → 200
PUT
/hris/worker_relations/profile/{hrisProfileOid}/parent
Create a parent worker relation
add-worker-relation-parent 2 params body → 204400401403404500
POST
/hris/worker_relations/profile
Create a worker relation
create-worker-relation-profile 1 param body → 201400401403404500
PUT
/hris/worker_relations/profile/external/{profileId}/child
Create child worker relation with external Id
add-worker-relation-child-by-external-id 2 params body → 204400401403404500
POST
/hris/worker_relations/types
Create worker relation type
create-worker-relation-type 1 param body → 201400401403404500
GET
/hris/worker_relations/types
Retrieve all worker relation types
get-worker-relation-types 1 param → 200400401403404500
POST
/hris/worker_relations/profile/external
Create worker relation with external Ids
create-worker-relation-profile-by-external-id 1 param body → 201400401403404500
DELETE
/hris/worker_relations/profile/{hrisProfileOid}
Delete a worker relation
delete-worker-relation-profile 2 params → 204400401403404500
GET
/hris/worker_relations/profile/{hrisProfileOid}
List of worker relations
get-worker-relation-profile 2 params → 200400401403404500
DELETE
/hris/worker_relations/profile/external/{profileId}
Delete a worker relation by external id
delete-worker-relation-profile-by-external-id 2 params → 204400401403404500
GET
/hris/worker_relations/profile/external/{profileId}
Get Worker Relation Profile By External Id
get-worker-relation-profile-by-external-id 1 param → 200
DELETE
/hris/worker_relations/types/external/{externalId}
Delete a worker relation type by external id
delete-worker-relation-type-by-external-id 2 params → 204400401403404500
PATCH
/hris/worker_relations/types/external/{externalId}
Update a worker relation type by external id
update-worker-relation-type-by-external-id 2 params body → 204400401403404500
DELETE
/hris/worker_relations/types/{typeId}
Delete Worker Relation Type
delete-worker-relation-type 1 param → 200
PATCH
/hris/worker_relations/types/{typeId}
Update a worker relation type
update-worker-relation-type 2 params body → 204400401403404500
PUT
/hris/worker_relations/profile/external/{profile_id}/parent
Create a parent worker relation with external id
create-a-parent-worker-relation-with-external-id-v-2026-01-01 2 params body → 204400401403404500
PUT
/hris/worker_relations/profile/{hris_profile_oid}/child
Create child worker relation
create-child-worker-relation-v-2026-01-01 2 params body → 204400401403404500
DELETE
/hris/worker_relations/types/{type_id}
Delete a worker relation type
delete-a-worker-relation-type-v-2026-01-01 2 params → 204400401403404500
GET
/hris/worker_relations/profile/external/{profile_id}
Fetch Worker Relations of a given HrisProfile by external id
fetch-worker-relations-of-a-given-hris-profile-by-external-id-v-2026-01-01 2 params → 200400401403404500

Schemas 59

The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are ApiErrorRequest (7 properties), HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems (6 properties), HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems (6 properties), HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship (6 properties). Each schema is shown below with its type and property counts.

HrisWorkerRelationsTypesExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData
object
3 properties
HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship
object
An object that has information about the parent profile in the relation.
6 properties
HrisWorkerRelationsProfileExternalProfileIdParentPutRequestBodyContentApplicationJsonSchemaData
object
The request payload containing parent relationship details.
3 properties 2 required
HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems
object
4 properties
HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaData
object
5 properties
HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestNotFoundError
object
1 property 1 required
worker-relations_createWorkerRelationProfile_Response_201
object
Empty response body
HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship
object
An object that has information about the parent profile in the relation.
4 properties
FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestBadRequestError
object
1 property 1 required
HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems0
object
2 properties 2 required
RetrieveAllWorkerRelationTypes-v2026-01-01RequestBadRequestError
object
1 property
HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems
object
6 properties
HrisWorkerRelationsTypesTypeIdPatchRequestBodyContentApplicationJsonSchemaData
object
3 properties
worker-relations_addWorkerRelationChildByExternalId_Response_204
object
Empty response body
worker-relations_getWorkerRelationProfile_Response_200
object
1 property
HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaData
object
3 properties 3 required
worker-relations_deleteWorkerRelationProfile_Response_204
object
Empty response body
worker-relations_deleteWorkerRelationTypeByExternalId_Response_204
object
Empty response body
Worker Relations_fetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01_Response_200
object
1 property
worker-relations_createWorkerRelationProfileByExternalId_Response_201
object
Empty response body
HrisWorkerRelationsTypesPostRequestBodyContentApplicationJsonSchemaData
object
4 properties
HrisWorkerRelationsProfileHrisProfileOidParentPutRequestBodyContentApplicationJsonSchemaData
object
2 properties 2 required
HrisWorkerRelationsProfilePostRequestBodyContentApplicationJsonSchemaData
object
The request payload containing the relationship details.
3 properties 3 required
worker-relations_addWorkerRelationParent_Response_204
object
Empty response body
CreateChildWorkerRelation-v2026-01-01RequestNotFoundError
object
1 property 1 required
worker-relations_deleteWorkerRelationProfileByExternalId_Response_204
object
Empty response body
HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems
object
2 properties 2 required
Worker Relations_createChildWorkerRelation-v2026-01-01_Response_204
object
Empty response body
CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestBadRequestError
object
1 property 1 required
RetrieveAllWorkerRelationTypes-v2026-01-01RequestInternalServerError
object
1 property
ApiError
object
2 properties
HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems
object
5 properties
Worker Relations_deleteAWorkerRelationType-v2026-01-01_Response_204
object
Empty response body
HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties 2 required
Worker Relations_createAParentWorkerRelationWithExternalId-v2026-01-01_Response_204
object
Empty response body
DeleteAWorkerRelationType-v2026-01-01RequestBadRequestError
object
1 property
CreateAWorkerRelation-v2026-01-01RequestBadRequestError
object
1 property 1 required
worker-relations_updateWorkerRelationTypeByExternalId_Response_204
object
1 property
ApiErrorContainer
object
2 properties
CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestNotFoundError
object
1 property 1 required
HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties 2 required
CreateChildWorkerRelation-v2026-01-01RequestBadRequestError
object
1 property 1 required
worker-relations_updateWorkerRelationType_Response_204
object
1 property
HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems
HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems
object
2 properties
HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties 2 required
HrisWorkerRelationsTypesTypeIdPatchResponsesContentApplicationJsonSchemaData
object
5 properties
worker-relations_createWorkerRelationType_Response_201
object
1 property
HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties 2 required
HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaData
object
2 properties 1 required
HrisWorkerRelationsProfileHrisProfileOidChildPutRequestBodyContentApplicationJsonSchemaData
object
2 properties 2 required
CreateAWorkerRelation-v2026-01-01RequestNotFoundError
object
1 property 1 required
DeleteAWorkerRelationType-v2026-01-01RequestInternalServerError
object
1 property
HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems
object
6 properties
worker-relations_getWorkerRelationTypes_Response_200
object
1 property
HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaDataItems
object
5 properties
HrisWorkerRelationsTypesExternalExternalIdPatchResponsesContentApplicationJsonSchemaData
object
5 properties
ApiErrorRequest
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deel-subpackage-workerrelations-api-openapi.yml Raw ↑

Other APIs Deel publishes across the network.

Deel Default API
Deel subpackage_accounting API
Deel subpackage_adjustments API
Deel subpackage_assets API
Deel subpackage_ats API
Deel subpackage_candidates API
Deel subpackage_consent API
Deel subpackage_contractorAmendments API
Deel subpackage_contractorHiring API
Deel subpackage_contracts API
Deel subpackage_costCalculator API
Deel subpackage_costCenters API
Where this information came from

This is an independent, third-party profile of Deel subpackage_workerRelations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.