List Offboardings for Employment

Lists Offboarding requests for a specific employment.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	View offboarding requests (offboarding:read)	Manage offboarding (offboarding:write)

get/v1/offboardings/employments/{employment_id}

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/offboardings/employments/{employment_id}
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, offboarding:read, offboarding:write, employments, all:write, all:read)

Path parameters

employment_idstring required

Employment ID

Query parameters

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 65 revisions of this API.