List the partner's customers (partner-api)

Lists the customers of the partner the key belongs to. Customers of other partners are never returned.

Required scopes: partner-api and partner-customers.

Query parameters: search, per_page (1 to 5000, default 100) and page. Results are ordered by name, then id, and returned as a Laravel paginator: data, links and meta. search matches the customer name and email.

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>

search query · string

Case-insensitive text matched against the customer name and email. At most 100 characters.

per_page query · integer

Number of items per page, 1 to 5000. Defaults to `100`. A value above 5000 is rejected with `422`.

page query · integer

Page number to fetch, starting at 1. Defaults to `1`.

accept header · string

example: application/json

Responses

Response schema

dataarray<object>

Each item — A customer of the reseller partner that owns the API key. Block reason, who blocked the customer and CRM synchronization internals are not exposed.

idstring · uuid

Unique identifier of the customer.

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

namestring

Customer name.

example: Sales Team Inc

is_companyboolean

True when the customer is a company, false for a private person.

example: 1

emailstring | null · email

Customer contact email.

example: user@example.com

phone_numberstring | null

Customer contact phone number.

example: +12125550101

addressobject

Postal address of a customer.

streetstring | null

Street name.

example: Main Street

numberstring | null

Street number.

example: 12

postal_codestring | null

Postal code.

example: 10001

citystring | null

City.

example: New York

country_codestring | null

ISO 3166-1 alpha-2 country code.

example: US

external_idstring | null

Identifier of the customer in your own system, if one was recorded.

example: crm-42

is_blockedboolean

True when the customer is currently blocked.

example:

blocked_atstring | null · date-time

When the customer was blocked, or null when not blocked.

planobject | null

The plan the customer is on, or null when none is assigned.

idstring · uuid

Plan identifier.

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

namestring

Plan name.

example: Business

pbxes_countinteger

Number of PBXes linked to this customer.

example: 2

created_atstring · date-time

When the customer was created.

example: 2025-03-10T10:15:00+00:00

updated_atstring · date-time

When the customer was last updated.

example: 2026-09-02T16:45:00+00:00

linksobject

firststring

The first page of the resource

example: http://localhost/api/v1/resources?page=1

laststring

The last page of the resource

example: http://localhost/api/v1/resources?page=1

prevnull | string

The previous page of the resource

nextnull | string

The next page of the resource

metaobject

current_pageinteger

The current page of the resource

≥ 1

example: 1

fromnull | integer

The first item of the resource

≥ 1

example: 1

last_pageinteger

The last page of the resource

≥ 1

example: 1

linksarray<object>

urlstring | null

The url of the resource (null for the boundary prev/next links)

example: http://localhost/api/v1/resources?page=1

labelstring

The label of the resource

example: first

activeboolean

The status of the resource

example: 1

pathstring

The path of the resource

example: http://localhost/api/v1/resources

per_pageinteger

The number of items per page of the resource

≥ 1

example: 15

tonull | integer

The last item of the resource

≥ 1

example: 1

totalinteger

The total number of items of the resource

≥ 0

example: 1

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

Unprocessable Content. A query parameter failed validation (`search` longer than 100 characters, `per_page` outside 1 to 5000, `page` below 1, or a value of the wrong type). Nothing is returned: correct the query string and retry.

Response schema

messagestring

The first validation error.

errorsobject

Validation errors keyed by parameter name.

Free-form object

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/customers

Base URL

Request sample

curl -X GET 'https://cockpit.voxbi.com/api/v1/api/v1/customers' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

{ … }

"data": [ … ],

{ … },

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

"name": "Sales Team Inc",

"is_company": true,

"email": "user@example.com",

"phone_number": "+12125550101",

"address": { … },

"street": "Main Street",

"number": "12",

"postal_code": "10001",

"city": "New York",

"country_code": "US"

"external_id": "crm-41",

"is_blocked": false,

"blocked_at": null,

"plan": { … },

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

"name": "Business"

"pbxes_count": 2,

"created_at": "2025-03-10T10:15:00+00:00",

"updated_at": "2026-09-02T16:45:00+00:00"

{ … }

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

"name": "Support Partners LLC",

"is_company": true,

"email": "jane.smith@example.com",

"phone_number": "+12125550102",

"address": { … },

"street": "Main Street",

"number": "12",

"postal_code": "10001",

"city": "New York",

"country_code": "US"

"external_id": null,

"is_blocked": false,

"blocked_at": null,

"plan": null,

"pbxes_count": 1,

"created_at": "2025-03-10T10:15:00+00:00",

"updated_at": "2026-09-02T16:45:00+00:00"

}

"links": { … },

"first": "https://partner.voxbi.com/api/v1/customers?page=1",

"last": "https://partner.voxbi.com/api/v1/customers?page=1",

"prev": null,

"next": null

"meta": { … }

"current_page": 1,

"from": 1,

"last_page": 1,

"links": [ … ],

{ … },

"url": null,

"label": "« Previous",

"active": false

{ … },

"url": "https://partner.voxbi.com/api/v1/customers?page=1",

"label": "1",

"active": true

{ … }

"url": null,

"label": "Next »",

"active": false

}

"path": "https://partner.voxbi.com/api/v1/customers",

"per_page": 100,

"to": 2,

"total": 2

}

{ … }

"message": "Unauthenticated."

}

Content-Type string

example: application/json

{ … }

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

}

Content-Type string

example: application/json

{ … }

"message": "The per page field must not be greater than 5000.",

"errors": { … }

"per_page": [ … ]

"The per page field must not be greater than 5000."

]

}

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

List the partner's customers (partner-api)

Responses