---
title: "Show Offboarding (v2)"
method: GET
path: "/v2/offboardings/{id}"
tags: ["Terminations"]
---

# Show Offboarding (v2)

`GET /v2/offboardings/{id}`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v2/offboardings/{id}`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `offboarding:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `offboarding:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

Returns a single offboarding by its ID.

## Authentication

This endpoint accepts any one of the following token types:

- **Company-scoped access token** (`OAuth2AuthorizationCode`) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Company-scoped access token (assertion)** (`OAuth2CompanyManagerAssertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant for a company manager. See [OAuth Assertion](https://developer.remote.com/docs/authorization-method-oauth-assertion).
- **Customer API token** (`CustomerAPIToken`) — generated by the customer on their Integration Settings page, with the scopes they choose there. See [Authorization for customers](https://developer.remote.com/docs/authorization-for-customers).

## Scopes

Any one of the scopes in a token type's row is enough. `all:read` and `all:write` work too.

| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |
| Company-scoped access token (assertion) | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |
| Customer API token | Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |

## Path parameters

- `id` string, required

## Response `200`

Success

- V2OffboardingResponse: Response containing a single v2 offboarding record.
  - `data` object
    - `offboarding` V2Offboarding: An offboarding record. Top-level fields hold the offboarding's lifecycle state. The nested `request` object holds the immutable creation snapshot of the inputs submitted when the offboarding was created.
      - `confidential` boolean, nullable: Whether the offboarding is confidential. Confidential offboardings are hidden from list and show responses by default.
      - `employment_id` string, required: The unique identifier (UUID) of the employment being offboarded.
      - `id` string, required: The unique identifier (UUID) of the offboarding record.
      - `inserted_at` string, datetime, required: The timestamp when the offboarding record was created.
      - `reason` string, nullable: The reason for the offboarding.
      - `request` union: The shape depends on the originating request: offboardings that originated from a termination carry a `V2TerminationRequest`; those that originated from a resignation carry a `V2ResignationRequest`.
        - V2TerminationRequest: Snapshot of the inputs submitted when a `termination` offboarding was created. These fields do not change as the offboarding progresses.
          - `additional_comments` string, nullable: Free-text additional comments submitted by the requester.
          - `agrees_to_pto_amount` boolean, nullable: Whether the requester agreed with the proposed PTO amount.
          - `employee_awareness` object, nullable: Present only when the requester indicated they have already informed the employee about the termination.
            - `date` string, date, nullable
            - `note` string, nullable
          - `proposed_termination_date` string, date, nullable: The termination date proposed by the requester.
          - `reason_description` string, nullable: Free-text description of the termination reason submitted by the requester.
          - `risk_assessment_reasons` string[], nullable: Risk-assessment flags submitted by the requester.
          - `will_challenge_termination` boolean, nullable: Whether the requester expects the employee to challenge the termination.
          - `will_challenge_termination_description` string, nullable: Additional context the requester provided about a potential challenge.
        - V2ResignationRequest: Snapshot of the inputs submitted when a `resignation` offboarding was created. These fields do not change as the offboarding progresses.
          - `additional_comments` string, nullable: Free-text additional comments submitted by the employee.
          - `employer_awareness` string, nullable: Present only when the employee indicated they have already informed the employer about the resignation.
          - `proposed_last_working_day` string, date, nullable: The last working day proposed by the employee.
          - `reason_description` string, nullable: Free-text description of the resignation reason submitted by the employee.
      - `status` 'requested' | 'in_review' | 'pending_payment' | 'completed', required: The current processing status of the offboarding. - `requested`: The offboarding request has been received and is awaiting review. - `in_review`: Remote is reviewing the request for legal compliance and risks. - `pending_payment`: The offboarding has been approved and submitted to payroll; the employee's final payment is being processed. - `completed`: The offboarding is complete and the employment has been terminated.
      - `termination_date` string, date, nullable: The confirmed last day of employment. May be null until Remote finalizes the date.
      - `type` 'termination' | 'resignation' | 'cancellation' | 'relocation' | 'transfer' | 'conversion', required: The offboarding type.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too many requests

---

[API](https://skmtc.dev/remote-com/apis/offboarding.md) - [All operations](https://skmtc.dev/remote-com/apis/offboarding/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/offboarding/revisions/f0d3f7cbc9dd?raw)