LeaveTypes

Get a Collection of Leave Types

Get a Collection of Leave Types for Your Organisation.

get/api/leavetypes

Request

  • Base URL: https://app.timetastic.co.uk (the document declares no server; this is the origin it was published from)
  • URL: https://app.timetastic.co.uk/api/leavetypes
  • Auth: none declared

Query parameters

includeInactiveboolean

Optional. Set to true to also return inactive (deleted) leave types. Defaults to false (active only).

Response

The leave types for your organisation.

idinteger
namestring nullable
organisationIdinteger
deductedboolean

Does this leave type deduct from your allowance

requiresApprovalboolean

Does this leave type require approval, or it is automatically approved

includeMaxOffboolean

Is this leave type considered in maximum absent restrictions

isPrivateboolean

Is this leave type private

activeboolean

Is this leave type active?

isInUseboolean

Is this leave type in use for holiday bookings

createdAtstring date-time
updatedAtstring date-time
colorstring nullable

The assigned colour for this leave type

iconstring nullable

The assigned icon for this leave type

calendarVisibility1 | 2 | 3

Whether this leave type is set to "Busy" or "Available" on external calendars

  • 1 — Busy
  • 2 — Available
  • 3 — OutOfOffice
limitHoursnumber double nullable

The limit in hours for this leave type

limitDaysnumber double nullable

The limit in days for this leave type

Changes

No recorded changes to this operation across all 1 revision of this API.