REremote-com
Global Payroll

List Direct Offboardings

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.
  • 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.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See 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 typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage 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 tokenManage 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
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: offboarding:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: offboarding:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

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

No recorded changes to this operation across all 1 revision of this API.