Retrieve an absence type

Operation ID: getAbsenceType

Group: People Management › Absence Types

Open in the interactive reference

GET /people/absence-types/{id}

Read-only: Reads and returns; changes nothing.

Retrieves an absence type.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier of the absence type you want to retrieve.

Response

200 Success

Under data (getAbsenceTypeOutput):

Field Type Required Description
id string yes The unique identifier for the absence type.
name string yes The name of the absence type.
category any yes The category the absence type belongs to. One of: "sickLeave", "vacation", "other", "overtime".
description string no A description of the absence type. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "<name>",
    "category": "sickLeave",
    "description": "<description>"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses