Terminations

Create Offboarding

Creates an Offboarding request

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:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage employments (employments)	-	Manage offboarding (offboarding:write)
Company-scoped access token (assertion)	Manage employments (employments)	-	Manage offboarding (offboarding:write)
Customer API token	Manage employments (employments)	-	Manage offboarding (offboarding:write)

post/v1/offboardings

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/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:write
- 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:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Request body

employment_idstring required

The unique identifier (UUID) of the employment to be terminated.

type'termination' required

The type of the offboarding request. For now, only termination is allowed.

Example request

{
  "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
  "termination_details": {
    "additional_comments": "additional comments regarding the termination reason",
    "confidential": false,
    "employee_awareness": {
      "date": "2023-12-12",
      "note": "optional text to add details"
    },
    "proposed_termination_date": "2023-12-20",
    "reason_description": "termination reason",
    "risk_assessment_reasons": [
      "pregnant_or_breastfeeding",
      "family_leave"
    ],
    "termination_reason": "workforce_reduction",
    "termination_reason_files": [
      {
        "content": "UGVyaW9kIEVuZCBEYXRlLFBheSBEYXRlLEVtcG...5jZSBPZiBSZXNpZGVuYdXJyZW50LEFsbG93",
        "name": "termination_letter.pdf"
      }
    ],
    "will_challenge_termination": true,
    "will_challenge_termination_description": "additional details for the offboarding risk assessment"
  },
  "type": "termination"
}

Response

Success

Example response

{
  "data": {
    "offboarding": {
      "additional_comments": "additional comments regarding the termination reason",
      "agrees_to_pto_amount": "true",
      "confidential": false,
      "employee_awareness": {
        "date": "2023-12-12",
        "note": "optional text to add details"
      },
      "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
      "id": "ba310525-9282-40c9-8977-14d844bf891a",
      "offboarding_id": "71a95754-f8f7-4763-97b4-ae20c73477a3",
      "proposed_termination_date": "2023-12-20",
      "reason_description": "They had some performance issues and mismatched expectations.",
      "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
      "risk_assessment_reasons": [
        "pregnant_or_breastfeeding",
        "family_leave"
      ],
      "status": "submitted",
      "submitted_at": "2023-04-13T13:35:06Z",
      "termination_date": "2023-12-20",
      "termination_reason": "workforce_reduction",
      "type": "termination",
      "will_challenge_termination": true,
      "will_challenge_termination_description": "additional details for the offboarding risk assessment"
    }
  }
}

Changes

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