List Time-Off Periods
Retrieve all time-off periods configured for users in your workspace, used to block availability during vacations or absences.
curl --request GET \
--url https://api.zeeg.me/v2/time-off \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.zeeg.me/v2/time-off"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zeeg.me/v2/time-off', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeeg.me/v2/time-off",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeeg.me/v2/time-off"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeeg.me/v2/time-off")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeeg.me/v2/time-off")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
}{
"message": "Unauthenticated."
}{
"message": "The email field is required.",
"errors": {
"email": [
"The email field is required."
]
}
}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>'import requests
url = "https://api.zeeg.me/v2/time-off"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.zeeg.me/v2/time-off', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeeg.me/v2/time-off",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.zeeg.me/v2/time-off"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.zeeg.me/v2/time-off")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zeeg.me/v2/time-off")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
}{
"message": "Unauthenticated."
}{
"message": "The email field is required.",
"errors": {
"email": [
"The email field is required."
]
}
}