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.
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["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 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.offboarding.retrieve_termination_details_by_hris_profile_identifier(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.oid | 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 termination details by HRIS profile identifier — 200 response body |
Referenced models: Retrieve termination details by HRIS profile identifier — 200 response body
Schemas
Section titled “Schemas”3 more schemas are linked from the tables above, on the schema pages.
Retrieve termination details by HRIS profile identifier — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
app_experience | Model | Optional | Expand Retrieve termination details — 200 response body — data app experience |
contract | Model | Optional | Expand Retrieve termination details — 200 response body — data contract |
hiring_type | string | Optional | The hiring type for the contract (e.g., contractor). |
hris_profile | Model | Optional | Expand Retrieve termination details by HRIS profile identifier — 200 response body — data hris profile |
progress | Model | Optional | Expand Retrieve termination details by HRIS profile identifier — 200 response body — data progress |
summary | array | Optional | |
summary[] | Model | Each item | Expand Retrieve termination details by HRIS profile identifier — 200 response body — data summary item |
termination | Model | Optional | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
is_minimal_requirements | boolean | Optional | Indicates whether the individual meets the minimal experience requirements for the role. |
Retrieve termination details by HRIS profile identifier — 200 response body — data progress
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
reference_date | string | Optional | The reference date for the offboarding status (e.g., the termination date). |
reference_date_timezone | string | Optional | The timezone of the reference date. |
reference_date_type | string | Optional | The type of reference date (e.g., END_DATE). |
status | string | Optional | The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS). |
Retrieve termination details by HRIS profile identifier — 200 response body — data summary item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | Model | Optional | Expand Retrieve termination details by HRIS profile identifier — 200 response body — data summary item data |
name | string | Optional | The name of the summary item (e.g., Contract ending details). |
type | string | Optional | The type of summary information (e.g., CONTRACT_ENDING_DETAILS). |
value | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
contract_type | string | Optional | The type of the contract (e.g., payg_tasks). |
eor | JSON | Optional | Employer of Record (EOR) for the contract, if applicable. |
eor (anyOf 1) | Model | Alternative | Expand Retrieve termination details — 200 response body — data contract eor probation period |
eor (anyOf 2) | null | Alternative | |
id | string | Optional | The unique identifier for the contract. |
name | string | Optional | The name or title of the contract. |
oid | string | Optional | The object ID for the contract, which might be the same as the contract ID. |
timezone | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
name | string | Optional | The name of the individual in the HRIS profile. |
oid | string | Optional | The unique object ID for the HRIS profile. |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | The work email address of the individual in the HRIS profile. |
work_email (anyOf 2) | null | Alternative | The work email address of the individual in the HRIS profile. |
Retrieve termination details by HRIS profile identifier — 200 response body — data termination
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
eligible_for_rehire | JSON | Optional | |
eligible_for_rehire (anyOf 1) | string | Alternative | Indicates whether the individual is eligible for rehire. |
eligible_for_rehire (anyOf 2) | null | Alternative | Indicates whether the individual is eligible for rehire. |
eligible_for_rehire_reason | JSON | Optional | |
eligible_for_rehire_reason (anyOf 1) | string | Alternative | The reason why the individual is or is not eligible for rehire. |
eligible_for_rehire_reason (anyOf 2) | null | Alternative | The reason why the individual is or is not eligible for rehire. |
end_date | JSON | Optional | |
end_date (anyOf 1) | string | Alternative | The end date of the contract termination. |
end_date (anyOf 2) | null | Alternative | The end date of the contract termination. |
ending_type | string | Optional | The type of termination (e.g., ENDING_CONTRACT). |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The termination ID |
id (anyOf 2) | null | Alternative | The termination ID |
initiated_at | JSON | Optional | |
initiated_at (anyOf 1) | string | Alternative | The date and time when the termination was initiated. |
initiated_at (anyOf 2) | null | Alternative | The date and time when the termination was initiated. |
initiated_by | JSON | Optional | The individual that initiated the termination. |
initiated_by (anyOf 1) | Model | Alternative | Expand Retrieve termination details by HRIS profile identifier — 200 response body — data termination initiated by The individual that initiated the termination |
initiated_by (anyOf 2) | null | Alternative | |
public_message | JSON | Optional | |
public_message (anyOf 1) | string | Alternative | A public message regarding the termination. |
public_message (anyOf 2) | null | Alternative | A public message regarding the termination. |
termination_impact | JSON | Optional | The impact of the termination, if applicable. |
termination_impact (anyOf 1) | Model | Alternative | Expand Retrieve termination details — 200 response body — data termination termination impact The impact of the termination, if applicable |
termination_impact (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The individual that initiated the termination. |
name | string | Optional | Name of individual |
profile_type | string | Optional | individual's type |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"}