---
updatedAt: 2026-04-23T11:54:50.000Z
---

Fetch the complete documentation index at: https://developers.pismo.io/pismo-docs/llms.txt. Use this file to discover all available pages before exploring further.

# List holidays

List calendar holidays

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Platform setup - Holidays",
    "description": "Manage business and non-business days by organization",
    "version": "v1.0",
    "contact": {
      "name": "Pismo Support",
      "url": "https://developers.pismo.io/support/"
    },
    "license": {
      "name": "Copyright Pismo"
    }
  },
  "servers": [
    {
      "url": "https://sandbox.pismolabs.io/holidays-core",
      "description": "API sandbox server for testing"
    }
  ],
  "security": [
    {
      "S2SAuthentication": []
    }
  ],
  "tags": [
    {
      "name": "Holiday calendar data"
    }
  ],
  "components": {
    "parameters": {
      "BeginDateQuery": {
        "name": "beginDate",
        "in": "query",
        "description": "Get results on or after this date. \n\nThis field indicates what part of the year to start searching for holidays, not when the holiday was created at Pismo.\n\nFormat = yyyy-mm-dd. Must be less than or equal to `endDate`.\n",
        "schema": {
          "type": "string",
          "example": "2025-12-24"
        }
      },
      "EndDateQuery": {
        "name": "endDate",
        "in": "query",
        "description": "Get holidays on or before this date. \n\nThis field indicates what part of the year to end searching for holidays, not when the holiday was created at Pismo.\n\nFormat: yyyy-mm-dd. Must be greater than or equal to `beginDate`.\"\n",
        "schema": {
          "type": "string",
          "example": "2025-11-02"
        }
      },
      "HolidayCalendarNameQuery": {
        "name": "name",
        "in": "query",
        "description": "Holiday calendar name filter",
        "schema": {
          "type": "string",
          "maxLength": 80,
          "example": "Independance Day"
        }
      },
      "HolidayCalendarIdPath2": {
        "name": "holiday_calendar_id",
        "in": "path",
        "description": "Holiday calendar ID",
        "required": true,
        "schema": {
          "type": "string",
          "example": "8675309"
        }
      },
      "includeParentHolidaysQuery": {
        "name": "include_parent_holidays",
        "in": "query",
        "description": "Should holidays from parent calendars be returned? Default is `false`",
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "OrderByQuery": {
        "name": "orderBy",
        "in": "query",
        "description": "Sort by `ID` or `NAME`. Default = `ID`.",
        "schema": {
          "type": "string",
          "enum": [
            "ID",
            "NAME"
          ],
          "example": "ID"
        }
      },
      "OrderQuery": {
        "name": "order",
        "in": "query",
        "description": "Sort order: `ASC` (ascending) or `DESC` (descending). Default = `ASC`.\n",
        "schema": {
          "type": "string",
          "enum": [
            "ASC",
            "DESC"
          ],
          "example": "ASC"
        }
      },
      "PageNumberQuery": {
        "name": "page",
        "in": "query",
        "description": "Page number.  Default = `1`.",
        "schema": {
          "type": "integer",
          "minimum": 1,
          "format": "int32",
          "example": 5
        }
      },
      "PerPageQuery": {
        "name": "perPage",
        "in": "query",
        "description": "Items per page. Default =  `10`. Maximum = `100`.",
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 1,
          "maximum": 100,
          "example": 30
        }
      }
    },
    "schemas": {
      "CreatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Date and time the holiday was created. Format = yyyy-mm-ddTHH:mm:ss.",
        "example": "2024-04-30T17:24:03"
      },
      "CurrentPage": {
        "type": "integer",
        "description": "Current result page",
        "example": 1
      },
      "DeletedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Date and time the holiday was deleted. Format = yyyy-mm-ddTHH:mm:ss.",
        "example": "2024-04-30T17:24:03"
      },
      "handler.HTTPError": {
        "description": "Error",
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "HolidayCalendar": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/components/schemas/HolidayCalendarID"
          },
          "name": {
            "$ref": "#/components/schemas/HolidayCalendarName"
          }
        }
      },
      "HolidayCalendarID": {
        "type": "integer",
        "description": "Holiday calendar ID",
        "example": 8675309
      },
      "HolidayCalendarName": {
        "type": "string",
        "description": "Holiday calendar name. Must be unique per organization.",
        "maxLength": 80,
        "minLength": 1,
        "example": "Brazil holiday calendar"
      },
      "HolidayDate": {
        "type": "string",
        "description": "Holiday date. Format = yyyy-mm-dd.",
        "example": "2023-12-01"
      },
      "HolidayDescription": {
        "type": "string",
        "description": "Holiday description",
        "maxLength": 500,
        "example": "Day to party like it's 1999"
      },
      "HolidayID": {
        "type": "integer",
        "description": "Holiday ID",
        "example": 8675309
      },
      "HolidayName": {
        "type": "string",
        "description": "Holiday name",
        "example": "New Year's Day",
        "maxLength": 80,
        "minLength": 1
      },
      "Metadata": {
        "type": "object",
        "description": "A valid JSON schema as specified in https://json-schema.org/specification.html. Used to register rules used to authorize the transaction.\n\n**Note**: This field must not be used to send Personally Identifiable Information (PII), Payment Card Industry (PCI) data, or any sensitive/regulated information. Metadata fields are intended for operational, non-sensitive data only. For sensitive data, use the specific parameters designed for that purpose. For more information, refer to [Get started with Pismo APIs](https://developers.pismo.io/pismo-docs/reference/get-started-with-pismo-apis#metadata).\n"
      },
      "Pages": {
        "type": "integer",
        "description": "Total number of result pages.",
        "example": 1
      },
      "PerPage": {
        "type": "integer",
        "description": "Maximum results per page",
        "example": 10
      },
      "presenter.GetHolidayResponse": {
        "type": "object",
        "properties": {
          "created_at": {
            "$ref": "#/components/schemas/CreatedAt"
          },
          "deleted_at": {
            "$ref": "#/components/schemas/DeletedAt"
          },
          "description": {
            "$ref": "#/components/schemas/HolidayDescription"
          },
          "holiday_calendar": {
            "$ref": "#/components/schemas/HolidayCalendar"
          },
          "holiday_date": {
            "$ref": "#/components/schemas/HolidayDate"
          },
          "holiday_id": {
            "$ref": "#/components/schemas/HolidayID"
          },
          "metadata": {
            "$ref": "#/components/schemas/Metadata"
          },
          "name": {
            "$ref": "#/components/schemas/HolidayName"
          },
          "updated_at": {
            "$ref": "#/components/schemas/UpdatedAt"
          }
        }
      },
      "presenter.ListHolidayResponse": {
        "type": "object",
        "properties": {
          "current_page": {
            "$ref": "#/components/schemas/CurrentPage"
          },
          "pages": {
            "$ref": "#/components/schemas/Pages"
          },
          "per_page": {
            "$ref": "#/components/schemas/PerPage"
          },
          "total_items": {
            "$ref": "#/components/schemas/TotalItems"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/presenter.GetHolidayResponse"
            }
          }
        }
      },
      "TotalItems": {
        "type": "integer",
        "description": "Total number of result items",
        "example": 11
      },
      "UpdatedAt": {
        "type": "string",
        "format": "datetime",
        "description": "Date and time the holiday was updated. Format = yyyy-mm-ddTHH:mm:ss.",
        "example": "2024-04-30T17:24:03"
      }
    },
    "responses": {
      "400BadRequest": {
        "description": "Bad request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/handler.HTTPError"
            },
            "examples": {
              "missing-x-tenant-header": {
                "$ref": "#/components/examples/BadRequestResponseMissingHeader"
              },
              "invalid-id-params": {
                "$ref": "#/components/examples/BadRequestResponseInvalidParams"
              }
            }
          }
        }
      },
      "500InternalServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/handler.HTTPError"
            },
            "examples": {
              "generic-internal-error": {
                "$ref": "#/components/examples/InternalServerErrorResponse"
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "S2SAuthentication": {
        "type": "http",
        "scheme": "bearer",
        "description": "All requests must pass an [account-specific token](https://developers.pismo.io/pismo-docs/docs/account-specific-access-tokens).\n"
      }
    },
    "examples": {
      "InternalServerErrorResponse": {
        "value": {
          "code": "EHLD0001",
          "message": "Something went wrong - please try again"
        }
      },
      "BadRequestResponseMissingHeader": {
        "value": {
          "code": "EHLD0016",
          "message": "Missing x-tenant header"
        }
      },
      "BadRequestResponseInvalidParams": {
        "value": {
          "code": "400",
          "message": "Invalid parameter value: {parameter name}"
        }
      }
    }
  },
  "paths": {
    "/v1/holiday-calendar/{holiday_calendar_id}/holiday": {
      "get": {
        "summary": "List holidays",
        "description": "List calendar holidays",
        "operationId": "get-holiday-new",
        "tags": [
          "Holiday calendar data"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/HolidayCalendarIdPath2"
          },
          {
            "$ref": "#/components/parameters/HolidayCalendarNameQuery"
          },
          {
            "$ref": "#/components/parameters/BeginDateQuery"
          },
          {
            "$ref": "#/components/parameters/EndDateQuery"
          },
          {
            "$ref": "#/components/parameters/PageNumberQuery"
          },
          {
            "$ref": "#/components/parameters/PerPageQuery"
          },
          {
            "$ref": "#/components/parameters/OrderQuery"
          },
          {
            "$ref": "#/components/parameters/OrderByQuery"
          },
          {
            "$ref": "#/components/parameters/includeParentHolidaysQuery"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/presenter.ListHolidayResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequest"
          },
          "500": {
            "$ref": "#/components/responses/500InternalServerError"
          }
        }
      }
    }
  }
}
```