.svg?fit=max&auto=format&n=9voKLLkajreclhp4&q=85&s=321632804eda4b3cff044941f9ccadda)
API Reference
- GETGet All Availability Schedules
- GETGet Default Availability Schedule
- PATCHUpdate Default Availability Schedule
- GETGet Availability Schedule by UUID
- PATCHUpdate Availability Schedule by UUID
- GETList Time-Off Periods
- POSTCreate Time-Off Periods
- PATCHUpdate Time-Off Period
- DELDelete Time-Off Period
- GETList Holiday Categories
- GETPreview Holidays for a Category
- GETList Holiday Subscriptions
- POSTCreate Holiday Subscriptions
- DELDelete a Holiday Subscription
- PUTToggle Holiday Overrides
List Time-Off Periods
Returns a paginated list of user-level time-off periods (vacation, out-of-office) for the specified user.
By default only periods ending today or in the future are returned. Use from / to to query a specific window, or type to filter to a single category.
Half-day flags indicate the first or last day of the period is partial; startHalfDayCutoff / endHalfDayCutoff carry the cutoff time (HH:MM) when the flag is true.
curl --request GET \
--url https://api.zeeg.me/v2/time-off \
--header 'Authorization: Bearer <token>'{
"collection": [
{
"uuid": "01907f10-5b00-7b31-9cf0-1234567890ab",
"uri": "https://api.zeeg.me/v2/time-off/01907f10-5b00-7b31-9cf0-1234567890ab",
"type": "vacation",
"title": "Summer break",
"startDate": "2026-07-01",
"endDate": "2026-07-14",
"startHalfDay": true,
"endHalfDay": false,
"startHalfDayCutoff": "13:00",
"endHalfDayCutoff": null,
"note": "Out at the coast"
},
{
"uuid": "01907f10-6a20-7c41-9cf0-abcdef012345",
"uri": "https://api.zeeg.me/v2/time-off/01907f10-6a20-7c41-9cf0-abcdef012345",
"type": "out_of_office",
"title": "Team offsite",
"startDate": "2026-09-02",
"endDate": "2026-09-04",
"startHalfDay": false,
"endHalfDay": false,
"startHalfDayCutoff": null,
"endHalfDayCutoff": null,
"note": null
}
],
"pagination": {
"total": 2,
"count": 2,
"totalPages": 1,
"previousPage": null,
"currentPage": 1,
"nextPage": null
}
}Authorizations
Query Parameters
Email address of the user whose time-off periods to retrieve.
"lena.meier@horizondigital.de"
Only return periods ending on or after this date (YYYY-MM-DD). Defaults to today when omitted.
"2026-04-01"
Only return periods starting on or before this date (YYYY-MM-DD). No upper bound when omitted.
"2026-12-31"
Filter to a single type of period.
vacation, out_of_office "vacation"
Number of results per page.
1 <= x <= 10020
Page number for paginated results.
x >= 11
Response
OK
List of time-off periods.
Hide child attributes
Hide child attributes
Self-link to update or delete this time-off period.
"https://api.zeeg.me/v2/time-off/01907f10-5b00-7b31-9cf0-1234567890ab"
vacation, out_of_office Half-day cutoff (HH:MM), null when startHalfDay is false.
Half-day cutoff (HH:MM), null when endHalfDay is false.
Hide child attributes
Hide child attributes
Total number of records.
x >= 0Number of records on the current page.
x >= 0Total number of pages.
x >= 0Current page number.
x >= 1Link to previous page, or null.
"/v2/time-off?page=1"
Link to next page, or null.
"/v2/time-off?page=3"
curl --request GET \
--url https://api.zeeg.me/v2/time-off \
--header 'Authorization: Bearer <token>'{
"collection": [
{
"uuid": "01907f10-5b00-7b31-9cf0-1234567890ab",
"uri": "https://api.zeeg.me/v2/time-off/01907f10-5b00-7b31-9cf0-1234567890ab",
"type": "vacation",
"title": "Summer break",
"startDate": "2026-07-01",
"endDate": "2026-07-14",
"startHalfDay": true,
"endHalfDay": false,
"startHalfDayCutoff": "13:00",
"endHalfDayCutoff": null,
"note": "Out at the coast"
},
{
"uuid": "01907f10-6a20-7c41-9cf0-abcdef012345",
"uri": "https://api.zeeg.me/v2/time-off/01907f10-6a20-7c41-9cf0-abcdef012345",
"type": "out_of_office",
"title": "Team offsite",
"startDate": "2026-09-02",
"endDate": "2026-09-04",
"startHalfDay": false,
"endHalfDay": false,
"startHalfDayCutoff": null,
"endHalfDayCutoff": null,
"note": null
}
],
"pagination": {
"total": 2,
"count": 2,
"totalPages": 1,
"previousPage": null,
"currentPage": 1,
"nextPage": null
}
}