API Docs
Voxbi Cockpit APIs
All endpoints

Get the weekly calendar for a schedule (user)

Returns a weekly calendar view for the schedule, expanding its recurring slots and booked entries across a single week. The week begins on the Monday of the week containing week_start; when omitted it defaults to the current week. The schedule must belong to a department the authenticated user is allowed to manage.

HTTP: bearerAuth

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>
pbx_id path · string · uuid *
UUID of the PBX tenant.
schedule path · string · uuid *
UUID of the schedule.
week_start query · string · date
ISO date used to select the week to render.
employee_id query · string · uuid
Optional employee UUID to restrict the calendar to a single employee.
accept header · string
example: application/json

Responses

Weekly calendar for the schedule.
Response schema
dataobject
Weekly calendar view of a Tempus schedule, returned by the `GET /{pbx_id}/schedules/{schedule}/calendar` endpoint. The payload expands the schedule's recurring slots and their booked entries across a single week, producing a ready-to-render grid for the planning UI. This object documents the exact keys returned by the calendar builder, not the raw database columns. The week always begins on a Monday: when no `week_start` query parameter is supplied it defaults to the Monday of the current week. The `days` array contains one entry per active weekday of the schedule (driven by the schedule's `days_of_week`), and each day carries the slots that recur on that date together with any entry booked into them. Note that the keys here use camelCase (for example `weekStart`, `dayLabel`, `columnIndex`), unlike the snake_case keys of the schedule object nested under `schedule`. All times are local wall-clock values formatted as `HH:MM` with no timezone component, interpreted in the application timezone.
schedule*object
The schedule this calendar belongs to, serialized as a `ScheduleResource` with its `department`, `status`, and `subStatus` relations eager-loaded. See the TempusScheduleManagement schema for full field documentation.
Free-form object
weekStart*string · date
First day of the rendered week (always a Monday), as an ISO `YYYY-MM-DD` date. Matches the supplied `week_start` parameter when provided, otherwise the Monday of the current week.
example: 2024-03-04
weekEnd*string · date
Last day of the rendered week as an ISO `YYYY-MM-DD` date. Derived from the highest active weekday in the schedule's `days_of_week`, so it is not necessarily the following Sunday.
example: 2024-03-08
days*array<object>
One element per active weekday of the schedule within this week, ordered by weekday. Days on which the schedule is not active are omitted entirely.
date*string · date
Calendar date of this day as an ISO `YYYY-MM-DD` value.
example: 2024-03-04
dayLabel*string
Human-readable label for the day, formatted as a localized short weekday name followed by the date (`ddd DD.MM.YYYY`).
example: Mon 04.03.2024
isToday*boolean
Whether this day is the current date in the application timezone.
example:
slots*array<object>
Slot occurrences that recur on this day, sorted by column index then start time. A slot with no bookings appears once with a null `entry`; a slot with multiple bookings appears once per booked entry.
slotId*string · uuid
Identifier of the schedule slot this cell represents.
example: 550e8400-e29b-41d4-a716-446655440000
renderKey*string
Stable key for client-side rendering and reconciliation. For an unbooked slot it is `{slotId}:empty:{date}`; for a booked slot it is `{slotId}:{entryId}`.
example: 550e8400-e29b-41d4-a716-446655440000:550e8400-e29b-41d4-a716-446655440010
columnIndex*integer · int32
Zero-based column the slot occupies in the grid, used to lay out overlapping slots side by side.
example: 0
startTime*string
Slot start time as `HH:MM`. For an exception entry (a moved booking) this reflects the entry's actual start time rather than the slot's nominal start.
example: 09:00
endTime*string
Slot end time as `HH:MM`. For an exception entry this reflects the entry's actual end time rather than the slot's nominal end.
example: 17:00
recurrenceType*string
Recurrence rule governing on which dates the slot appears.
enum: none daily weekly custom
example: weekly
recurrenceDays*array<integer>
Weekday numbers the slot recurs on for `weekly` and `custom` recurrence. Null for `none` and `daily` recurrence.
[]integer · int32
ISO weekday number (1 = Monday through 7 = Sunday).
example: 1
recurrenceStartDate*string | null · date
First date from which the slot's recurrence applies, as an ISO `YYYY-MM-DD` value, or null when unbounded.
example: 2024-01-01
recurrenceEndDate*string | null · date
Last date on which the slot's recurrence applies, as an ISO `YYYY-MM-DD` value, or null when the recurrence has no end date.
example: 2024-12-31
entry*object | null
The booking occupying this slot on this date, or null when the slot is unbooked for the day.
entryId*string · uuid
Identifier of the schedule entry (booking).
example: 550e8400-e29b-41d4-a716-446655440010
employeeId*string · uuid
Identifier of the Tempus employee assigned to the slot.
example: 550e8400-e29b-41d4-a716-446655440020
userName*string | null
Full name of the assigned employee for display, or null when the employee record cannot be resolved.
example: Jane Smith
color*string
Hex color assigned to this employee within the schedule, used to tint their entries on the grid. Assigned automatically on first use if not already set.
example: #4F46E5
comment*string | null
Optional free-form note attached to the booking.
example: Covering the morning desk
isException*boolean
Whether this entry deviates from the slot's recurring times (for example after being moved). When true the cell's `startTime` and `endTime` reflect the entry's own times.
example:
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
The authenticated user is outside the requested tenant, has no associated employee record, or has an empty schedules-management scope.
Response schema
No response body.
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
Unprocessable Parameters. This error is returned when a parameter is not valid.
Response schema
messagestring
example: The given data was invalid.
errorsobject
filterarray<string>
[]string
sortarray<string>
[]string
pagearray<string>
[]string
per_pagearray<string>
[]string
get https://cockpit.voxbi.com/api/v1/{pbx_id}/schedule-management/{schedule}/calendar
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/{pbx_id}/schedule-management/{schedule}/calendar' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/{pbx_id}/schedule-management/{schedule}/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}/schedule-management/{schedule}/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}/schedule-management/{schedule}/calendar', false, $context);
$data = json_decode($response, true);
print_r($data);
No example for this status.
{ … }
"error": "Authorization Token is missing"
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
No example for this status.
{ … }
"message": [ … ]
"Data not found"
]
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57
{ … }
"errors": { … }
"filter": [ … ],
"The filter field must be an array."
],
"sort": [ … ],
"The sort field must be a string."
],
"page": [ … ],
"The page field must be an integer."
],
"per_page": [ … ]
"The per page field must be an integer."
]
}
}
Cache-Control string
example: private, must-revalidate
Connection string
example: keep-alive
Content-Type string
example: application/json
Vary string
example: Origin
X-RateLimit-Limit integer
Max requests allowed in the current rate-limit window.
example: 60
X-RateLimit-Remaining integer
Requests remaining in the current rate-limit window.
example: 57