List Offboardings (v2). Requires a token issued via the authorization_code grant (company_manager role) — not usable with a client_credentials (integration) token.

Changed on Jul 8, 2026

Lists offboardings for a company.

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

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	View offboarding requests (offboarding:read)	Manage offboarding (offboarding:write)

get/v2/offboardings

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v2/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

Filter by offboarding type.

include_confidentialboolean

By default, the results do not include confidential termination requests. Send include_confidential=true to include confidential requests in the response.

pageinteger

Starts fetching records after the given page

page_sizeinteger

Change the amount of records returned per page, defaults to 20, limited to 100

Response

Success

Example response

{
  "current_page": 1,
  "offboardings": [
    {
      "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"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

Jul 8, 2026368362078830 Revision changes
- warning
  added the new cancellation enum value to the /// response property for the response status
- warning
  added the new conversion enum value to the /// response property for the response status
- warning
  added the new relocation enum value to the /// response property for the response status
- warning
  added the new transfer enum value to the /// response property for the response status
- info
  added the new enum value cancellation to the query request parameter type
- info
  added the new enum value conversion to the query request parameter type
- info
  added the new enum value relocation to the query request parameter type
- info
  added the new enum value transfer to the query request parameter type

Operation history