Get your account overview
One call for everything that describes the calling account: profile details, the active plan and subscription, the default WhatsApp number (including its last-synced Meta business profile), and the wallet balance.
Useful as a startup call — it saves fanning out to the plan, WABA, and wallet endpoints separately.
wallet.balance is in major currency units (rupees, not paise) — unlike the agent wallet endpoint, which reports the raw fixed-point integer. active_plan, active_subscription, and default_waba are omitted when the account has none.
Authorization
ApiKeyAuth API key from your dashboard (Settings > API Keys)
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://loading/api/v1/users/me/overview"{
"success": true,
"data": {
"user_details": {
"id": "usr_abc123",
"name": "Acme Retail",
"email": "ops@acme.example",
"contact": "string",
"role": "USER",
"status": "ACTIVE",
"timezone": "Asia/Kolkata",
"parent_id": "string",
"avatar_url": "string",
"ticket_prefix": "string",
"is_super_user": true,
"created_at": "string",
"updated_at": "string",
"active_plan": {
"id": "string",
"name": "Growth",
"type": "string",
"duration_months": 12,
"price": 0
},
"active_subscription": {
"id": "string",
"plan_id": "string",
"status": "ACTIVE",
"starts_at": "string",
"ends_at": "string",
"price_at_purchase": 0,
"auto_renew": true
},
"default_waba": {
"id": "string",
"display_name": "string",
"verified_name": "string",
"number": "string",
"display_number": "string",
"status": "string",
"is_onboarded": true,
"code_verification_status": "string",
"messaging_limit_tier": "string",
"provider": "string",
"business_profile": {},
"business_profile_data": {}
}
},
"wallet": {
"balance": 12500.75,
"currency": "INR"
}
}
}{
"success": false,
"message": "user not authenticated"
}{
"success": false,
"message": "user not found"
}{
"success": false,
"message": "internal server error"
}Unassign specific agents from a customer PATCH
Removes the listed agents from a customer's assignments. Agents not currently assigned are silently ignored — the response reports only the agents actually removed.
Get an agent's wallet balance GET
Returns the spending allotment, spend-to-date, and remaining balance for one of your agents. This is **not** the account wallet. Agents do not hold their own wallet — they spend against the account balance up to a per-agent cap, and this endpoint reports that cap and what is left of it. For the account balance itself, use the account overview endpoint. Amounts are the raw fixed-point integer used throughout the billing API: divide by 10,000 for the major-currency value (e.g. `5000000000` is ₹500,000.00). `allotment` and `remaining` are `null` when the agent is **uncapped** — they spend against the account balance with no per-agent ceiling. `spend_since` marks the start of the current spend window; `spent` counts only ledger activity after it, so resetting the window resets `spent` without touching the cap. An agent-scoped API key may only read its own agent; any other agent id returns `403`.