Leave types

Get all leave types

Get all leave types

GEThttps://api.absentify.com/api/v1/leave_types

Authorization

ApiKey

Response

200default

Successful response

Body

application/json

id*string

name*string

createdAt*string (date-time)

updatedAt*string (date-time)

color*string

icon*string

needs_approval*boolean

deleted*boolean

deleted_at*nullable string (date-time)

deleted_by*nullable object

maximum_absent*boolean

leave_unit*enum

dayshalf_dayshoursminutes_30minutes_15minutes_10minutes_5minutes_1

position*number

take_from_allowance*boolean

privacy_hide_leavetype*boolean

outlook_synchronization_show_as*enum

freetentativebusyoofworkingElsewhereunknown

outlook_synchronization_subject*nullable string

allowance_type*nullable object

Request

JavaScriptCurlPython

const response = await fetch('https://api.absentify.com/api/v1/leave_types', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

[
  {
    "id": "text",
    "name": "text",
    "createdAt": "2024-10-06T11:05:31.604Z",
    "updatedAt": "2024-10-06T11:05:31.604Z",
    "color": "text",
    "icon": "text",
    "needs_approval": false,
    "deleted": false,
    "deleted_at": "2024-10-06T11:05:31.604Z",
    "deleted_by": {
      "id": "text",
      "name": "text",
      "email": "text"
    },
    "maximum_absent": false,
    "leave_unit": "days",
    "position": 0,
    "take_from_allowance": false,
    "privacy_hide_leavetype": false,
    "outlook_synchronization_show_as": "free",
    "outlook_synchronization_subject": "text",
    "allowance_type": {
      "id": "text",
      "name": "text",
      "ignore_allowance_limit": false,
      "allowance_unit": "days"
    }
  }
]

Create a leave type

Create a leave type

POSThttps://api.absentify.com/api/v1/leave_types

Authorization

ApiKey

Body

application/json

name*string

color*string

needs_approval*boolean

maximum_absent*boolean

leave_unit*enum

dayshalf_dayshoursminutes_30minutes_15minutes_10minutes_5minutes_1

position*number

take_from_allowance*boolean

privacy_hide_leavetype*boolean

outlook_synchronization_show_as*enum

freetentativebusyoofworkingElsewhereunknown

outlook_synchronization_subject*nullable string

icon*enum

NoIconUmbrellaAnchorArchiveAwardBriefcaseCalendarCastClockCoffeeCompassBatteryEmojiGiftFrownImageSunZapHomeUsers

reason_mandatory*boolean

reason_hint_text*nullable string

allowance_type_id*nullable string

Response

200default

Successful response

Body

application/json

string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://api.absentify.com/api/v1/leave_types', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "color": "text",
      "needs_approval": false,
      "maximum_absent": false,
      "leave_unit": "days",
      "position": 0,
      "take_from_allowance": false,
      "privacy_hide_leavetype": false,
      "outlook_synchronization_show_as": "free",
      "outlook_synchronization_subject": "text",
      "icon": "NoIcon",
      "reason_mandatory": false,
      "reason_hint_text": "text",
      "allowance_type_id": "text"
    }),
});
const data = await response.json();

Response

200default

123e4567-e89b-12d3-a456-426614174000

Read a leave type by id

Read a leave type by id

GEThttps://api.absentify.com/api/v1/leave_types/{id}

Authorization

ApiKey

Path parameters

id*string (uuid)

Response

200default

Successful response

Body

application/json

id*string

name*string

createdAt*string (date-time)

updatedAt*string (date-time)

color*string

icon*string

needs_approval*boolean

deleted*boolean

deleted_at*nullable string (date-time)

deleted_by*nullable object

maximum_absent*boolean

leave_unit*enum

dayshalf_dayshoursminutes_30minutes_15minutes_10minutes_5minutes_1

position*number

take_from_allowance*boolean

privacy_hide_leavetype*boolean

outlook_synchronization_show_as*enum

freetentativebusyoofworkingElsewhereunknown

outlook_synchronization_subject*nullable string

allowance_type*nullable object

Request

JavaScriptCurlPython

const response = await fetch('https://api.absentify.com/api/v1/leave_types/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "id": "text",
  "name": "text",
  "createdAt": "2024-10-06T11:05:31.604Z",
  "updatedAt": "2024-10-06T11:05:31.604Z",
  "color": "text",
  "icon": "text",
  "needs_approval": false,
  "deleted": false,
  "deleted_at": "2024-10-06T11:05:31.604Z",
  "deleted_by": {
    "id": "text",
    "name": "text",
    "email": "text"
  },
  "maximum_absent": false,
  "leave_unit": "days",
  "position": 0,
  "take_from_allowance": false,
  "privacy_hide_leavetype": false,
  "outlook_synchronization_show_as": "free",
  "outlook_synchronization_subject": "text",
  "allowance_type": {
    "id": "text",
    "name": "text",
    "ignore_allowance_limit": false,
    "allowance_unit": "days"
  }
}

Update a leave type

Update a leave type

PUThttps://api.absentify.com/api/v1/leave_types/{id}

Authorization

ApiKey

Path parameters

id*string (uuid)

Body

application/json

namestring

colorstring

needs_approvalboolean

maximum_absentboolean

leave_unitenum

dayshalf_dayshoursminutes_30minutes_15minutes_10minutes_5minutes_1

positionnumber

take_from_allowanceboolean

privacy_hide_leavetypeboolean

outlook_synchronization_show_asenum

freetentativebusyoofworkingElsewhereunknown

outlook_synchronization_subjectnullable string

iconenum

NoIconUmbrellaAnchorArchiveAwardBriefcaseCalendarCastClockCoffeeCompassBatteryEmojiGiftFrownImageSunZapHomeUsers

reason_mandatoryboolean

reason_hint_textnullable string

allowance_type_idnullable string

sync_optionenum

DisabledAllOnlyApproved

Response

200default

Successful response

Body

application/json

nullable string (uuid)

Request

JavaScriptCurlPython

const response = await fetch('https://api.absentify.com/api/v1/leave_types/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200default

123e4567-e89b-12d3-a456-426614174000

Delete a leave type

Delete a leave type

DELETEhttps://api.absentify.com/api/v1/leave_types/{id}

Authorization

ApiKey

Path parameters

id*string (uuid)

Query parameters

Response

200default

Successful response

Body

application/json

nullable enum

null

Request

JavaScriptCurlPython

const response = await fetch('https://api.absentify.com/api/v1/leave_types/{id}?deleted=false&deleted_by_member_id=123e4567-e89b-12d3-a456-426614174000', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200default

null