Holidays

Get a specific Holiday

Gets a holiday using the ID passed.

get/api/holidays/{id}

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/holidays/{id}
  • Auth: none declared

Path parameters

idinteger required

The ID of the holiday.

Query parameters

filterstring

Response

The holiday.

idinteger

The unique Id for this holiday

dateRangeStringstring nullable

A formatted string representation of the holiday date range

startDateStringstring nullable

A formatted string representation of the holiday start date

endDateStringstring nullable

A formatted string representation of the holiday end date

startDatestring date-time

Start of the holiday. Use in conjunction with the start type to determine the holiday start

adjustedStartDateUtcstring date-time nullable

UTC equivalent of the actual start of the booking period, adjusted for the organisation timezone and user work schedule. For daily bookings this reflects the start of the working day/period.

startType'Morning' | 'Afternoon' | 'Hours'

Morning - Booked for the morning of the start date Afternoon - Booked after the morning of the start date (starts at lunchtime) Hours - This is an hourly booking, use the time in the Start.

  • Morning
  • Afternoon
  • Hours
endDatestring date-time

End of the holiday. Use in conjunction with the end type to determine the holiday end

adjustedEndDateUtcstring date-time nullable

UTC equivalent of the actual end of the booking period, adjusted for the organisation timezone and user work schedule.

endType'Morning' | 'Afternoon' | 'Hours'

Used to define the time the holiday ends: Morning - Ends after the morning of the last day (lunchtime) Afternoon - Ends at the end of the last day (whole day booked) Hours - This is an hourly booking, use the time in the Start.

  • Morning
  • Afternoon
  • Hours
userIdinteger

The user this leave is for

userNamestring nullable

The user name this leave is for

requestedByIdinteger

The user who requested this leave

leaveTypeIdinteger
durationnumber double
deductionnumber double
actionerIdinteger
createdAtstring date-time
updatedAtstring date-time
reasonstring nullable

The reason for the holiday. Only visible if the requestor has permissions to see this

declineReasonstring nullable

The reason for declining (or cancelling) the holiday. Only visible if the requestor has permissions to see this

status'Pending' | 'Approved' | 'Cancelled' | 'Declined'

The status of this holiday

  • Pending
  • Approved
  • Cancelled
  • Declined
autoApprovedboolean

Whether this holiday was automatically approved (for example, if booked by an Admin user)

bookingUnit'Days' | 'Hours'

Whether the holiday was booked in day(s) or hours.

  • Days
  • Hours
leaveTypestring nullable

Changes

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