API Docs
Voxbi Cockpit APIs
All endpoints

Employees the logged-in validator can validate

Returns the employees the logged-in user (a validator) is allowed to validate (the union across all validator modules), each with identity, the active contract, and a per-module capability map. Access is rule-based (see the "Validators & Managers" rules). Matricule is never returned.

Optional filters narrow the list by the employee's active-contract company or department, or to a single employee. The dropdown values (the companies / departments / employees in scope) come from the caller's user-profile validator block.

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 *
filter[company_id] query · string · uuid
Keep only employees whose active contract is in this company.
filter[department_id] query · string · uuid
Keep only employees whose active contract is in this department.
filter[employee_id] query · string · uuid
Keep only this employee (when in scope).

Responses

The employees in the validator's scope.
Response schema
dataarray<object>
employee_idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440010
user_idstring | null · uuid
example: 550e8400-e29b-41d4-a716-446655440011
first_namestring | null
example: John
last_namestring | null
example: Doe
emailstring | null
example: john.doe@example.com
extension_idstring | null · uuid
example: 550e8400-e29b-41d4-a716-446655440020
is_activeboolean
example: 1
contractobject | null
The employee's active contract, or null when none is active.
start_datestring | null · date
end_datestring | null · date
weekly_expected_working_time_secondsinteger
weekly_expected_working_timestring
HH:MM.
participationnumber | null
FTE fraction, e.g. 100 or 80.
job_titlestring | null
contract_typestring | null
company_idstring | null · uuid
companystring | null
department_idstring | null · uuid
departmentstring | null
compensatory_balance_secondsinteger
ho_balance_secondsinteger
modulesobject
Which validator modules the caller may act on for this employee.
holiday_requestsboolean
home_office_requestsboolean
time_point_corrections_requestsboolean
schedules_managementboolean
Unauthenticated.
Response schema
No response body.
The caller has no employee record in this tenant.
Response schema
No response body.
A filter value is not a valid UUID.
Response schema
No response body.
get https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/employees
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/employees' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/{pbx_id}/validator/employees', {
  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}/validator/employees',
    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}/validator/employees', false, $context);
$data = json_decode($response, true);
print_r($data);
No example for this status.
No example for this status.
No example for this status.
No example for this status.