Deel subpackage_eorOffboarding API
The subpackage_eorOffboarding API from Deel — 8 operation(s) for subpackage_eoroffboarding.
Deel subpackage_eorOffboarding 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_eorOffboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 8 operations across 8 paths, and defines 132 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.
8 operations
8 paths
132 schemas
5 GET3 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Deel subpackage_eorOffboarding 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 8
Across 8 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.
subpackage_eorOffboarding 8
POST
/eor/contracts/{contract_id}/offboarding/review-client-sign-offs
Create client sign off
GET
/eor/contracts/{contract_id}/offboarding/required-information
Get additional information required to request employee termination
GET
/eor/contracts/{contract_id}/offboarding/time-offs
Retrieve Employee Time Off Data for Offboarding
GET
/eor/contracts/{contract_id}/offboarding/attachments/{attachment_id}
Retrieve offboarding attachment
GET
/eor/contracts/{contract_id}/offboarding
Retrieve Offboarding Request
GET
/eor/contracts/{contract_id}/offboarding/restricted-dates
Retrieve restricted offboarding dates
POST
/eor/contracts/{contract_id}/offboarding/resignations/review-pto
Submit employee resignation PTO review
POST
/eor/contracts/{contract_id}/offboarding/review-employee-sign-offs
Submit employee sign-off review for offboarding documents
Schemas 132
The contract defines 132 schemas that model the data the API accepts and returns. The most detailed are EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties), EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties), EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties), EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties). Each schema is shown below with its type and property counts.
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff
object
Required when trackingtype is OFFPLATFORM, null otherwise
3 properties
3 required
RetrieveRestrictedOffboardingDatesRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems
object
3 properties
3 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings
object
Policy configuration settings for time off calculations
3 properties
3 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems
object
9 properties
9 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData
object
3 properties
3 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
RetrieveOffboardingRequestRequestForbiddenError
object
1 property
RetrieveRestrictedOffboardingDatesRequestForbiddenError
object
1 property
RetrieveOffboardingAttachmentRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
2 properties
eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
2 properties
2 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
SubmitEmployeeResignationPtoReviewRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData
object
Specifies the text of additional questions that the client must answer when requesting a termination
2 properties
eor-offboarding_getContractOffboarding_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit
string
Unit of time measurement
eor-offboarding_getContractOffboardingRestrictedDates_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType
string
Type of time off tracking - whether it's tracked on Deel platform or off platform
RetrieveOffboardingAttachmentRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit
string
Unit of measurement for the time off entitlements
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems
object
8 properties
8 required
RetrieveOffboardingAttachmentRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems
object
2 properties
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError
object
1 property
RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError
object
1 property
ApiErrorContainer
object
2 properties
RetrieveRestrictedOffboardingDatesRequestBadRequestError
object
1 property
eor-offboarding_createEOROffboardingClientSignOff_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType
string
The time off tracking type
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter
object
5 properties
EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData
object
9 properties
eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200
object
1 property
1 required
ApiErrorRequest
object
7 properties
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError
object
1 property
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError
object
1 property
RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError
object
1 property
SubmitEmployeeResignationPtoReviewRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType
string
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
2 properties
2 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData
object
7 properties
6 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData
object
6 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData
object
3 properties
1 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
eor-offboarding_reviewEOROffboardingPTO_Response_201
object
1 property
1 required
RetrieveOffboardingRequestRequestBadRequestError
object
1 property
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
SubmitEmployeeResignationPtoReviewRequestForbiddenError
object
1 property
ApiError
object
2 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
RetrieveOffboardingRequestRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
RetrieveRestrictedOffboardingDatesRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
SubmitEmployeeResignationPtoReviewRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType
string
Type of severance offered to the employee
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData
object
9 properties
RetrieveOffboardingAttachmentRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
3 properties
2 required
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData
object
9 properties
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter
object
5 properties
EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData
object
4 properties
4 required
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason
string
Reason for declining the resignation request
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
3 properties
2 required
eor-offboarding_getContractOffboardingTimeOffs_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData
object
9 properties
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
RetrieveOffboardingRequestRequestInternalServerError
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deel 12
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
#subpackage_eorOffboarding
Where this information came from
This is an independent, third-party profile of Deel subpackage_eorOffboarding 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.