API Docs
Voxbi Cockpit APIs
All endpoints

List Caller Identities for the authenticated user

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

No authentication required
accept header · string
example: application/json

Responses

Response schema
dataarray<object>
Each item — An outbound caller identity: the phone number (plus optional suffix and label) shown to the called party when this entity places a call. Each identity is attached to exactly one target (`User`, `Pbx`, `Group`, or `SipDevice`). This table has no `timestamps`.
id*string · uuid
Caller identity identifier
read-only
example: 550e8400-e29b-41d4-a716-446655440000
pbx_id*string · uuid
Pbx identifier (tenant)
example: 550e8400-e29b-41d4-a716-446655440001
phone_number_id*string · uuid
Identifier of the PhoneNumber used as the outbound CID
example: 550e8400-e29b-41d4-a716-446655440002
suffixstring | null
Optional digit suffix appended to the base phone number
example: 23
labelstring | null
Human-readable label shown in the admin UI
example: Sales line
caller_identity_target_type*string
Polymorphic morph class for the entity this identity is attached to. Stored as a fully qualified PHP class name.
enum: App\Models\User App\Models\Pbx App\Models\Group App\Models\SipDevice
example: App\Models\User
caller_identity_target_id*string · uuid
Identifier of the target entity
example: 550e8400-e29b-41d4-a716-446655440003
orderinteger
Display order within the target's caller identity list
example: 1
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/caller-identities
Base URL
Request sample 
curl -X GET 'https://cockpit.voxbi.com/api/v1/caller-identities'
const response = await fetch('https://cockpit.voxbi.com/api/v1/caller-identities', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

response = requests.get('https://cockpit.voxbi.com/api/v1/caller-identities')
response.raise_for_status()
data = response.json()
print(data)
<?php
$context = stream_context_create([
    'http' => [
        'method'  => 'GET',
        'header'  => "Content-Type: application/json",
    ],
]);

$response = file_get_contents('https://cockpit.voxbi.com/api/v1/caller-identities', false, $context);
$data = json_decode($response, true);
print_r($data);
{ … }
"data": [ … ]
{ … }
"id": "550e8400-e29b-41d4-a716-446655440000",
"pbx_id": "550e8400-e29b-41d4-a716-446655440001",
"phone_number_id": "550e8400-e29b-41d4-a716-446655440002",
"suffix": "23",
"label": "Sales line",
"caller_identity_target_type": "App\Models\User",
"caller_identity_target_id": "550e8400-e29b-41d4-a716-446655440003",
"order": 1
}
]
}
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"
}