Get one of the partner's PBXes (partner-api)

Returns one PBX of the partner the key belongs to. An id that belongs to another partner, does not exist, or is not a UUID answers 404.

Required scopes: partner-api and partner-pbxes.

HTTP: PartnerApiKey

Partner API key. A bearer token that a Reseller Admin generates in the partner portal under Settings, API keys. It belongs to the reseller partner, not to a person, and carries the scopes ticked at creation time. Send it on every request as Authorization: Bearer <partner_api_key>.

Every response is confined to the partner the key belongs to. Keep the key secret and call the API from your server only, never from a browser app.

HTTP Authorization Scheme: bearer
Bearer format: Bearer <partner_api_key>

pbx path · string · uuid *

PBX id (UUID). It must belong to your partner, otherwise the answer is `404`.

accept header · string

example: application/json

Responses

Response schema

dataobject

A PBX of the reseller partner that owns the API key. It carries `customer_id` only, never customer details, so the `partner-pbxes` scope cannot be used to read customer data. No secrets and no server or provisioning internals are exposed.

idstring · uuid

Unique identifier of the PBX.

example: 550e8400-e29b-41d4-a716-446655440002

namestring

PBX name.

example: Head Office

instance_namestring

PBX instance name.

example: acme-hq

profile_idinteger | null

Numeric profile identifier of the PBX.

example: 1042

customer_idstring | null · uuid

Identifier of the customer the PBX is linked to, or null if none.

example: 550e8400-e29b-41d4-a716-446655440001

languagestring | null

Default language of the PBX.

example: en

trial_ends_atstring | null · date-time

When the trial ends, or null when the PBX is not on a trial.

is_trialboolean

True when `trial_ends_at` is set and in the future.

example:

countsobject

Number of records on the PBX.

usersinteger

Number of users.

example: 14

extensionsinteger

Number of extensions.

example: 16

sip_devicesinteger

Number of SIP devices.

example: 12

phone_numbersinteger

Number of phone numbers.

example: 6

created_atstring · date-time

When the PBX was created.

example: 2025-03-12T11:00:00+00:00

updated_atstring · date-time

When the PBX was last updated.

example: 2026-09-20T07:30:00+00:00

Unauthenticated. The `Authorization: Bearer <token>` header was missing, malformed, or names a token that has been revoked or deleted.

Response schema

messagestring

Forbidden. Three different situations share this status, told apart by `message`: * the token is not a partner API key (a user token, a PBX API key, or any other token); * the partner is not an active reseller; * the key lacks a scope the endpoint needs. The body then also lists `required_scopes`.

Response schema

messagestring

Human-readable reason.

example: This API key is missing a required scope.

required_scopesarray<string>

Present on the missing-scope 403 only. Scopes the endpoint needs that the key lacks.

[]string

Not Found. No PBX with this id belongs to your partner. A PBX of another partner and a nonexistent id answer the same way, and so does an id that is not a UUID.

Response schema

messagestring

Human-readable reason.

example: This API key is missing a required scope.

required_scopesarray<string>

Present on the missing-scope 403 only. Scopes the endpoint needs that the key lacks.

[]string

Too Many Requests. Two budgets apply: 120 requests per minute per API key, and 600 per minute across all of a partner's keys together. Wait for the number of seconds in the `Retry-After` header before retrying.

Response schema

messagestring

get https://cockpit.voxbi.com/api/v1/api/v1/pbxes/{pbx}

Base URL

Request sample

curl -X GET 'https://cockpit.voxbi.com/api/v1/api/v1/pbxes/{pbx}' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://cockpit.voxbi.com/api/v1/api/v1/pbxes/{pbx}', {
  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/api/v1/pbxes/{pbx}',
    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/api/v1/pbxes/{pbx}', false, $context);
$data = json_decode($response, true);
print_r($data);

{ … }

"data": { … }

"id": "550e8400-e29b-41d4-a716-446655440002",

"name": "Head Office",

"instance_name": "acme-hq",

"profile_id": 1042,

"customer_id": "550e8400-e29b-41d4-a716-446655440001",

"language": "en",

"trial_ends_at": null,

"is_trial": false,

"counts": { … },

"users": 14,

"extensions": 16,

"sip_devices": 12,

"phone_numbers": 6

"created_at": "2025-03-12T11:00:00+00:00",

"updated_at": "2026-09-20T07:30:00+00:00"

}

{ … }

"message": "Unauthenticated."

}

Content-Type string

example: application/json

{ … }

"message": "This endpoint requires a partner API key."

}

Content-Type string

example: application/json

{ … }

"message": "PBX not found."

}

Content-Type string

example: application/json

{ … }

"message": "Too Many Attempts."

}

Retry-After integer

Seconds to wait before retrying.

example: 30

Content-Type string

example: application/json

No matching endpoints

Get one of the partner's PBXes (partner-api)

Responses