Skip to main content
GET
List time-off periods

Authorizations

Authorization
string
header
required

Query Parameters

email
string<email>
required

Email address of the user whose time-off periods to retrieve.

Example:

"lena.meier@horizondigital.de"

from
string<date>

Only return periods ending on or after this date (YYYY-MM-DD). Defaults to today when omitted.

Example:

"2026-04-01"

to
string<date>

Only return periods starting on or before this date (YYYY-MM-DD). No upper bound when omitted.

Example:

"2026-12-31"

type
enum<string>

Filter to a single type of period.

Available options:
vacation,
out_of_office
Example:

"vacation"

count
integer
default:20

Number of results per page.

Required range: 1 <= x <= 100
Example:

20

page
integer
default:1

Page number for paginated results.

Required range: x >= 1
Example:

1

Response

OK

collection
object[]
required

List of time-off periods.

pagination
object
required
Last modified on April 29, 2026