Holiday calendar data

Get non-business days

Get non-business days (weekends and holidays) for a specific holiday calendar within a date range. Non-business days include weekends based on the holiday calendar's working days configuration and holidays associated with the group.

get/v1/holiday-calendar/{holiday_calendar_id}/non-business-days

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/holiday-calendar/{holiday_calendar_id}/non-business-days
  • Auth
    none declared

Path parameters

holiday_calendar_idstring required
Example:8675309

Holiday calendar ID

Query parameters

begin_datestring required
Example:2025-01-01

Beginning date filter, format = yyyy-mm-dd

end_datestring required
Example:2025-01-30

End date filter, format = yyyy-mm-dd

Response

OK

holiday_calendar_metadatastring

Any data object with key/value pairs. No limit on length.

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.

Example response

{
  "dates": [
    {
      "date": "2023-01-20",
      "is_holiday": true,
      "is_weekend": true
    }
  ],
  "holiday_calendar_metadata": "{ \"key\": \"value\"}"
}

Changes

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