PublicHolidays

Get a List of Public Holidays

Get a collection of public holidays for your organisation.

Results are always scoped to your organisation, so a filter that matches nothing — an unknown country code, user or public holiday set, or a user in another organisation — returns an empty list rather than an error.

get/api/publicholidays

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

Query parameters

countryCodestring

An optional country code to filter the public holidays to.

yearinteger

An optional year to filter the public holidays to.

userIdinteger

An optional user id to filter the public holidays to.

bankHolidaySetIdinteger

An optional bank holiday set to filter the public holidays to.

useOrgLeaveYearboolean

An optional param to specify if we want public holidays for the user's leave year.

Response

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

idinteger

The unique Id for this public holiday

namestring nullable

The name of the holiday

datestring date-time

The public holiday date

formattedDatestring nullable

A formatted string representation of the public holiday date

createdAtstring date-time

When the public holiday was created

updatedAtstring date-time

When the public holiday was last updated

countryCodestring nullable

The country code associated with this public holiday

bankHolidaySetIdinteger

The "set" (group of public holidays) that this public holiday belongs to

bankHolidaySetNamestring nullable

The name of the country and region for this bank holiday set. If a custom set, the name of the set.

Changes

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