API Docs
Voxbi Cockpit APIs
All endpoints

Get User Layout

Returns the active status-changer layout for the authenticated user, including grid configuration, statuses, and substatuses.

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

Responses

Response schema
idstring · uuid
namestring
grid_sizeobject
rowsinteger
columnsinteger
statusesarray<object>
idstring · uuid
namestring
descriptionstring | null
styleobject
Free-form object
metadataobject
availabilitystring | null
allow_multiselectboolean
substatus_selection_mandatoryboolean
location_idsarray<string>
[]string
substatus_idsarray<string>
[]string
css_grid_areastring
positionobject
rowinteger
columninteger
row_spaninteger
col_spaninteger
substatusesobject
Free-form object
Authorization Token Missing. This error is returned when the authorization token is missing.
Response schema
errorstring
Error message
example: Authorization Token is missing
Data Not Found. This error is returned when the requested data is not found.
Response schema
messagearray<string>
[]string
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/v2/layout
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/v2/layout' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/v2/layout', {
  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/v2/layout',
    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/v2/layout', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"id": "550e8400-e29b-41d4-a716-446655440010",
"name": "Default Layout",
"grid_size": { … },
"rows": 3,
"columns": 4
},
"statuses": [ … ],
{ … }
"id": "550e8400-e29b-41d4-a716-446655440001",
"name": "Available",
"description": null,
"style": { … },
"background_color": "#00c853",
"font_color": "#ffffff",
"icon": "check"
},
"metadata": { … },
"availability": "available",
"allow_multiselect": false,
"substatus_selection_mandatory": false
},
"location_ids": [],
"substatus_ids": [],
"css_grid_area": "1/1/2/2",
"position": { … }
"row": 1,
"column": 1,
"row_span": 1,
"col_span": 1
}
}
],
"substatuses": []
}
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": [ … ]
"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
{ … }
"message": "Server Error"
}