Deel Subpackage Eor Offboarding API
The subpackage_eorOffboarding API from Deel — 8 operation(s) for subpackage_eoroffboarding.
Deel Subpackage Eor Offboarding API is one of 128 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.2.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 Eor Offboarding 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 EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties), EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties), EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties), EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems (11 properties). Each schema is shown below with its type and property counts.
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
RetrieveOffboardingRequestRequestForbiddenError
object
1 property
RetrieveOffboardingRequestRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
3 properties
2 required
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType
string
Type of time off tracking - whether it's tracked on Deel platform or off platform
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData
object
3 properties
3 required
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff
object
Required when trackingtype is OFFPLATFORM, null otherwise
3 properties
3 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
RetrieveOffboardingAttachmentRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit
string
Unit of measurement for the time off entitlements
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems
object
2 properties
RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError
object
1 property
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError
object
1 property
RetrieveRestrictedOffboardingDatesRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType
string
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData
object
9 properties
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems
object
8 properties
8 required
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
RetrieveOffboardingRequestRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
2 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError
object
1 property
eor-offboarding_getContractOffboarding_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems
object
3 properties
3 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData
object
9 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason
string
Reason for declining the resignation request
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData
object
7 properties
6 required
SubmitEmployeeResignationPtoReviewRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData
object
Specifies the text of additional questions that the client must answer when requesting a termination
2 properties
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter
object
5 properties
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType
string
The time off tracking type
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError
object
1 property
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData
object
6 properties
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings
object
Policy configuration settings for time off calculations
3 properties
3 required
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError
object
1 property
RetrieveRestrictedOffboardingDatesRequestInternalServerError
object
1 property
RetrieveRestrictedOffboardingDatesRequestBadRequestError
object
1 property
RetrieveOffboardingAttachmentRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit
string
Unit of time measurement
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff
object
Time-off usage data including policy information and tracking periods
3 properties
2 required
RetrieveRestrictedOffboardingDatesRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData
object
4 properties
4 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
RetrieveOffboardingRequestRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData
object
9 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
RetrieveOffboardingAttachmentRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems
object
5 properties
4 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails
object
3 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
eor-offboarding_getContractOffboardingTimeOffs_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
3 properties
2 required
ApiErrorContainer
object
2 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType
string
Type of severance offered to the employee
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
eor-offboarding_reviewEOROffboardingPTO_Response_201
object
1 property
1 required
SubmitEmployeeResignationPtoReviewRequestBadRequestError
object
1 property
ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError
object
1 property
ApiErrorRequest
object
7 properties
RetrieveOffboardingAttachmentRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError
object
1 property
eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200
object
1 property
1 required
SubmitEmployeeResignationPtoReviewRequestInternalServerError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError
object
1 property
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
2 properties
2 required
eor-offboarding_getContractOffboardingRestrictedDates_Response_200
object
1 property
1 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit
string
The unit of measurement for time off tracking
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData
object
3 properties
1 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason
string
The reason for the termination
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems
object
11 properties
4 required
ApiError
object
2 properties
RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData
object
9 properties
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus
string
The current status of the document review
eor-offboarding_createEOROffboardingClientSignOff_Response_200
object
1 property
1 required
SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError
object
1 property
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType
string
The type of reviewer for this document
EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems
object
3 properties
3 required
EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData
object
7 properties
EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments
object
Document management structure for termination workflow including review processes and supporting documents
2 properties
2 required
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems
object
3 properties
EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems
object
9 properties
9 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems
object
4 properties
4 required
SubmitEmployeeResignationPtoReviewRequestUnauthorizedError
object
1 property
EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems
object
6 properties
6 required
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter
object
5 properties
EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire
string
Parameter to inform whether it would be possible for the client to hire the employee again
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Deel 12
Other APIs Deel publishes across the network.
Deel Adjustments API
Deel Applications API
Deel Candidates API
Deel Contractor Amendments API
Deel Contractor Hiring API
Deel Contracts API
Deel Custom Fields API
Deel IT API
Deel EOR Amendments API
Deel EOR Benefits API
Deel EOR Cost Calculator API
Deel EOR Hiring API
#subpackage_eorOffboarding
Where this information came from
This is an independent, third-party profile of Deel Subpackage Eor Offboarding 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.