List all validators in the tenant
Every validator in the tenant (an employee named on any validator rule), with the per-module permissions they hold and the lightweight list of employees they validate (the union across their rules' company / department / employees scope). Readable by any authenticated user in the tenant.
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
*
Responses
The validators in the tenant.
Response schema
data*array<object>
validator*object
employee_idstring · uuid
user_idstring | null · uuid
namestring
permissions*object
Which validator modules the caller may act on for this employee.
holiday_requestsboolean
home_office_requestsboolean
time_point_corrections_requestsboolean
schedules_managementboolean
employees*array<object>
Lightweight list of the employees this validator may consult.
employee_idstring · uuid
namestring
Unauthenticated.
Response schema
No response body.
The caller does not belong to this tenant.
Response schema
No response body.
get
https://cockpit.voxbi.com/api/v1/{pbx_id}/validators
Base URL
Request sample
curl -X GET 'https://cockpit.voxbi.com/api/v1/{pbx_id}/validators' \
-H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/{pbx_id}/validators', {
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}/validators',
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}/validators', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"data": [ … ]
{ … }
"validator": { … },
"employee_id": "550e8400-e29b-41d4-a716-446655440000",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Jane Smith"
},
"permissions": { … },
"holiday_requests": true,
"home_office_requests": true,
"time_point_corrections_requests": false,
"schedules_management": false
},
"employees": [ … ]
{ … },
"employee_id": "550e8400-e29b-41d4-a716-446655440010",
"name": "John Doe"
},
{ … }
"employee_id": "550e8400-e29b-41d4-a716-446655440011",
"name": "Mary Jones"
}
]
}
]
}
No example for this status.
No example for this status.