All pages
Powered by GitBook
1 of 1

Loading...

Search existing holidays

Use case

In this case, we will search for existing holidays.

Use case data
API parameters with values

Requesting to display the search results on the first page; the page size is 1.

...api/v1/holiday/holidays?pageSize=1&pageNumber=1

Sample API call

To find existing holidays, use the following endpoint:

https://holiday-api.sandbox.tuumplatform.com/api/v1/holiday/holidays

Learn more about the find holidays endpoint in the Tuum developer portal.

Sample request

The sample request body is as follows:

No body

curl --location 'https://holiday-api.sandbox.tuumplatform.com/api/v1/holiday/holidays?pageSize=1&pageNumber=1' \
--header 'x-channel-code: SYSTEM' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiT2ZmaWNlciBUZXN0IiwiZW1wbG95ZWVJZCI6IklELTEwMDAiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHBpcnlEVGltZSI6IjIwMjQtMTItMTlUMTY6NDY6MjUiLCJleHAiOjE3MzQ2MjY3ODUsInJvbGVzIjpbIkFETUlOIl19.Obqfvpc6ulDVPRTF1j6HmR_5M5Zwo5rLbjE2v3f5UwY' \
--data ''

Sample response

Below you will find the response to the sample request:

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "values": [
            {
                "holidayId": "ID-1000",
                "holidayTypeCode": "WEEKEND",
                "countryCode": null,
                "date": "2024-06-15",
                "statusCode": "ACCEPTED",
                "holidayDeclineReason": null,
                "dependentUpdatesRequired": false
            }
        ],
        "pageNumber": 1,
        "pageSize": 1,
        "endReached": false,
        "sort": null
    }
}

Result

The search returned information about the existing holidays.