Terminations

Show Offboarding (v2)

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

get/v2/offboardings/{id}

Request

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

Path parameters

idstring required

Offboarding ID

Response

Success

Example response

{
  "data": {
    "offboarding": {
      "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"
    }
  }
}

Changes

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