Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Terminations

Show Offboarding (v2)

Returns a single offboarding by its ID.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View offboarding requests (offboarding:read)Manage offboarding (offboarding:write)
get/v2/offboardings/{id}

Path parameters

idstring required

Offboarding ID

Response

Success

Example response

{
  "data": {
    "offboarding": {
      "confidential": false,
      "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
      "id": "ba310525-9282-40c9-8977-14d844bf891a",
      "inserted_at": "2023-12-01T10:30:00Z",
      "reason": "performance",
      "request": {
        "additional_comments": "Final paycheck to include unused PTO.",
        "agrees_to_pto_amount": true,
        "employee_awareness": {
          "date": "2023-11-15",
          "note": "Conversation held during 1:1."
        },
        "proposed_termination_date": "2024-01-15",
        "reason_description": "Sustained underperformance after improvement plan.",
        "risk_assessment_reasons": [
          "none_of_these"
        ],
        "will_challenge_termination": false,
        "will_challenge_termination_description": ""
      },
      "status": "pending_payment",
      "termination_date": "2024-01-15",
      "type": "termination"
    }
  }
}