Offboarding
Global Payroll

List Direct Offboardings

Changed on

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 through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View offboarding requests (offboarding:read)Manage offboarding (offboarding:write)
get/v1/direct-offboardings

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/direct-offboardings
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, offboarding:read, offboarding:write, employments, all:write, all:read)

Query parameters

employment_idstring

Filter by employment ID

employment_model'global_payroll'

Filter by employment model. Currently only 'global_payroll' is supported.

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "direct_offboardings": [
    {
      "employment_id": "emp-xyz789",
      "id": "offb-abc123",
      "is_confidential_termination": true,
      "last_working_day": "2026-08-30",
      "status": "pending_payment",
      "termination_date": "2026-08-31",
      "type": "termination"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes