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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.contract_id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve Offboarding Request — 200 response body |
Referenced models: Retrieve Offboarding Request — 200 response body
Schemas
Section titled “Schemas”6 more schemas are linked from the tables above, on the schema pages.
Retrieve Offboarding Request — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Required within parent | Expand Retrieve Offboarding Request — 200 response body — data |
Referenced models: Retrieve Offboarding Request — 200 response body — data
Retrieve Offboarding Request — 200 response body — data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_id | string | Optional | The unique identifier of the employee contract. |
created_at | string | Optional | The date and time the offboarding request was created Format: date-time |
desired_end_date | JSON | Optional | |
desired_end_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Format: date-time |
documents | Model | Optional | Expand Request contract resignation — 201 response body — data documents Document management structure for termination workflow including review processes and supporting documents |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The definitive contract end date Format: date-time |
end_date (anyOf 2) | null | Alternative | The definitive contract end date Format: date-time |
id | string | Optional | The unique identifier of the offboarding request Format: uuid |
is_sensitive | boolean | Optional | Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team. |
request_data | JSON | Optional | |
request_data (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
updated_at | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Document management structure for termination workflow including review processes and supporting documents |
offboarding | array | Required within parent | Document set shared that requires client or employee review |
offboarding[] | Model | Each item | Expand Create client sign off — 200 response body — data documents offboarding item |
supporting | array | Required within parent | |
supporting[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
desired_end_date | JSON | Optional | |
desired_end_date (anyOf 1) | string | Alternative | The 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) | null | Alternative | The desired end date. If the date is not provided, it will be selected by HRX the closest date possible Format: date |
eligible_for_rehire | JSON | Optional | Parameter to inform whether it would be possible for the client to hire the employee again |
eligible_for_rehire (anyOf 1) | string | Alternative | Parameter 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) | null | Alternative | |
eligible_for_rehire_reason | JSON | Optional | |
eligible_for_rehire_reason (anyOf 1) | string | Alternative | Describe if the option DONT_KNOW was selected on eligible_for_rehire |
eligible_for_rehire_reason (anyOf 2) | null | Alternative | Describe if the option DONT_KNOW was selected on eligible_for_rehire |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The definitive contract end date Format: date-time |
end_date (anyOf 2) | null | Alternative | The definitive contract end date Format: date-time |
reason | Model | Optional | Expand 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_detail | JSON | Optional | |
reason_detail (anyOf 1) | string | Alternative | Optional field to describe the reason behind the resignation request |
reason_detail (anyOf 2) | null | Alternative | Optional field to describe the reason behind the resignation request |
used_time_off | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Required within parent | The date and time the file was created Format: date-time |
id | string | Required within parent | The unique identifier of the file |
is_additional_supporting_document | boolean | Required within parent | Indicates if this is an additional supporting document added after the initial submission |
name | string | Required within parent | The name of the file |
type | string | Required within parent | The type/extension of the file |
updated_at | string | Required within parent | The date and time the file was updated Format: date-time |
Create client sign off — 200 response body — data documents offboarding item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
created_at | string | Optional | The date and time the document set was created Format: date-time |
files | array | Required within parent | |
files[] | Model | Each item | Expand Create client sign off — 200 response body — data documents offboarding item files item |
id | string | Optional | The unique identifier of the document set shared with the employee. Format: uuid |
is_employee_notification_required | boolean | Required within parent | Indicates if the employee should be notified about this document review |
notification_instructions | JSON | Optional | |
notification_instructions (anyOf 1) | string | Alternative | HTML instructions for the reviewer notification |
notification_instructions (anyOf 2) | null | Alternative | HTML instructions for the reviewer notification |
reviewed_at | JSON | Optional | |
reviewed_at (anyOf 1) | string | Alternative | The date and time when the document was reviewed Format: date-time |
reviewed_at (anyOf 2) | null | Alternative | The date and time when the document was reviewed Format: date-time |
reviewed_by | JSON | Optional | |
reviewed_by (anyOf 1) | string | Alternative | The 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) | null | Alternative | The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client |
reviewer_feedback | JSON | Optional | |
reviewer_feedback (anyOf 1) | string | Alternative | Feedback provided by the reviewer |
reviewer_feedback (anyOf 2) | null | Alternative | Feedback provided by the reviewer |
reviewer_type | string | Required within parent | The type of reviewer for this document Known values: CLIENT, EMPLOYEE |
status | string | Required within parent | The 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_at | string | Optional | The 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
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}