Account Brief
account.get returns the B2B account rollup an external agent needs before a
QBR, deal review, exec brief, or stalled-opportunity follow-up.
| Field | Value |
|---|
| Capability | account.get |
| Grant | capability:account.get |
| Legacy scope | v1:account:read |
| Modes | dry_run, execute |
| Cost | 1 action credit when executed |
| Side effect | none |
| MCP tool | get_account_brief |
01Request
POST /api/v1/capabilities/account.get/invoke
Authorization: Bearer wp_live_...
Content-Type: application/json
{
"mode": "execute",
"source": "api",
"input": {
"id": "acct_4c2d"
}
}
Input accepts:
| Field | Type | Notes |
|---|
id | string, required | Account or company id. |
accountId | string | Alias for id. |
account | string | Alias for id. |
02Examples
CLI
wp account get acct_4c2d
wp invoke account.get --mode execute --input '{"id":"acct_4c2d"}'
curl
curl https://api.waypath.app/api/v1/capabilities/account.get/invoke \
-H "Authorization: Bearer wp_live_..." \
-H "Content-Type: application/json" \
-d '{
"mode": "execute",
"source": "api",
"input": { "id": "acct_4c2d" }
}'
MCP
const brief = await mcp.tools.get_account_brief({
id: 'acct_4c2d',
_mode: 'execute',
})
03Response
{
"status": "committed",
"result": {
"account_id": "acct_4c2d",
"name": "Acme Corp",
"contacts": [
{
"customer_id": "cus_8af2",
"name": "Jane Doe",
"role": "VP Engineering",
"sentiment": "neutral"
}
],
"opportunities": [
{
"id": "opp_19a",
"stage": "negotiation",
"amount": 84000,
"close_date": "2026-06-15",
"probability": 0.6
}
],
"blockers": ["procurement_review_q2"],
"trajectory": "at_risk"
},
"action_credit_cost": 1,
"request_id": "req_123",
"quota": {
"plan": "starter",
"limit": 500,
"used": 44,
"remaining": 456
},
"receipt_url": "/api/v1/capabilities/actions/req_123"
}
04Errors
| Status | Code | Cause |
|---|
| 400 | invalid_input | Missing account id. |
| 401 | unauthenticated | Missing or invalid key. |
| 403 | grant_denied | Key lacks capability:account.get or compatible legacy scope. |
| 403 | mode_denied | Key cannot use the requested mode. |
| 404 | not_found | Account does not exist. |
| 429 | rate_limited | Per-key request cap. |
05See also