Skip to main content
GET
Retrieve account
Returns complete account details including pricing tier information and authentication credentials.

Overview

Call this endpoint with your own credentials to read back the account they belong to. Common uses:
  • Check credentials. A 200 response confirms the X-Auth-ID / X-Auth-Token pair is valid; a 401 means it is not.
  • Read your limits. cps_limit and concurrent_calls_limit are the call rate and capacity limits currently applied to the account.
  • Read your billing setup. pricing_tier holds the per-minute rate, currency, and billing increment.
  • Read account status. enabled, is_active, is_verified, and is_trial_account describe the account’s state.
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

Response

The response is a single account object. The main groups of fields are: See The Account Object for a description of every field.

Response example

Success Response (200 OK)

Account fields

Every field in the response above, in the order it is returned. Descriptions come from The Account Object.

Pricing tier fields

The nested pricing_tier object sets how calls on this account are billed.

Errors

Pricing Tier: Each account is associated with a pricing tier that determines the per-minute call rate and billing increments. The pricing_tier object provides complete details about your account’s billing configuration.
This endpoint is also a convenient credential check. It returns your own identity, so the auth_id in the response should match the X-Auth-ID you sent. See The Account Object for every field.
Error Response (401 Unauthorized): the X-Auth-ID / X-Auth-Token pair is missing or invalid.
Error Response - 401 Unauthorized

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Response

Account details

type
string
required
id
string
required
api_id
string
required
name
string
required
email
string
required
phone
string
required
description
string
required
auth_id
string
required
auth_secret
string
required
auth_token_expire_time
unknown
required
country
string
required
timezone
string
required
city
string
required
state
string
required
address
string
required
zip_code
string
required
company
string
required
account_type
string
required
postpaid
boolean
required
auto_recharge
boolean
required
auto_recharge_config
unknown
required
enabled
boolean
required
carrier_type
unknown
required
customer_type
unknown
required
credit_limit
integer
required
cps_limit
integer
required
concurrent_calls_limit
integer
required
base_cps_limit
integer
required
base_concurrent_calls_limit
integer
required
purchased_cps
integer
required
purchased_concurrent_calls
integer
required
risk_rating
integer
required
risk_status
unknown
required
features
object
required
ip_auth_enabled
boolean
required
ip_whitelist_rules
object
required
allow_aws_ips
boolean
required
role
string
required
is_active
boolean
required
is_verified
boolean
required
is_trial_account
boolean
required
created_at
string
required
updated_at
string
required
last_login
string
required
pricing_tier_id
string
required
pricing_tier
object
required