Skip to main content
GET
/
api
/
v1
/
auth
/
me
Retrieve account
curl --request GET \
  --url https://api.vobiz.ai/api/v1/auth/me \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>'
{
  "type": "account",
  "id": "500000",
  "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "name": "Acme Corp",
  "email": "admin@example.com",
  "phone": "+919876543210",
  "description": null,
  "auth_id": "MA_XXXXXXXX",
  "auth_secret": "<redacted>",
  "auth_token_expire_time": null,
  "country": "IN",
  "timezone": "Asia/Kolkata",
  "city": "Bengaluru",
  "state": "KA",
  "address": "123 Example Street, Bengaluru",
  "zip_code": "560001",
  "company": "Acme Corp",
  "account_type": "standard",
  "postpaid": false,
  "auto_recharge": true,
  "auto_recharge_config": null,
  "enabled": true,
  "carrier_type": null,
  "customer_type": null,
  "credit_limit": 0,
  "cps_limit": 11,
  "concurrent_calls_limit": 10,
  "base_cps_limit": 1,
  "base_concurrent_calls_limit": 10,
  "purchased_cps": 10,
  "purchased_concurrent_calls": 0,
  "risk_rating": 0,
  "risk_status": null,
  "features": {
    "call_queue": true
  },
  "ip_auth_enabled": false,
  "ip_whitelist_rules": {},
  "allow_aws_ips": false,
  "role": "admin",
  "is_active": true,
  "is_verified": false,
  "is_trial_account": false,
  "created_at": "2025-09-30T08:33:24.700542+00:00",
  "updated_at": "2026-05-12T05:41:41.892287+00:00",
  "last_login": "2026-05-12T05:41:42.601005+00:00",
  "pricing_tier_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "pricing_tier": {
    "id": "11223344-5566-7788-99aa-bbccddeeff00",
    "name": "Standard",
    "description": null,
    "currency": "INR",
    "rate_per_minute": 0.45,
    "billing_increment_seconds": 60,
    "minimum_duration_seconds": 0,
    "is_active": true,
    "is_default": false
  }
}
GET https://api.vobiz.ai/api/v1/auth/me
Returns complete account details including pricing tier information and authentication credentials.
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/auth/me \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

​
Response Example

Success Response (200 OK)
{
  "type": "account",
  "id": "500000",
  "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
  "name": "Acme Corp",
  "email": "admin@example.com",
  "phone": "+919876543210",
  "description": null,
  "auth_id": "MA_XXXXXXXX",
  "auth_secret": "<redacted>",
  "auth_token_expire_time": null,
  "country": "IN",
  "timezone": "Asia/Kolkata",
  "city": "Bengaluru",
  "state": "KA",
  "address": "123 Example Street, Bengaluru",
  "zip_code": "560001",
  "company": "Acme Corp",
  "account_type": "standard",
  "postpaid": false,
  "auto_recharge": true,
  "auto_recharge_config": null,
  "enabled": true,
  "carrier_type": null,
  "customer_type": null,
  "credit_limit": 0.0,
  "cps_limit": 11,
  "concurrent_calls_limit": 10,
  "base_cps_limit": 1,
  "base_concurrent_calls_limit": 10,
  "purchased_cps": 10,
  "purchased_concurrent_calls": 0,
  "risk_rating": 0,
  "risk_status": null,
  "features": {
    "call_queue": true
  },
  "ip_auth_enabled": false,
  "ip_whitelist_rules": {},
  "allow_aws_ips": false,
  "role": "admin",
  "is_active": true,
  "is_verified": false,
  "is_trial_account": false,
  "created_at": "2025-09-30T08:33:24.700542+00:00",
  "updated_at": "2026-05-12T05:41:41.892287+00:00",
  "last_login": "2026-05-12T05:41:42.601005+00:00",
  "pricing_tier_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "pricing_tier": {
    "id": "11223344-5566-7788-99aa-bbccddeeff00",
    "name": "Standard",
    "description": null,
    "currency": "INR",
    "rate_per_minute": 0.45,
    "billing_increment_seconds": 60,
    "minimum_duration_seconds": 0,
    "is_active": true,
    "is_default": false
  }
}
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
{
  "error": "unauthorized",
  "message": "invalid credentials"
}

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