public-holidays

Find public holidays

Returns the company public holidays within the provided date range.

Date range

A date range is required: provide both date[$gte] and date[$lte] (format YYYY-MM-DD). The maximum range is one year.

Behavior

  • Holidays whose policy has no active users are omitted.
  • userIds only contains active (non-archived) users.
  • A holiday that belongs to multiple policies is returned as a separate record per policy, each carrying its own userIds (the active users of that policy). The same holiday can therefore appear more than once in the response, once for each policy it belongs to.
  • Holiday names are localized to the language of the user the OAuth integration or API key is linked to.
  • Provide an optional userId to only return the holidays applying to that user.
get/public-holidays

Request

  • Base URL: https://api.hoorayhr.io
  • URL: https://api.hoorayhr.io/public-holidays
  • Auth: API key in header authorization

Query parameters

date[$gte]string date required
Example:2025-01-01

Start of the date range (inclusive). Format: YYYY-MM-DD

date[$lte]string date required
Example:2025-12-31

End of the date range (inclusive). Format: YYYY-MM-DD. Cannot be more than one year after date[$gte]

userIdnumber
Example:1

Optional. Only return the holidays applying to this user.

Response

success

idnumber

The holiday unique ID

namestring

The name of the holiday

datestring date

The date of the holiday. Format: YYYY-MM-DD

subtractFromBudgetboolean

Whether the holiday is subtracted from the leave budget

userIdsnumber[]

Ids of the active users the holiday applies to

Example response

[
  {
    "id": 1,
    "name": "New Year",
    "date": "2025-01-01",
    "userIds": [
      1,
      2,
      3
    ]
  }
]

Changes

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