---
title: "List Direct Offboardings"
method: GET
path: "/v1/direct-offboardings"
tags: ["Global Payroll"]
---

# List Direct Offboardings

`GET /v1/direct-offboardings`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/direct-offboardings`
- 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

Lists offboardings for global payroll employments, optionally filtered by employment 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`) |

## Query parameters

- `employment_id` string
- `employment_model` 'global_payroll'
- `page` integer
- `page_size` integer

## Response `200`

Success

- ListDirectOffboardingResponse: Response schema listing many direct_offboardings
  - `data` object
    - `current_page` integer: The current page among all of the total_pages
    - `direct_offboardings` DirectOffboarding[]
      - `employment_id` string, required: The unique identifier (UUID) of the employment being offboarded.
      - `id` string, required: The unique identifier (UUID) of the offboarding.
      - `is_confidential_termination` boolean, nullable, required: Whether the termination is confidential.
      - `last_working_day` string, date, nullable: Last working day of the employee.
      - `status` 'submitted' | 'in_review' | 'rejected' | 'pending_payment_details' | 'pending_payment' | 'completed', required: The current status of the offboarding.
      - `termination_date` string, date, nullable: Date when the employment terminates.
      - `type` 'termination' | 'resignation' | 'mutual_agreement' | 'retirement' | 'end_of_contract', required: The type of offboarding.
    - `total_count` integer: The total number of records in the result
    - `total_pages` integer: The total number of pages the user can go through

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity

---

[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)