PIpismo
Holiday calendar data

List holidays

List calendar holidays

get/v1/holiday-calendar/{holiday_calendar_id}/holiday

Request

  • Base URL
    https://sandbox.pismolabs.io/holidays-core
  • URL
    https://sandbox.pismolabs.io/holidays-core/v1/holiday-calendar/{holiday_calendar_id}/holiday
  • Auth
    HTTP bearer

Path parameters

holiday_calendar_idstring required
Example:8675309

Holiday calendar ID

Query parameters

namestring
Example:Independance Day

Holiday calendar name filter

beginDatestring
Example:2025-12-24

Get results on or after this date.

This field indicates what part of the year to start searching for holidays, not when the holiday was created at Pismo.

Format = yyyy-mm-dd. Must be less than or equal to endDate.

endDatestring
Example:2025-11-02

Get holidays on or before this date.

This field indicates what part of the year to end searching for holidays, not when the holiday was created at Pismo.

Format: yyyy-mm-dd. Must be greater than or equal to beginDate."

pageinteger
Example:5

Page number. Default = 1.

perPageinteger
Example:30

Items per page. Default = 10. Maximum = 100.

order'ASC' | 'DESC'
Example:ASC

Sort order: ASC (ascending) or DESC (descending). Default = ASC.

orderBy'ID' | 'NAME'
Example:ID

Sort by ID or NAME. Default = ID.

include_parent_holidaysboolean

Should holidays from parent calendars be returned? Default is false

Response

OK

current_pageinteger

Current result page

pagesinteger

Total number of result pages.

per_pageinteger

Maximum results per page

total_itemsinteger

Total number of result items

Example response

{
  "current_page": 1,
  "pages": 1,
  "per_page": 10,
  "total_items": 11,
  "items": [
    {
      "created_at": "2024-04-30T17:24:03",
      "deleted_at": "2024-04-30T17:24:03",
      "description": "Day to party like it's 1999",
      "holiday_calendar": {
        "id": 8675309,
        "name": "Brazil holiday calendar"
      },
      "holiday_date": "2023-12-01",
      "holiday_id": 8675309,
      "name": "New Year's Day",
      "updated_at": "2024-04-30T17:24:03"
    }
  ]
}

Changes

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