Skip to content

Deel: Get termination

Deel eorTerminations.getTermination: arguments, response, policy and SDK examples.

← EOR terminations operations · Get started

Operation deel.eorterminations_gettermination

Provider route: GET /eor/{oid}/terminations/{terminationId}. 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["eorTerminations"]["getTermination"]>[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.eorTerminations.getTermination(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_terminations.get_termination(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.oidstringRequired within parent
path.terminationIdstringRequired 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 Get termination — response body

Referenced models: Get termination — response body

Get termination — response body
FieldTypePresenceDescription and constraints
$objectRoot
contract_idstringOptionalPublic contract oid
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
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
idstringOptional
request_dataJSONOptional
request_data (anyOf 1)ModelAlternativeExpand Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact
request_data (anyOf 2)nullAlternative

Referenced models: Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact

Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact
FieldTypePresenceDescription and constraints
$objectRoot
custom_termination_reason_idJSONOptional
custom_termination_reason_id (anyOf 1)stringAlternativeCustom termination reason ID. A custom termination reason can be added on Client HR module
custom_termination_reason_id (anyOf 2)nullAlternativeCustom termination reason ID. A custom termination reason can be added on Client HR module
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
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 eligibleForRehire
eligible_for_rehire_reason (anyOf 2)nullAlternativeDescribe if the option DONT_KNOW was selected on eligibleForRehire
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
reasonJSONOptional
reason (anyOf 1)stringAlternative
reason (anyOf 2)nullAlternative
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
termination_impactJSONOptionalCustom termination impact data if there is some configured on HR module
termination_impact (anyOf 1)ModelAlternativeExpand Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact termination impact description, id, title
termination_impact (anyOf 2)nullAlternative

Referenced models: Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact termination impact description, id, title

Get termination — response body — request data custom termination reason id, desired end date, eligible for rehire, eligible for rehire reason, end date, reason, reason detail, termination impact termination impact description, id, title
FieldTypePresenceDescription and constraints
$objectRootCustom termination impact data if there is some configured on HR module
descriptionstringOptionalTermination impact description
idstringOptionalFormat: uuid
titlestringOptionalTermination impact title

SDK function policy ID: deel.eorterminations_gettermination. Catalog operation: eorterminations_gettermination. 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"]

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.