Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Subaccount object represents an isolated account under your main Vobiz account, with its own authentication credentials, permissions, and rate-limiting configuration.

​
Attributes

FieldTypeDescription
idstringUnique identifier for the sub-account (e.g., "SA_67401KW8").
namestringName of the sub-account.
descriptionstring | nullDescription of the sub-account purpose or usage.
permissionsobjectPermissions object defining what the sub-account can access. Contains boolean fields like calls and cdr.
rate_limitintegerAPI rate limit for this sub-account (requests per time period).
parent_auth_idstringID of the parent main account (e.g., "{auth_id}").
auth_idstringAuthentication ID used for API requests.
is_activebooleanWhether the sub-account is currently active and can make API calls.
created_atstringISO 8601 timestamp when the sub-account was created.
updated_atstringISO 8601 timestamp when the sub-account was last updated.
last_usedstring | nullISO 8601 timestamp when the sub-account was last used for API calls. Null if never used.

​
Example Subaccount Object

{
  "name": "Support Team",
  "description": "Support-facing voice workload",
  "permissions": {
    "calls": true,
    "cdr": true
  },
  "rate_limit": 500,
  "id": "SA_67401KW8",
  "parent_auth_id": "{auth_id}",
  "auth_id": "inG9oUky5uFjdUECaQNzeyVYD6ommaJd",
  "is_active": true,
  "created_at": "2025-10-22T03:57:35.997500Z",
  "updated_at": "2025-10-22T03:57:35.997500Z",
  "last_used": null
}
Permissions Object: The permissions object controls what resources the sub-account can access:
  • calls - Whether the sub-account can make/receive calls
  • cdr - Whether the sub-account can access Call Detail Records
Rate Limiting: The rate_limit field controls API request throttling for this sub-account. Set this based on expected usage patterns to prevent abuse.