API Docs
Voxbi Cockpit APIs
All endpoints

List user groups

Returns a paginated list of user groups. Use the standard search, sort, page, and perPage query parameters; use filter[key]=value to narrow the result set. Multi-tenant scoping is enforced.

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
dataarray<object>
idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440020
namestring
example: Sales Team
user_idstring · uuid
Owner user (a user-group belongs to one user)
example: 550e8400-e29b-41d4-a716-446655440001
positioninteger
example: 1
usersarray<string>
Member user identifiers (when included)
[]string · uuid
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/user-groups
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/user-groups' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/user-groups', {
  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/user-groups',
    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/user-groups', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"data": [ … ]
{ … },
"id": "550e8400-e29b-41d4-a716-446655440020",
"name": "Sales Team",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"position": 1
},
{ … }
"id": "550e8400-e29b-41d4-a716-446655440021",
"name": "Support Team",
"user_id": "550e8400-e29b-41d4-a716-446655440001",
"position": 2
}
]
}
Host string
example: cockpit.voxbi.com
Date string
example: Mon, 16 Oct 2023 14:08:48 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
Vary string
example: Origin
{ … }
"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"
}