Account Brief
The B2B roll-up. Returns an account’s contacts, opportunities,
blockers, and trajectory in a single call. P50 latency 180ms. Backed
by MCP tool get_account_brief.
Use this when your agent needs the full account picture, not just one contact. Examples: a CSM agent preparing for a QBR, a deal-desk agent summarizing a stalled opportunity, an exec-briefing agent that generates a one-pager.
Request
GET /v1/account/{id}
| Param | Type | Notes |
|---|---|---|
id | path | Account ID. |
Required scope: account:read.
Examples
curl
curl https://api.waypath.app/v1/account/acct_4c2d \
-H "X-API-Key: wp_live_..."node-fetch
const res = await fetch(
'https://api.waypath.app/v1/account/acct_4c2d',
{ headers: { 'X-API-Key': process.env.WAYPATH_API_KEY! } }
)
const brief = await res.json()python
import os, requests
brief = requests.get(
'https://api.waypath.app/v1/account/acct_4c2d',
headers={'X-API-Key': os.environ['WAYPATH_API_KEY']},
timeout=5,
).json()MCP
const brief = await mcp.tools.get_account_brief({ id: 'acct_4c2d' })Response
{
"account_id": "acct_4c2d",
"name": "Acme Corp",
"contacts": [
{
"customer_id": "cus_8af2",
"name": "Jane Doe",
"role": "VP Engineering",
"sentiment": "neutral"
},
{
"customer_id": "cus_8af3",
"name": "Mark Stearns",
"role": "CFO",
"sentiment": "positive"
}
],
"opportunities": [
{
"id": "opp_19a",
"stage": "negotiation",
"amount": 84000,
"close_date": "2026-06-15",
"probability": 0.6
}
],
"blockers": [
"procurement_review_q2",
"legal_redlines_outstanding"
],
"trajectory": "at_risk"
}Field reference
| Field | Type | Notes |
|---|---|---|
account_id | string | Internal Waypath ID. |
name | string | Display name. |
contacts | array | All contacts at the account. Sentiment is rolled up from their individual trajectory. |
opportunities | array | Open opportunities with stage, amount, close date, probability. |
blockers | string[] | Blockers that apply to the whole account, deduped across contacts. |
trajectory | string | Account-level trajectory. One of expanding, steady, at_risk, churning. |
Errors
| Status | Code | Cause |
|---|---|---|
| 401 | unauthenticated | Missing or invalid X-API-Key. |
| 403 | forbidden_scope | Key lacks account:read. |
| 404 | not_found | Account does not exist. |
| 429 | rate_limited | Per-key rate cap. |