List holiday lists
GET {{baseUrl}}/api/v1/holidayList
This API lists a particular number of holiday lists, based on the limit specified
OAuth Scope
Desk.settings.READ
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
from | string | Index number, starting from which the holiday lists must be listed | |
limit | string | Number of holiday lists to list | |
status | string | Activation status of the holiday list. Values allowed are ACTIVE and INACTIVE |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"data":[{"modifiedTime":"2018-12-10T10:48:48.772Z","associatedBusinessHours":[{"businessHourStatus":"ACTIVE","businessHourId":"4000000101003","businessHourName":"UK Day Shift"},{"businessHourStatus":"ACTIVE","businessHourId":"4000000103001","businessHourName":"UK Night Shift"},{"businessHourStatus":"ACTIVE","businessHourId":"4000000101005","businessHourName":"Indian Night Shift"}],"createdBy":"4000000016079","name":"My Company Holidays","createdTime":"2018-12-10T10:48:48.772Z","modifiedBy":"4000000016079","id":"4000000191456","status":"ACTIVE"},{"modifiedTime":"2018-12-10T10:35:36.071Z","associatedBusinessHours":[],"createdBy":"4000000016079","name":"My Holidays","createdTime":"2018-12-10T10:35:36.071Z","modifiedBy":"4000000016079","id":"4000000191337","status":"INACTIVE"},{"modifiedTime":"2018-12-04T14:56:17.481Z","associatedBusinessHours":[],"createdBy":"4000000016079","name":"Overlapping Holidays","createdTime":"2018-12-03T13:27:30.454Z","modifiedBy":"4000000016079","id":"4000000117001","status":"INACTIVE"},{"modifiedTime":"2018-12-03T07:16:54.223Z","associatedBusinessHours":[{"businessHourStatus":"INACTIVE","businessHourId":"4000000101009","businessHourName":"Indian Shift"}],"createdBy":"4000000016079","name":"General HolidayList","createdTime":"2018-11-28T13:04:53.327Z","modifiedBy":"4000000016079","id":"4000000105030","status":"ACTIVE"}]}