v1
latestOpenAPI 3.1.02026-07-242735131.1 MBTerminations
Show Offboarding
Shows an Offboarding request.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (employments) | View offboarding requests (offboarding:read) | Manage offboarding (offboarding:write) |
get/v1/offboardings/{id}
Path parameters
idstring required
Offboarding request ID
Response
Success
Example response
{
"data": {
"offboarding": {
"additional_comments": "additional comments regarding the termination reason",
"agrees_to_pto_amount": "true",
"confidential": false,
"employee_awareness": {
"date": "2023-12-12",
"note": "optional text to add details"
},
"employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
"id": "ba310525-9282-40c9-8977-14d844bf891a",
"offboarding_id": "71a95754-f8f7-4763-97b4-ae20c73477a3",
"proposed_termination_date": "2023-12-20",
"reason_description": "They had some performance issues and mismatched expectations.",
"requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
"risk_assessment_reasons": [
"pregnant_or_breastfeeding",
"family_leave"
],
"status": "submitted",
"submitted_at": "2023-04-13T13:35:06Z",
"termination_date": "2023-12-20",
"termination_reason": "workforce_reduction",
"type": "termination",
"will_challenge_termination": true,
"will_challenge_termination_description": "additional details for the offboarding risk assessment"
}
}
}