v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Terminations

List Offboarding

Lists Offboarding requests.

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

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
}