Skip to navigation
API ReferenceHolidays

List Holidays

Returns all Holidays defined in the current workspace, sorted by name.

This "list" API returns basic information about Holidays and may be restricted to partial information. To receive all information about a specific Holiday, use RetrieveHoliday.

A Holiday is a defined date when one or more Resources are not available for work. Holidays may be defined by Workspace, by Country, or by Resource. A Workspace Holiday means that no Resources in the Workspace are working for that date. A Country Holiday means that no Resources in the Workspace located within the country are working for that date. A Resource Holiday means that the specified Resource is not working on that date.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.
datalist of objectsOptional
If the API call succeeded, this will contain the results.