Terminations

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

Lists offboardings for a company.

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

Request

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

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

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