Employee calendar for the logged-in user
Returns the data behind the Tempus "Employee Calendar" page for the
logged-in user, for a single year: the summary block, the per-company
rights breakdown (details), contract periods, and a fully-classified
day-by-day year_calendar. Plain data only: no colours, icons or theme;
the client owns presentation.
The employee is resolved from the Sanctum token; there is no employee
parameter and a caller can only ever read their own calendar. The only
input is the year (bounded to the employee's contract history through
next year).
Per-day type merge priority (highest first): no_contract >
special_holiday > transaction (non-home-office) > public_holiday >
weekend > work. Home office is an orthogonal flag, never the winning
type.
User bearer token. Default authentication for customer-facing endpoints.
Obtain a token by calling POST /login with your credentials, then send it
on every subsequent request as Authorization: Bearer <token>. The token
inherits the permissions and PBX scope of the authenticated user.
- HTTP Authorization Scheme
bearer- Bearer format
Bearer <token>
Responses
2026year_bounds*object
summary*object
totalsobject
cardsarray<object>
rights taken remaining_rights compensatory_balance possibledetails*object
companiesarray<object>
periodsarray<object>
rowsarray<object>
contract_periods*array<object>
28800year_calendar*object
https://cockpit.voxbi.com/api/v1/{pbx_id}/user/calendar
curl -X GET 'https://cockpit.voxbi.com/api/v1/{pbx_id}/user/calendar' \
-H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/{pbx_id}/user/calendar', {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${YOUR_TOKEN}`,
},
});
const data = await response.json();
console.log(data);
import requests
response = requests.get('https://cockpit.voxbi.com/api/v1/{pbx_id}/user/calendar',
headers={'Authorization': f'Bearer {YOUR_TOKEN}'}
)
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
'http' => [
'method' => 'GET',
'header' => "Content-Type: application/json\r\nAuthorization: Bearer YOUR_TOKEN",
],
]);
$response = file_get_contents('https://cockpit.voxbi.com/api/v1/{pbx_id}/user/calendar', false, $context);
$data = json_decode($response, true);
print_r($data);