API Docs
Voxbi Cockpit APIs
All endpoints

List phone numbers on the PBX

List the PhoneNumbers attached to the caller's PBX (resolved from the bearer token). Each entry includes the currently-attached call flow (id + summary) when one is configured.

The list is paginated (data + meta + links) and supports filtering and sorting.

HTTP: IntegrationApiKey

API key created on the Cockpit Integrations page (an "API key" integration). It is a bearer token owned by the customer's PBX and limited to the scopes selected when the key was created (e.g. phone-numbers, push-configuration).

Send it in the Authorization header:

Authorization: Bearer <api_key>

Manage keys (create / reveal / revoke) from Integrations → New integration → API key.

HTTP Authorization Scheme
bearer
filter[number] query · string
Filter by phone number (substring match). A leading `+` is ignored, so `filter[number]=+4922` and `filter[number]=4922` both match.
filter[name] query · string
Filter by the number's name (substring match).
sort query · string
Sort field; prefix with `-` for descending. Allowed: `number`, `name`, `created_at`. Defaults to `number` ascending.
enum: number -number name -name created_at -created_at
page query · integer
Page number (1-based).
per_page query · integer
Items per page. Defaults to and is capped at 100 (the API page-length limit); larger values are clamped to 100.

Responses

Response schema
dataarray<object>
idstring · uuid
example: 550e8400-e29b-41d4-a716-446655440000
numberstring
Phone number in E.164 format.
example: +12125550100
namestring | null
example: Customer Support
is_activeboolean
example: 1
call_flow_idstring | null · uuid
example: 550e8400-e29b-41d4-a716-446655440100
call_flowobject | null
idstring · uuid
namestring
enabledboolean
linksobject
First/last/prev/next page URLs.
Free-form object
metaobject
Pagination metadata (current_page, per_page, total, last_page, ...).
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
get https://cockpit.voxbi.com/api/v1/numbers
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/numbers' \
  -H 'Authorization: Bearer YOUR_TOKEN'
const response = await fetch('https://cockpit.voxbi.com/api/v1/numbers', {
  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/numbers',
    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/numbers', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"data": [ … ],
{ … }
"id": "550e8400-e29b-41d4-a716-446655440000",
"number": "+12125550100",
"name": "Customer Support",
"is_active": true,
"call_flow_id": "550e8400-e29b-41d4-a716-446655440100",
"call_flow": { … }
"id": "550e8400-e29b-41d4-a716-446655440100",
"name": "Business hours",
"enabled": true
}
}
],
"links": { … },
"first": "https://cockpit.voxbi.com/api/v1/numbers?page=1",
"last": "https://cockpit.voxbi.com/api/v1/numbers?page=3",
"prev": null,
"next": "https://cockpit.voxbi.com/api/v1/numbers?page=2"
},
"meta": { … }
"current_page": 1,
"per_page": 50,
"total": 124,
"last_page": 3
}
}
{ … }
"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