Holiday calendar data

List holiday calendars

List holiday calendars for an Organization.

get/v1/holiday-calendar

Request

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

Query parameters

holiday_calendar_idinteger

Holiday calendar ID filter

namestring

Example:Independance Day

Holiday calendar name filter

typestring

Holiday calendar type filter

external_idstring

Client-created calendar holiday ID

parent_idinteger

Example:5

Holiday calendar parent ID filter

sort_by'name' | 'type'

Example:name

Sort field - name or type. Default is name.

sort_order'asc' | 'desc'

Sort order - asc or desc. Default is asc

relation'parents' | 'children'

Calendar relationship type. Default is all Organization calendars. Either external_id or holiday_calendar_id is REQUIRED if this field is passed.

pageinteger

Example:5

Page number. Default = 1.

perPageinteger

Example:30

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

Headers

x-tenantstring required

Organization/tenant ID

x-cidstring

The Correlation IDentifier UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

Response

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": [
    {
      "external_id": "f89urqljnahosluiefku",
      "holiday_calendar_id": 8675309,
      "name": "Brazil holiday calendar",
      "parent_id": 8675309,
      "type": "Country",
      "working_days": [
        1,
        2,
        3,
        4,
        5
      ]
    }
  ]
}

Changes

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