Sage HR

Sage HR Offboarding API

The Offboarding API from Sage HR — 2 operation(s) for offboarding.

GitHub OpenAPI

Documentation

📖
Documentation
https://apidoc.sage.hr/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sage-hr/refs/heads/main/openapi/sage-hr-offboarding-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sage-hr/refs/heads/main/json-schema/sage-hr-employee-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/sage-hr/refs/heads/main/json-ld/sage-hr-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sage-hr-offboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sage-hr-offboarding-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  description: All requests are required to be sent to your subdomain. To learn how to enable API in your Sage HR account, please visit https://support.sage.hr/en/articles/3246469-how-does-cakehr-api-work
  title: Sage HR Documents Offboarding API
  version: '1.0'
  x-konfig-ignore:
    potential-incorrect-type: true
  x-konfig-uses-multipart-form-data: true
servers:
- url: https://subdomain.sage.hr/api
tags:
- name: Offboarding
paths:
  /offboarding/categories:
    summary: Offboarding task categories
    get:
      operationId: Offboarding_listCategories
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                    - title: General
                      id: 1
                    - title: Platform
                      id: 2
              schema:
                $ref: '#/components/schemas/OffboardingListCategoriesResponse'
          description: Successful Response
      summary: List offboarding task categories
      tags:
      - Offboarding
      x-konfig-operation-can-have-single-parameter: true
      x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-get--offboarding-categories
      x-accepts: application/json
  /offboarding/tasks:
    summary: Offboarding task
    post:
      operationId: Offboarding_createTask
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OffboardingCreateTaskRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              examples:
                response:
                  value:
                    data:
                      id: 1
              schema:
                $ref: '#/components/schemas/OffboardingCreateTaskResponse'
          description: Successful Response
      summary: Create new offboarding task
      tags:
      - Offboarding
      x-konfig-operation-can-have-single-parameter: true
      x-konfig-single-parameter-schema: konfig-generated-schema-single-parameter-schema-post--offboarding-tasks
      x-content-type: application/x-www-form-urlencoded
      x-accepts: application/json
components:
  schemas:
    OffboardingCreateTaskResponse:
      example:
        data:
          id: 1
      properties:
        data:
          $ref: '#/components/schemas/OffboardingCreateTaskResponse_data'
      type: object
      x-konfig-original-example:
        data:
          id: 1
      x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingCreateTaskResponse
      x-konfig-is-used-in-successful-response: true
    OffboardingListCategoriesResponse_data_inner:
      properties:
        title:
          example: General
          type: string
          x-konfig-original-example: General
          x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingListCategoriesResponse-properties-data-items-properties-title
        id:
          example: 1
          type: number
          x-konfig-original-example: 1
          x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingListCategoriesResponse-properties-data-items-properties-id
      type: object
    OffboardingListCategoriesResponse:
      example:
        data:
        - title: General
          id: 1
        - title: Platform
          id: 2
      properties:
        data:
          items:
            $ref: '#/components/schemas/OffboardingListCategoriesResponse_data_inner'
          type: array
      type: object
      x-konfig-original-example:
        data:
        - title: General
          id: 1
        - title: Platform
          id: 2
      x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingListCategoriesResponse
      x-konfig-is-used-in-successful-response: true
    OffboardingCreateTaskRequest:
      properties:
        title:
          type: string
        description:
          type: string
        boarding_task_template_category_id:
          type: number
        due_in:
          description: Due date in days before employee last working day
          example: 30
          type: number
          x-konfig-original-example: 30
          x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingCreateTaskRequest-properties-due_in
        default_assignee_type:
          description: 'Default: self; leader - direct manager; employee - specific employee via assignee_id'
          enum:
          - self
          - leader
          - employee
          type: string
        assignee_id:
          description: Specific assignee if default_assignee_type is 'employee'
          type: number
        require_attachment:
          description: '''true'' to enabled required attachment'
          type: string
      required:
      - boarding_task_template_category_id
      - due_in
      - title
      type: object
    OffboardingCreateTaskResponse_data:
      properties:
        id:
          example: 1
          type: number
          x-konfig-original-example: 1
          x-konfig-generated-schema: konfig-generated-schema-components-schemas-OffboardingCreateTaskResponse-properties-data-properties-id
      type: object
  securitySchemes:
    api_key:
      description: All request are required to pass a `X-Auth-Token` header.
      in: header
      name: X-Auth-Token
      type: apiKey
      x-konfig-globally-required-security: false