Endpoints
Partner Profile
Retrieve your Vobiz partner identity, billing configuration, GST status, and current balance - the authoritative source for your permanent partner ID used in queries.
GET
/
api
/
v1
/
partner
/
me
Get partner profile
curl --request GET \
--url https://api.vobiz.ai/api/v1/partner/me \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/partner/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/partner/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"auth_id": "PA_ABC123",
"name": "Acme Reseller",
"email": "partner@acme.com",
"balance": 50000,
"currency": "INR",
"country": "IN",
"created_at": "2025-01-15T10:00:00Z"
}← Partner API Reference
Retrieve your partner identity, billing configuration, GST status, and current balance. The profile endpoint is the authoritative source for your permanent partner
id - required as a filter parameter in Transaction and CDR queries.
All Partner API requests use
X-Auth-ID and X-Auth-Token headers. See Authentication for details.Get Partner Profile
Retrieve your full partner profile, including identity, balance, GST configuration, and permanent partner ID. No request body or query parameters are required.curl -X GET \
"https://api.vobiz.ai/api/v1/partner/me" \
-H "X-Auth-ID: {your_partner_id}" \
-H "X-Auth-Token: {your_auth_token}" \
-H "Accept: application/json"
import requests
response = requests.get(
"https://api.vobiz.ai/api/v1/partner/me",
headers={
"X-Auth-ID": "{your_partner_id}",
"X-Auth-Token": "{your_auth_token}",
"Accept": "application/json",
}
)
profile = response.json()
partner_id = profile["id"] # Store this - needed for CDR/transaction queries
print(f"Partner: {profile['name']}, Balance: {profile['balance']} {profile['currency']}")
Response
{
"id": "aabbccdd-1234-5678-90ab-cdef12345678",
"account_id": 500000,
"name": "John Doe",
"slug": "acme-partner",
"company": "Acme Corp",
"auth_id": "PA_XXXXXXXX",
"email": "admin@example.com",
"phone": "+919876543210",
"billing_model": "direct",
"is_active": true,
"is_verified": false,
"max_accounts": 1000,
"can_create_accounts": true,
"can_create_pricing_tiers": true,
"can_view_cdrs": true,
"can_transfer_balance": true,
"default_pricing_tier_id": "11223344-1234-5678-90ab-cdef12345678",
"account_count": 23,
"balance": "23906.83000",
"created_at": "2026-01-19T18:39:14.529435Z",
"updated_at": "2026-05-11T13:31:06.283235Z"
}
Key fields
| Field | Notes |
|---|---|
id | Your permanent partner UUID. Some legacy filters expect this rather than auth_id. |
auth_id | Your partner credential identifier (e.g. PA_…), used in the X-Auth-ID header. |
balance | Your master wallet balance as a string with 5 decimal places (e.g. "23906.83000"). Parse it to a number before comparing - and note that GET /dashboard returns partner balance as null (use total_balance there instead). |
currency | Your partner currency. Every balance transfer’s currency must match this. |
max_accounts | Hard cap on how many customers you can create. account_count is your current usage. |
can_create_accounts | If false, POST /accounts returns 403. |
can_transfer_balance | If false, transfer-balance returns 403. |
can_view_cdrs | If false, the CDR endpoints are blocked. |
is_verified | Whether your own partner KYC is complete. |
balance is a string, not a number. Comparing "200.00000" >= 500 lexicographically will give wrong results. Cast it (float(profile["balance"])) before any arithmetic or balance check.When to Use
- Initial integration setup - Call this once when your integration starts. Capture the permanent
idfield and store it - it is required as a filter parameter in Transaction and CDR endpoints. - Balance checks before transfers - Check your current balance before calling the Transfer Balance endpoint to confirm sufficient funds.
- Sync billing metadata - Sync GSTIN, TDS status, and account status to your internal billing system to ensure correct invoice generation.
Authorizations
Your Vobiz account Auth ID
Your Vobiz account Auth Token
Response
200 - application/json
Partner profile
Was this page helpful?
⌘I
Get partner profile
curl --request GET \
--url https://api.vobiz.ai/api/v1/partner/me \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/partner/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/partner/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"auth_id": "PA_ABC123",
"name": "Acme Reseller",
"email": "partner@acme.com",
"balance": 50000,
"currency": "INR",
"country": "IN",
"created_at": "2025-01-15T10:00:00Z"
}