Account
Retrieve Account Details
Fetch complete Vobiz account details - auth credentials, pricing tier, verification status, and contact info - with a single authenticated GET request.
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>'import requests
url = "https://api.vobiz.ai/api/v1/auth/me"
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/auth/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
Overview
Call this endpoint with your own credentials to read back the account they belong to. Common uses:- Check credentials. A
200response confirms theX-Auth-ID/X-Auth-Tokenpair is valid; a401means it is not. - Read your limits.
cps_limitandconcurrent_calls_limitare the call rate and capacity limits currently applied to the account. - Read your billing setup.
pricing_tierholds the per-minute rate, currency, and billing increment. - Read account status.
enabled,is_active,is_verified, andis_trial_accountdescribe the account’s state.
Authentication required:
X-Auth-ID- Your account Auth IDX-Auth-Token- Your account Auth TokenContent-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
The response is a single account object. The main groups of fields are:| Group | Fields |
|---|---|
| Identity | id, api_id, auth_id, name, email, phone, company |
| Location | country, timezone, city, state, address, zip_code |
| Billing | account_type, postpaid, auto_recharge, credit_limit, pricing_tier_id, pricing_tier |
| Limits | cps_limit, concurrent_calls_limit, base_cps_limit, base_concurrent_calls_limit, purchased_cps, purchased_concurrent_calls |
| Status | enabled, is_active, is_verified, is_trial_account, role |
| Timestamps | created_at, updated_at, last_login |
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
}
}
Account fields
Every field in the response above, in the order it is returned. Descriptions come from The Account Object.| Field | Type | Example | Description |
|---|---|---|---|
type | string | "account" | Object type discriminator. Always "account". |
id | string | "500000" | Internal numeric account identifier (e.g., "500000"). The credential you authenticate with is auth_id (e.g., "MA_XXXXXX"), not id. |
api_id | string | "aabbccdd-1234-5678-90ab-cdef12345678" | Internal API reference identifier (UUID). |
name | string | "Acme Corp" | Name of the account or company. |
email | string | "admin@example.com" | Email address associated with the account. |
phone | string | "+919876543210" | Primary phone number for the account. |
description | string | null | null | Optional description or notes for the account. |
auth_id | string | "MA_XXXXXXXX" | Authentication ID used for API requests. |
auth_secret | string | "<redacted>" | Secret key for authentication (only shown in secure contexts). |
auth_token_expire_time | string | null | ISO 8601 timestamp when the current auth token expires. |
country | string | null | "IN" | Country code or name for the account location. |
timezone | string | "Asia/Kolkata" | Local timezone of the account (e.g., "America/Los_Angeles"). |
city | string | "Bengaluru" | Physical location details for the account. |
state | string | "KA" | Physical location details for the account. |
address | string | "123 Example Street, Bengaluru" | Physical location details for the account. |
zip_code | string | "560001" | Physical location details for the account. |
company | string | "Acme Corp" | Full legal name of the company. |
account_type | string | "standard" | Plan/category label for the account (e.g., "standard"). |
postpaid | boolean | false | true for postpaid billing, false for prepaid. This is the authoritative billing-model flag. |
auto_recharge | boolean | true | Whether auto-recharge is enabled for prepaid accounts. |
auto_recharge_config | object | null | null | Auto-recharge configuration (trigger threshold, top-up amount). null when unset. |
enabled | boolean | true | Whether the account is generally enabled for service. |
carrier_type | string | null | null | Type of carrier service. May be null. |
customer_type | string | null | null | Type of customer. May be null. |
credit_limit | number | 0.0 | Maximum credit allowed for postpaid accounts. 0 for prepaid accounts with no credit line. |
cps_limit | integer | 11 | Effective calls-per-second limit (base_cps_limit + purchased_cps). |
concurrent_calls_limit | integer | 10 | Effective concurrent calls limit (base_concurrent_calls_limit + purchased_concurrent_calls). |
base_cps_limit | integer | 1 | Base calls per second limit before any purchased add-ons. |
base_concurrent_calls_limit | integer | 10 | Base concurrent calls limit before any purchased add-ons. |
purchased_cps | integer | 10 | Additional CPS purchased by the account. |
purchased_concurrent_calls | integer | 0 | Additional concurrent calls purchased by the account. |
risk_rating | integer | 0 | Numeric risk assessment score for the account. |
risk_status | string | null | null | Current risk status. May be null. |
features | object | object | Map of enabled features. Includes call_queue (boolean). |
ip_auth_enabled | boolean | false | Whether IP authentication is enabled for API access. |
ip_whitelist_rules | object | {} | Map of IP whitelist rules allowed for API access. Empty ({}) when unset. |
allow_aws_ips | boolean | false | Whether to allow AWS IP ranges for API access. |
role | string | "admin" | Role of the user associated with the account (e.g., "ADMIN", "USER"). |
is_active | boolean | true | Whether the account is currently active. |
is_verified | boolean | false | Whether the account identity has been verified. |
is_trial_account | boolean | false | Indicates if the account is a trial account. |
created_at | string | "2025-09-30T08:33:24.700542+00:00" | ISO 8601 timestamp when the account was created. |
updated_at | string | "2026-05-12T05:41:41.892287+00:00" | ISO 8601 timestamp when the account was last updated. |
last_login | string | "2026-05-12T05:41:42.601005+00:00" | ISO 8601 timestamp of the most recent login. |
pricing_tier_id | string | "11223344-5566-7788-99aa-bbccddeeff00" | Unique identifier of the pricing tier assigned to this account. |
pricing_tier | object | object | Complete pricing tier object with billing rates and descriptions. |
Pricing tier fields
The nestedpricing_tier object sets how calls on this account are billed.
| Field | Type | Example | Description |
|---|---|---|---|
pricing_tier.id | string | "11223344-5566-7788-99aa-bbccddeeff00" | Unique identifier of the pricing tier. Same value as pricing_tier_id. |
pricing_tier.name | string | "Standard" | Name of the pricing tier. |
pricing_tier.description | string | null | null | A brief description of the pricing plan. |
pricing_tier.currency | string | "INR" | Currency code (USD, INR, EUR, etc.). |
pricing_tier.rate_per_minute | number | 0.45 | Cost per minute of call time in the specified currency. |
pricing_tier.billing_increment_seconds | integer | 60 | Granularity of billing (e.g., 60 = billed by full minutes). |
pricing_tier.minimum_duration_seconds | integer | 0 | Minimum billable duration for calls. |
pricing_tier.is_active | boolean | true | Whether the pricing tier is active. |
pricing_tier.is_default | boolean | false | Whether this is the default pricing tier. |
Errors
| Status | Meaning | What to do |
|---|---|---|
200 OK | The credentials are valid. The body is your account object. | Read the fields above. |
401 Unauthorized | The X-Auth-ID / X-Auth-Token pair is missing or invalid. | Check both headers against the credentials in your console. |
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
Response
Account details
Was this page helpful?
⌘I
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>'import requests
url = "https://api.vobiz.ai/api/v1/auth/me"
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/auth/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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
}
}