SITEMAP / DOCS / AGENTS

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.

FieldValue
Capabilityaccount.get
Grantcapability:account.get
Legacy scopev1:account:read
Modesdry_run, execute
Cost1 action credit when executed
Side effectnone
MCP toolget_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:

FieldTypeNotes
idstring, requiredAccount or company id.
accountIdstringAlias for id.
accountstringAlias 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

StatusCodeCause
400invalid_inputMissing account id.
401unauthenticatedMissing or invalid key.
403grant_deniedKey lacks capability:account.get or compatible legacy scope.
403mode_deniedKey cannot use the requested mode.
404not_foundAccount does not exist.
429rate_limitedPer-key request cap.

05See also