API v3

GET /sub_accounts

Sub-accounts, each with its counts of SIMs, numbers and active members, and whether it has a voice trunk.

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

Fields

NameInType
limitqueryinteger
cursorquerystringnext_cursor from the previous page.

* required

Example

curl -X GET "https://api.voicepro.plus/v3/sub_accounts" \
  -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
  "object": "list",
  "data": [
    {
      "object": "sub_account",
      "id": "acct_EF34GH",
      "name": "Acme Logistics North",
      "status": "active",
      "sim_count": 4,
      "number_count": 1,
      "voice_trunk": false,
      "member_count": 5
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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