Skip to content

Deel: Retrieve Offboarding Request

Deel eorOffboarding.getContractOffboarding: arguments, response, policy and SDK examples.

← EOR offboarding operations · Get started

Operation deel.eoroffboarding_getcontractoffboarding

Provider route: GET /eor/contracts/{contract_id}/offboarding. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["eorOffboarding"]["getContractOffboarding"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.eorOffboarding.getContractOffboarding(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.eor_offboarding.get_contract_offboarding(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.contract_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve Offboarding Request — 200 response body

Referenced models: Retrieve Offboarding Request — 200 response body

6 more schemas are linked from the tables above, on the schema pages.

Retrieve Offboarding Request — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelRequired within parentExpand Retrieve Offboarding Request — 200 response body — data

Referenced models: Retrieve Offboarding Request — 200 response body — data

Retrieve Offboarding Request — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringOptionalThe unique identifier of the employee contract.
created_atstringOptionalThe date and time the offboarding request was created
Format: date-time
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
desired_end_date (anyOf 2)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date-time
documentsModelOptionalExpand Request contract resignation — 201 response body — data documents
Document management structure for termination workflow including review processes and supporting documents
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
idstringOptionalThe unique identifier of the offboarding request
Format: uuid
is_sensitivebooleanOptionalIndicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team.
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand Retrieve Offboarding Request — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off
request_data (anyOf 2)nullAlternative
updated_atstringOptionalThe date and time the offboarding request was updated
Format: date-time

Referenced models: Request contract resignation — 201 response body — data documents, Retrieve Offboarding Request — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off

Request contract resignation — 201 response body — data documents
FieldTypePresenceDescription and constraints
$objectRootDocument management structure for termination workflow including review processes and supporting documents
offboardingarrayRequired within parentDocument set shared that requires client or employee review
offboarding[]ModelEach itemExpand Create client sign off — 200 response body — data documents offboarding item
supportingarrayRequired within parent
supporting[]ModelEach itemExpand Create client sign off — 200 response body — data documents supporting item

Referenced models: Create client sign off — 200 response body — data documents supporting item, Create client sign off — 200 response body — data documents offboarding item

Retrieve Offboarding Request — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off
FieldTypePresenceDescription and constraints
$objectRoot
desired_end_dateJSONOptional
desired_end_date (anyOf 1)stringAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date
desired_end_date (anyOf 2)nullAlternativeThe desired end date. If the date is not provided, it will be selected by HRX the closest date possible
Format: date
eligible_for_rehireJSONOptionalParameter to inform whether it would be possible for the client to hire the employee again
eligible_for_rehire (anyOf 1)stringAlternativeParameter to inform whether it would be possible for the client to hire the employee again
Known values: YES, NO, DONT_KNOW
eligible_for_rehire (anyOf 2)nullAlternative
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
eligible_for_rehire_reason (anyOf 2)nullAlternativeDescribe if the option DONT_KNOW was selected on eligible_for_rehire
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe definitive contract end date
Format: date-time
end_date (anyOf 2)nullAlternativeThe definitive contract end date
Format: date-time
reasonModelOptionalExpand Retrieve Offboarding Request — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off reason
The reason for the termination
reason_detailJSONOptional
reason_detail (anyOf 1)stringAlternativeOptional field to describe the reason behind the resignation request
reason_detail (anyOf 2)nullAlternativeOptional field to describe the reason behind the resignation request
used_time_offModelOptionalExpand Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off
Time-off usage data including policy information and tracking periods

Referenced models: Retrieve Offboarding Request — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off reason, Create client sign off — 200 response body — data request data desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, used time off used time off

Create client sign off — 200 response body — data documents supporting item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringRequired within parentThe date and time the file was created
Format: date-time
idstringRequired within parentThe unique identifier of the file
is_additional_supporting_documentbooleanRequired within parentIndicates if this is an additional supporting document added after the initial submission
namestringRequired within parentThe name of the file
typestringRequired within parentThe type/extension of the file
updated_atstringRequired within parentThe date and time the file was updated
Format: date-time
Create client sign off — 200 response body — data documents offboarding item
FieldTypePresenceDescription and constraints
$objectRoot
created_atstringOptionalThe date and time the document set was created
Format: date-time
filesarrayRequired within parent
files[]ModelEach itemExpand Create client sign off — 200 response body — data documents offboarding item files item
idstringOptionalThe unique identifier of the document set shared with the employee.
Format: uuid
is_employee_notification_requiredbooleanRequired within parentIndicates if the employee should be notified about this document review
notification_instructionsJSONOptional
notification_instructions (anyOf 1)stringAlternativeHTML instructions for the reviewer notification
notification_instructions (anyOf 2)nullAlternativeHTML instructions for the reviewer notification
reviewed_atJSONOptional
reviewed_at (anyOf 1)stringAlternativeThe date and time when the document was reviewed
Format: date-time
reviewed_at (anyOf 2)nullAlternativeThe date and time when the document was reviewed
Format: date-time
reviewed_byJSONOptional
reviewed_by (anyOf 1)stringAlternativeThe name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client
reviewed_by (anyOf 2)nullAlternativeThe name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client
reviewer_feedbackJSONOptional
reviewer_feedback (anyOf 1)stringAlternativeFeedback provided by the reviewer
reviewer_feedback (anyOf 2)nullAlternativeFeedback provided by the reviewer
reviewer_typestringRequired within parentThe type of reviewer for this document
Known values: CLIENT, EMPLOYEE
statusstringRequired within parentThe current status of the document review
Known values: AWAITING_REVIEW, AWAITING_FEEDBACK, FEEDBACK_PROVIDED, APPROVED, CHANGES_REQUESTED_BY_CLIENT, CHANGES_REQUESTED_BY_EMPLOYEE, WAIVED_REVIEW, NOT_RESPONDED, CANCELLED
updated_atstringOptionalThe date and time the document set was updated
Format: date-time

Referenced models: Create client sign off — 200 response body — data documents offboarding item files item

SDK function policy ID: deel.eoroffboarding_getcontractoffboarding. Catalog operation: eoroffboarding_getcontractoffboarding. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["contracts:read", "worker:read"]

Pinned headers: {"X-Version": "2026-01-01"}

Official provider source

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.