API v3

GET /account

The workspace this key belongs to, the services on it and the key's own scopes.

Addresshttps://api.voicepro.plus/v3/account
Key permissionread

Example

curl -X GET "https://api.voicepro.plus/v3/account" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "account",
  "id": "acct_AB12CD",
  "name": "Acme Logistics",
  "legal_name": "Acme Logistics Ltd",
  "status": "active",
  "country": "GB",
  "timezone": "Europe/London",
  "currency": "GBP",
  "parent_account_id": null,
  "created_at": "2026-10-01T09:00:00Z",
  "services": {
    "mobile_sims": {
      "enabled": true,
      "count": 12,
      "active_count": 11
    },
    "numbers": {
      "enabled": true,
      "count": 3
    },
    "voice_trunk": {
      "enabled": true
    },
    "sms_route": {
      "enabled": false
    },
    "iot": {
      "enabled": true
    }
  },
  "spending_limit": {
    "limit": {
      "amount": 250000,
      "currency": "GBP"
    },
    "alert_percentages": [
      80,
      100
    ]
  },
  "sso": {
    "domain": "example.com",
    "providers": [
      "microsoft"
    ],
    "required": false
  },
  "open_invoice_count": 1,
  "authenticated_as": {
    "type": "api_key",
    "key_id": "key_1A2B3C4D",
    "mode": "live",
    "scopes": [
      "read",
      "billing:read"
    ]
  }
}

Errors

Every error has the same shape: { "error": { "type", "code", "message", "param", "request_id" } }.

missing_api_key401: No Authorization header, or not a Bearer key.
invalid_api_key401: The key is not recognised.
api_key_revoked401: The key was revoked in the portal.
api_key_expired401: The key passed the expiry date set on it.
missing_scope403: The key lacks the scope this endpoint needs; param names the scope.
ip_not_allowed403: The key has an IP allowlist and this request came from elsewhere.
account_not_active403: The workspace is suspended or closed.
rate_limited429: Too many requests for this key or for the whole account (the message says which); wait Retry-After seconds.
internal_error500: Our fault. Quote the request_id to support.

More in Account