Holidays v2 - Transaction banking (deprecated)

List holidays (deprecated)

DEPRECATED. Call the new List holidays endpoint instead.

Return a paginated list of holidays registered for an organization.

Note: This endpoint is designed for transaction banking. For more information, refer to Calendars and holidays in transaction banking.

get/holidays-core/v2/holiday

Request

  • Base URL
    https://sandbox.pismolabs.io/holidays-core
  • URL
    https://sandbox.pismolabs.io/holidays-core/holidays-core/v2/holiday
  • Auth
    HTTP bearer

Query parameters

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.

administrativeDivisionIdinteger required

Administrative Division ID filter

namestring
Example:New Year's Day

Holiday name filter

holidayDatestring
Example:2023-01-01

Holiday date filter. Format = yyyy-mm-dd.

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."

deletedboolean

Deleted holidays filter. This field is for internal use only, deleted holidays are not returned,

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,
  "items": [
    {
      "administrative_division": {
        "id": 1111,
        "name": "Brazil"
      },
      "id": 8675309,
      "name": "New Year's Day",
      "description": "Day to party like it's 1999",
      "holiday_date": "2023-12-01",
      "working_date": "2023-01-02",
      "created_at": "2024-04-30T17:24:03"
    }
  ],
  "pages": 1,
  "per_page": 10,
  "total_items": 11
}

Changes

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