API Docs
Voxbi Cockpit APIs
All endpoints

Get the authenticated user (user)

Returns the currently authenticated user's profile data including extensions, SIP devices, groups, twinnings, and integrations. Requires a user-owned bearer token.

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>
accept header · string
example: application/json

Responses

Response schema
messagestring
dataobject
idstring · uuid
pbx_idstring
full_name_with_emailstring
first_namestring
last_namestring
emailstring · email
languagestring
access_tokenstring | null
email_verified_atstring | null · date-time
statusstring
allow_telephonyboolean
allow_dndboolean
allow_change_twinning_destboolean
allow_call_forwardingboolean
allow_manage_global_contactsboolean
call_recordings_visibilitystring | null
extension_roamingboolean
call_information_visibilitystring | null
allow_status_changerboolean
allow_manage_voicemail_parametersboolean
show_in_address_bookboolean
voicemail_typestring | null
voicemail_destinationstring | null
concurrent_callsinteger | null
vipboolean
sync_sourcestring | null
allow_anonymous_callsboolean
identity_provider_uidstring | null
is_shadowboolean
created_atstring · date-time
updated_atstring · date-time
webrtc_configurationobject | null
extensionsarray<object>
[]object
Free-form object
sipDevicesarray<object>
[]object
Free-form object
groupsarray<object>
[]object
Free-form object
twinningsarray<object>
[]object
Free-form object
caller_identitiesarray<object>
[]object
Free-form object
integrationsarray<object>
[]object
Free-form object
pbxobject
Free-form object
microsoftobject
fetch_contactsboolean
odooobject
fetch_contactsboolean
employee_idstring | null · uuid
tempusstring | null
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Server error. An unexpected condition was encountered on the server and the request could not be completed. The body is a generic JSON envelope with a `message` field. The response is logged on the server side; quote the request URL + timestamp when reporting an issue.
Response schema
messagestring
exceptionstring
Only present in non-production environments.
filestring
Only present in non-production environments.
lineinteger
Only present in non-production environments.
get https://cockpit.voxbi.com/api/v1/me
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/me' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/me', {
  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/me',
    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/me', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"message": "Success",
"data": { … }
"id": "550e8400-e29b-41d4-a716-446655440000",
"pbx_id": "pbx-123",
"full_name_with_email": "John Doe (john.doe@example.com)",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"language": "en",
"access_token": null,
"email_verified_at": "2023-01-01T00:00:00.000000Z",
"status": "active",
"allow_telephony": true,
"allow_dnd": true,
"allow_change_twinning_dest": false,
"allow_call_forwarding": true,
"allow_manage_global_contacts": false,
"call_recordings_visibility": null,
"extension_roaming": false,
"call_information_visibility": null,
"allow_status_changer": true,
"allow_manage_voicemail_parameters": false,
"show_in_address_book": true,
"voicemail_type": null,
"voicemail_destination": null,
"concurrent_calls": null,
"vip": false,
"sync_source": null,
"allow_anonymous_calls": false,
"identity_provider_uid": null,
"is_shadow": false,
"created_at": "2023-01-01T00:00:00.000000Z",
"updated_at": "2023-10-12T12:25:52.000000Z",
"webrtc_configuration": null,
"extensions": [],
"sipDevices": [],
"groups": [],
"twinnings": [],
"caller_identities": [],
"integrations": [],
"pbx": [],
"microsoft": { … },
"fetch_contacts": false
},
"odoo": { … },
"fetch_contacts": false
},
"employee_id": null,
"tempus": null
}
}
Host string
example: 0.0.0.0:8083
Date string
example: Thu, 12 Oct 2023 12:25:52 GMT
Connection string
example: close
Cache-Control string
example: no-cache, private
Content-Type string
example: application/json
X-RateLimit-Limit integer
example: 60
X-RateLimit-Remaining integer
example: 59
Access-Control-Allow-Origin string
example: *
{ … }
"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
{ … }
"message": "Server Error"
}