REremote-com
Terminations

List Offboarding

Lists Offboarding requests.

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/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: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

typestring

Filter by offboarding type

include_confidentialstring

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": [
    {
      "additional_comments": "",
      "agrees_to_pto_amount": true,
      "employer_awareness": "The employer was informed on 2023-12-12",
      "employment_id": "1e74fdc2-7420-4eef-ab0a-b794cbbef4e1",
      "id": "ba310525-9282-40c9-8977-14d844bf891a",
      "offboarding_id": "71a95754-f8f7-4763-97b4-ae20c73477a3",
      "proposed_last_working_day": "2023-12-20",
      "requested_by": "5a31f3c1-d7a7-4311-89cb-928959d3d540",
      "resignation_reason": "other_job_opportunity",
      "status": "submitted",
      "submitted_at": "2023-04-13T13:35:06Z",
      "termination_date": "2023-12-20",
      "type": "resignation"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

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