v1
latestOpenAPI 3.0.02026-08-06151101754.7 KBReturns absences
Query parameters
Filters by IDs. Multiple inputs with id[]=1&id[]=2
Number of items per Page
Result Page
Order column
Order direction. asc or desc possible
Returns a single aggregate over the filtered list instead of the paginated result, e.g. {"data": {"count": 42}}. Allowed values: count, sum.column, min.column, max.column, avg.column (e.g. return=sum.duration_seconds). sum and avg require a numeric column.
Returns one aggregate row per bucket of the given column instead of the paginated result, e.g. group_by=type_id gives {"data": [{"type_id": 1, "count": 5}, ...]}. The per-bucket aggregate reuses the "return=" grammar and defaults to count (e.g. group_by=type_id&return=sum.id). Combine with order_by=<aggregate>&order_direction=desc for "top N" queries. Groupable columns are known model columns plus foreign keys. Datetime columns must be bucketed by granularity: group_by=created_at:month (also :year, :day/:date), giving {"data": [{"created_at": "2026-07", "count": 5}, ...]}. Results are capped at 1000 buckets.
You can load relations using the with parameter. Example for assignments/appointments: with[]=documents loads all related documents and adds it to the response.
Exclude ids. Multiple inputs with exclude[]=3&exclude[]=6
Search string
Filter by start date
Filter by end date
Filter by started date
Filter by ended date
Assigned employees ids. Multiple inputs with employees[]=3&employees[]=6
Filter by type_id. Multiple inputs with type_id[]=1&type_id[]=2
Filter by template_id. Multiple inputs with template_id[]=1&template_id[]=2
Filter by recurring_rule_id. Multiple inputs with recurring_rule_id[]=1&recurring_rule_id[]=2
Filter by all_day.
Filter by timezone. Multiple inputs with timezone=Europe/Berlin&timezone=UTC
Filter by hints. Multiple inputs with hints[]=some&hints[]=other
Filter by source. Multiple inputs with source[]=api&source[]=app
Filter by source_external_id. Multiple inputs with source_external_id[]=123&source_external_id[]=456
Response
Absences list
Example response
{
"data": [
{
"first_line": "Holiday",
"icon": "fa-sun",
"color": "#f3a622",
"contrast_color": "dark",
"type_id": 1,
"template_id": 1,
"recurring_rule_id": 1
}
]
}