Holidays

Get a List of Holidays.

Query the holidays for your organisation. There are many ways to filter the results, all of which are optional. Results are limited to 100 per request.

Results are scoped to your organisation, so a filter that matches nothing — including an id belonging to another organisation — returns an empty list rather than an error. Note the scope is your organisation rather than your own visibility, so this can return absences for people you would not see on a wallchart.

get/api/holidays

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
  • Auth: none declared

Query parameters

DepartmentIdinteger

Filter holidays by a department

LeaveTypeIdinteger

Filter holidays by a leave type

DepartmentManagersOnlyboolean

Filter holidays for those for department managers only

MyTeamOnlyinteger

Filter holidays for those for my team only, based on the user ID you set here.

MyFavouritesOnlyinteger

Filter holidays for those for my favourite users only, based on the User Id you set here.

UserIdsstring

Filter holidays to include only these user(s)

ExclusionUserIdsstring

Filter holidays to exclude these user(s)

NonArchivedUsersOnlyboolean

Only return holidays for users that haven't been archived

Startstring date-time

Filter all holidays on or after this date

TransactionYearinteger

Filter all holidays in this transaction year. Don't use this if you're not including the transactions in your query.

Endstring date-time

Filter all holidays before and including this date

Status'PendingOrApproved' | 'Pending' | 'Approved' | 'Cancelled' | 'Declined' | 'Any'

Filter all holidays for the given status. If none given then all pending and approved holidays are included. Values are: Pending = 1, Approved = 2, Cancelled = 4, Declined = 8 This is a bitwise enum, so for example if you want all declined and cancelled you can pass 12 as the status.

ApproverIdinteger

Filter holidays by the approver

PageNumberinteger

Current page number, if required. Will default to 1 if not supplied

Response

The matching holidays. An empty list if nothing matched the filter.

totalRecordsinteger
pageNumberinteger
nextPageLinkstring nullable
previousPageLinkstring nullable

Changes

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