---
title: "List holidays"
method: GET
path: "/holidays"
tags: ["Tenant"]
---

# List holidays

`GET /holidays`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/holidays`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/holidays/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a collection of holiday entries.

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` object[]
    - `id` string: The unique ID of the resource.
    - `name` string: The name of the holiday.
    - `region` string: A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html
    - `consecutive` boolean: Whether the holiday consists of consecutive days.
    - `every_year` boolean: Does the holiday take effect every year.
    - `year_start` integer: The start year of holiday.
    - `year_end` integer: The start year of holiday.
    - `month_start` integer: The start month of holiday.
    - `month_end` integer: The end month of holiday.
    - `day_start` integer: The start day of holiday.
    - `day_end` integer: The end day of holiday.
    - `hour_start` integer: The start hour of holiday.
    - `hour_end` integer: The end hour of holiday.
    - `minute_start` integer: The start minute of holiday.
    - `minute_end` integer: The end minute of holiday.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)