Retrieve a Subaccount

GET

api

accounts

{auth_id}

sub-accounts

{sub_auth_id}

Retrieve a sub-account

curl --request GET \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id} \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "Acme Sub-Account",
  "email": null,
  "phone": null,
  "description": null,
  "permissions": null,
  "rate_limit": 1000,
  "id": "500001",
  "parent_account_id": "510762",
  "parent_auth_id": "MA_XXXXXXXX",
  "auth_id": "SA_XXXXXXXX",
  "auth_token": "<redacted>",
  "api_id": "11223344-1234-5678-90ab-cdef12345678",
  "email_verified": false,
  "enabled": true,
  "created": "2026-03-25",
  "modified": "2026-03-25",
  "is_active": true,
  "created_at": "2026-03-25T10:00:00Z",
  "updated_at": "2026-03-25T10:00:00Z",
  "last_used": null,
  "account": "/v1/Account/MA_XXXXXXXX/",
  "resource_uri": "/v1/Account/MA_XXXXXXXX/Subaccount/SA_XXXXXXXX/"
}

GET https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}

Returns the details of a specific subaccount by its ID.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

Arguments

No arguments required.

Request

cURL

curl -X GET 'https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}' \
--header 'X-Auth-ID: {auth_id}' \
--header 'X-Auth-Token: {auth_token}'

Response Example

Success Response (200 OK)

{
  "name": "Support Team",
  "email": "support@example.com",
  "phone": "+1234567890",
  "description": "Support-facing voice workload",
  "permissions": {
    "calls": true,
    "cdr": true
  },
  "rate_limit": 500,
  "id": "500001",
  "parent_account_id": "510762",
  "parent_auth_id": "MA_XXXXXXXX",
  "auth_id": "SA_XXXXXXXX",
  "auth_token": "<redacted>",
  "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "email_verified": false,
  "enabled": true,
  "is_active": true,
  "created": "2025-10-22T03:57:35.997500Z",
  "modified": "2025-10-22T03:57:35.997500Z",
  "created_at": "2025-10-22T03:57:35.997500Z",
  "updated_at": "2025-10-22T03:57:35.997500Z",
  "account": "/v1/Account/MA_XXXXXXXX/",
  "resource_uri": "/v1/Account/MA_XXXXXXXX/Subaccount/SA_XXXXXXXX/",
  "last_used": null
}

auth_token is masked on retrieve - it is only returned in clear text once, at creation. The numeric id and the auth_id (SA_…) are different identifiers; use auth_id as the sub_auth_id path segment on every other call.

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

sub_auth_id

string

required

Example:

"SA_XXXXXX"

Response

200 - application/json

Sub-account details

name

string

required

unknown

required

phone

unknown

required

description

unknown

required

permissions

unknown

required

rate_limit

integer

required

string

required

parent_account_id

string

required

parent_auth_id

string

required

auth_id

string

required

auth_token

string

required

api_id

string

required

email_verified

boolean

required

enabled

boolean

required

created

string

required

modified

string

required

is_active

boolean

required

created_at

string

required

updated_at

string

required

last_used

unknown

required

account

string

required

resource_uri

string

required

Retrieve a sub-account

curl --request GET \
  --url https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id} \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'

import requests

url = "https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}"

headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};

fetch('https://api.vobiz.ai/api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "Acme Sub-Account",
  "email": null,
  "phone": null,
  "description": null,
  "permissions": null,
  "rate_limit": 1000,
  "id": "500001",
  "parent_account_id": "510762",
  "parent_auth_id": "MA_XXXXXXXX",
  "auth_id": "SA_XXXXXXXX",
  "auth_token": "<redacted>",
  "api_id": "11223344-1234-5678-90ab-cdef12345678",
  "email_verified": false,
  "enabled": true,
  "created": "2026-03-25",
  "modified": "2026-03-25",
  "is_active": true,
  "created_at": "2026-03-25T10:00:00Z",
  "updated_at": "2026-03-25T10:00:00Z",
  "last_used": null,
  "account": "/v1/Account/MA_XXXXXXXX/",
  "resource_uri": "/v1/Account/MA_XXXXXXXX/Subaccount/SA_XXXXXXXX/"
}

​Arguments

​Request

​Response Example

Authorizations

Path Parameters

Response

Arguments

Request

Response Example