Docs/API reference/Customer

Read the customer summary

Read the customer summary and confirmed active-service totals.

GET/v1/customer

Required permission: customer.readRead only

Start with Sandbox

Every example on this page uses https://sandbox.voycedconnect.eu/v1. After Voyced enables Live access, change the base URL to https://api.voycedconnect.eu/v1, use the separate Live API key and secret, request a new Live bearer token, then run GET /v1/test and GET /v1/capabilities again. Sandbox credentials and tokens never work in Live. See the complete go-live steps.

Example request

cURL

curl --request GET \
  --url 'https://sandbox.voycedconnect.eu/v1/customer' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_BEARER_TOKEN'

PHP

<?php
$token = (string) getenv('VOYCED_BEARER_TOKEN');
if ($token === '') {
    throw new RuntimeException('Set VOYCED_BEARER_TOKEN.');
}

$curl = curl_init('https://sandbox.voycedconnect.eu/v1/customer');
curl_setopt_array($curl, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 20,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'Authorization: Bearer ' . $token,
    ],
]);

$response = curl_exec($curl);
$status = (int) curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
if ($response === false) {
    $error = curl_error($curl);
    curl_close($curl);
    throw new RuntimeException($error);
}
curl_close($curl);

if ($status < 200 || $status >= 300) {
    throw new RuntimeException('Voyced API HTTP ' . $status . ': ' . $response);
}
echo $response . PHP_EOL;

Node.js

const token = process.env.VOYCED_BEARER_TOKEN;
if (!token) throw new Error('Set VOYCED_BEARER_TOKEN.');

const response = await fetch('https://sandbox.voycedconnect.eu/v1/customer', {
  headers: {
    Accept: 'application/json',
    Authorization: `Bearer ${token}`,
  },
  redirect: 'error',
  signal: AbortSignal.timeout(20_000),
});
const result = await response.json();
if (!response.ok) {
  throw new Error(result.error?.message || `Voyced API HTTP ${response.status}`);
}
console.log(result);

Python

import os
import requests

token = os.environ["VOYCED_BEARER_TOKEN"]
response = requests.get(
    "https://sandbox.voycedconnect.eu/v1/customer",
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {token}",
    },
    timeout=20,
    allow_redirects=False,
)
response.raise_for_status()
print(response.json())

Example response

200 JSON

{
  "success": true,
  "environment": "sandbox",
  "request_id": "req_example1234567890",
  "data": {
    "customer_name": "ExampleCustomer",
    "company_name": "Example Company Ltd",
    "billing_postcode": "AB1 2CD",
    "status": "active",
    "active_accounts": 1,
    "active_telephone_numbers": 1
  }
}

Response fields

Field	Description
`customer_name`	The recognisable Voyced customer name.
`company_name`	The company or organisation name when available.
`billing_postcode`	The billing postcode when available.
`status`	The current customer status.
`active_accounts`	Number of confirmed active accounts.
`active_telephone_numbers`	Number of unique active telephone numbers.

Get a token
Request a temporary Sandbox bearer token.

Prepare the request
Select the endpoint and add a number when required.

Run and check
Review the HTTP status, response time and JSON.

Use a bearer token onlyThe page sends the token through the protected documentation proxy to Voyced Sandbox for this request. It is not saved. Reset or leave the page to clear the field.

The documentation proxy accepts approved Sandbox GET requests only. It cannot call Live. It does not place credentials in cookies, browser storage or URLs.

Common errors

HTTP	Code	Meaning
401	`invalid_token`	The token is invalid or expired.
403	`scope_denied`	The key does not have the required permission.
403	`customer_context_missing`	The key is not linked to a customer.
502	`request_failed`	Voyced could not complete the request.

All protected endpoints may also return missing_token, invalid_token, inactive_api_key or rate_limited. See the full error reference.