List Public Holidays

get/public/v1/public-holidays

Returns the public holiday calendar Astalty uses to apply public holiday rates: the state public holidays Astalty imports, and the custom holidays your organisation added (custom is true).

A holiday applies to a support whose address is in the holiday's state. When public_holiday_groups is not empty, it applies only to participants in one of those groups. It never applies to a participant in any of its excluded_public_holiday_groups.

get/public/v1/public-holidays

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/public-holidays' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "c3d4e5f6-a7b8-49c0-9d1e-2f3a4b5c6d7e",
      "name": "Australia Day",
      "date": "2026-01-26",
      "start_time": "2026-01-25T13:00:00+00:00",
      "end_time": "2026-01-26T12:59:59+00:00",
      "timezone": "Australia/Sydney",
      "state": "NSW",
      "custom": false,
      "public_holiday_groups": [
        {
          "id": "d4e5f6a7-b8c9-40d1-8e2f-3a4b5c6d7e8f",
          "name": "Greater Geelong"
        }
      ],
      "excluded_public_holiday_groups": [
        {
          "id": "d4e5f6a7-b8c9-40d1-8e2f-3a4b5c6d7e8f",
          "name": "Greater Geelong"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

filter[date_after]string
Only return holidays falling on or after this date, inclusive. Format YYYY-MM-DD, read in the holiday's own state timezone.
Example:2026-01-01
filter[date_before]string
Only return holidays falling on or before this date, inclusive. Format YYYY-MM-DD, read in the holiday's own state timezone.
Example:2026-12-31
filter[state]string
Only return holidays in these states, comma separated. Each one of: ACT, NSW, NT, QLD, SA, TAS, VIC, WA.
Example:NSW,VIC
sortstring
Sort the results. Prefix with '-' for descending. One of: date, name. Defaults to date ascending.
Example:-date
page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of PublicHolidayResource

dataobject[]required
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:c3d4e5f6-a7b8-49c0-9d1e-2f3a4b5c6d7e
- namestringrequired
  Example:Australia Day
- datestringrequired
  Example:2026-01-26
- start_timestringrequired
  Example:2026-01-25T13:00:00+00:00
- end_timestringrequired
  Example:2026-01-26T12:59:59+00:00
- timezonestringrequired
  Example:Australia/Sydney
- statestringrequired
  Example:NSW
- custombooleanrequired
  Example:false
- public_holiday_groupsobject[]
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:d4e5f6a7-b8c9-40d1-8e2f-3a4b5c6d7e8f
  namestringrequired
  Example:Greater Geelong
- excluded_public_holiday_groupsobject[]
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:d4e5f6a7-b8c9-40d1-8e2f-3a4b5c6d7e8f
  namestringrequired
  Example:Greater Geelong
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors