Skip to navigation

Get Holiday Groups

Retrieve a paginated list of holiday groups for the tenant.

Authentication

AuthorizationBearer

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

Headers

vnd.a1.tenant-idstringOptional

Tenant identifier for multi-tenant environments

Query parameters

pageintegerOptional
Page number to retrieve. Starts from 1.
limitintegerOptional
Maximum number of records to return per page.
sortColumnstringOptional
Field to sort results by.
sortOrderenumOptional
Sort direction.
Allowed values:
searchColumnstringOptional
Column to search on.
searchValuestringOptional

Value to search for in searchColumn.

enabledbooleanOptional
Filter by enabled status.
includestringOptional

Comma-separated list of field paths to include in each row (e.g. uuid,holidayGroupName).

Response

Successful Response
rowslist of objectsOptional
limitintegerOptional
totalCountintegerOptional
Total number of matching holiday groups.
currentPageintegerOptional
totalPagesintegerOptional