Skip to content

Deel: Retrieve termination details by HRIS profile identifier

Deel offboarding.retrieveTerminationDetailsByHrisProfileIdentifier: arguments, response, policy and SDK examples.

← Offboarding operations · Get started

Operation deel.offboarding_retrieveterminationdetailsbyhrisprofileidentifier_v2026_01_01

Provider route: GET /offboarding/tracker/hris_profile/{oid}. 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["offboarding"]["retrieveTerminationDetailsByHrisProfileIdentifier"]>[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.offboarding.retrieveTerminationDetailsByHrisProfileIdentifier(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.offboarding.retrieve_termination_details_by_hris_profile_identifier(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

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve termination details by HRIS profile identifier — 200 response body

Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body

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

Retrieve termination details by HRIS profile identifier — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data

Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body — data

Retrieve termination details by HRIS profile identifier — 200 response body — data
FieldTypePresenceDescription and constraints
$objectRoot
app_experienceModelOptionalExpand Retrieve termination details — 200 response body — data app experience
contractModelOptionalExpand Retrieve termination details — 200 response body — data contract
hiring_typestringOptionalThe hiring type for the contract (e.g., contractor).
hris_profileModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile
progressModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data progress
summaryarrayOptional
summary[]ModelEach itemExpand Retrieve termination details by HRIS profile identifier — 200 response body — data summary item
terminationModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data termination

Referenced models: Retrieve termination details — 200 response body — data app experience, Retrieve termination details by HRIS profile identifier — 200 response body — data progress, Retrieve termination details by HRIS profile identifier — 200 response body — data summary item, Retrieve termination details — 200 response body — data contract, Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile, Retrieve termination details by HRIS profile identifier — 200 response body — data termination

Retrieve termination details — 200 response body — data app experience
FieldTypePresenceDescription and constraints
$objectRoot
is_minimal_requirementsbooleanOptionalIndicates whether the individual meets the minimal experience requirements for the role.
Retrieve termination details by HRIS profile identifier — 200 response body — data progress
FieldTypePresenceDescription and constraints
$objectRoot
reference_datestringOptionalThe reference date for the offboarding status (e.g., the termination date).
reference_date_timezonestringOptionalThe timezone of the reference date.
reference_date_typestringOptionalThe type of reference date (e.g., END_DATE).
statusstringOptionalThe current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS).
Retrieve termination details by HRIS profile identifier — 200 response body — data summary item
FieldTypePresenceDescription and constraints
$objectRoot
dataModelOptionalExpand Retrieve termination details by HRIS profile identifier — 200 response body — data summary item data
namestringOptionalThe name of the summary item (e.g., Contract ending details).
typestringOptionalThe type of summary information (e.g., CONTRACT_ENDING_DETAILS).
valuestringOptionalThe value or status associated with the summary item.

Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body — data summary item data

Retrieve termination details — 200 response body — data contract
FieldTypePresenceDescription and constraints
$objectRoot
contract_typestringOptionalThe type of the contract (e.g., payg_tasks).
eorJSONOptionalEmployer of Record (EOR) for the contract, if applicable.
eor (anyOf 1)ModelAlternativeExpand Retrieve termination details — 200 response body — data contract eor probation period
eor (anyOf 2)nullAlternative
idstringOptionalThe unique identifier for the contract.
namestringOptionalThe name or title of the contract.
oidstringOptionalThe object ID for the contract, which might be the same as the contract ID.
timezonestringOptionalThe timezone associated with the contract (e.g., Europe/Belgrade).

Referenced models: Retrieve termination details — 200 response body — data contract eor probation period

Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile
FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the individual in the HRIS profile.
oidstringOptionalThe unique object ID for the HRIS profile.
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeThe work email address of the individual in the HRIS profile.
work_email (anyOf 2)nullAlternativeThe work email address of the individual in the HRIS profile.
Retrieve termination details by HRIS profile identifier — 200 response body — data termination
FieldTypePresenceDescription and constraints
$objectRoot
eligible_for_rehireJSONOptional
eligible_for_rehire (anyOf 1)stringAlternativeIndicates whether the individual is eligible for rehire.
eligible_for_rehire (anyOf 2)nullAlternativeIndicates whether the individual is eligible for rehire.
eligible_for_rehire_reasonJSONOptional
eligible_for_rehire_reason (anyOf 1)stringAlternativeThe reason why the individual is or is not eligible for rehire.
eligible_for_rehire_reason (anyOf 2)nullAlternativeThe reason why the individual is or is not eligible for rehire.
end_dateJSONOptional
end_date (anyOf 1)stringAlternativeThe end date of the contract termination.
end_date (anyOf 2)nullAlternativeThe end date of the contract termination.
ending_typestringOptionalThe type of termination (e.g., ENDING_CONTRACT).
idJSONOptional
id (anyOf 1)stringAlternativeThe termination ID
id (anyOf 2)nullAlternativeThe termination ID
initiated_atJSONOptional
initiated_at (anyOf 1)stringAlternativeThe date and time when the termination was initiated.
initiated_at (anyOf 2)nullAlternativeThe date and time when the termination was initiated.
initiated_byJSONOptionalThe individual that initiated the termination.
initiated_by (anyOf 1)ModelAlternativeExpand Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination
initiated_by (anyOf 2)nullAlternative
public_messageJSONOptional
public_message (anyOf 1)stringAlternativeA public message regarding the termination.
public_message (anyOf 2)nullAlternativeA public message regarding the termination.
termination_impactJSONOptionalThe impact of the termination, if applicable.
termination_impact (anyOf 1)ModelAlternativeExpand Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable
termination_impact (anyOf 2)nullAlternative

Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination, Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable

Retrieve termination details by HRIS profile identifier — 200 response body — data summary item data
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalThe unique identifier for the contract associated with the summary item.
Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination
FieldTypePresenceDescription and constraints
$objectRootThe individual that initiated the termination.
namestringOptionalName of individual
profile_typestringOptionalindividual's type

SDK function policy ID: deel.offboarding_retrieveterminationdetailsbyhrisprofileidentifier_v2026_01_01. Catalog operation: offboarding_retrieveterminationdetailsbyhrisprofileidentifier_v2026_01_01. 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", "people: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.